/graphql-inspector-wolox-node

Primary LanguageJavaScriptMIT LicenseMIT

graphql-inspector-wolox-node

Summary

Simple schema inspector that uses graphql-inspector for comparing schemas looking for differences between them and categorizing them into three possible categories:

  • NON_BREAKING
  • DANGEROUS
  • BREAKING

At last, if no breaking changes are found, it replace the old schema with the new schema.

Installing

Install with npm install graphql-inspector-wolox-node.

Usage

It must be called with one of the following commands:

  • graphql-inspector-wolox-node [OPTION] -o <oldSchemaPath> -n <newSchemaPath>.
  • graphql-inspector-wolox-node [OPTION] --old-schema=<oldSchemaPath> -new-schema=<newSchemaPath>.

Supported extensions:

  • oldSchemaPath:
    • .graphql
  • newSchemaPath:
    • .js file that exports a GraphQLType variable named schema.

Options

  • --ignore-breaking: It will bypass breaking changes.
  • --ignore-old-schema: If oldSchemaPath is not a valid file or it doesn't exists, it will create the new schema file with all the new changes in that path.

Local running

Since the package has graphql as peer dependence, if the package is not installed with npm install graphql-inspector-wolox-node, the next steps are required:

  1. Download the package
  2. In the package folder:
    • npm install
    • npm link
  3. In your project folder:
    • npm link graphql-inspector-wolox-node
    • In /node_modules/graphql-inspector-wolox-node run npm link graphql to install peer dependece.
  4. Call the package with one of the following commands:
  • graphql-inspector-wolox-node [OPTION] -o <oldSchemaPath> -n <newSchemaPath>.
  • graphql-inspector-wolox-node [OPTION] --old-schema=<oldSchemaPath> -new-schema=<newSchemaPath>.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Run the tests (npm test)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

About

This project is maintained by Wolox and it was written by Wolox.

Wolox

License

graphql is available under the MIT license.

Copyright (c) 2020 Wolox

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.