graphql-schema-linter

v3.0.1

Command line tool and package to validate GraphQL schemas against a set of rules. For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

56 / 100

security
Security review needed
popularity
Recognized
maintenance
Inactive
community
Active

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.0.1	\|	05/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.1	\|	09/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.0	\|	07/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.0	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (48,018)

GitHub Stars: 682
Forks: 62
Contributors: 30

Direct Usage Popularity

The npm package graphql-schema-linter receives a total of 48,018 downloads a week. As such, we scored graphql-schema-linter popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package graphql-schema-linter, we found that it has been starred 682 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the graphql-schema-linter repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 50
Open PR: 17
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of graphql-schema-linter based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for graphql-schema-linter is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 5 Direct
Versions: 55
Install Size: 368 kB
Dist-tags: 1
# of Files: 52
Maintainers: 1
TS Typings: No

graphql-schema-linter has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use graphql-schema-linter?

To help you get started, we've collected the most common ways that graphql-schema-linter is being used within popular public projects.

reactioncommerce / reaction / .reaction / graphql-linter / rules / type_fields_sorted_alphabetically.js View on Github

ObjectTypeDefinition: function ObjectTypeDefinition(node) {
      const fieldList = (node.fields || []).map((field) => field.name.value);
      const { isSorted, sortedList } = listIsAlphabetical(fieldList);

      if (!isSorted) {
        context.reportError(
          new _validation_error.ValidationError(
            "type-fields-sorted-alphabetically",
            "The fields of object type `" +
              node.name.value +
              "` must be sorted alphabetically." +
              " Expected sorting: " +
              sortedList.join(", "),
            [node]
          )
        );
      }
    }
  };

View more ways to use graphql-schema-linter

graphql-schema-linter

This package provides a command line tool to validate GraphQL schema definitions against a set of rules.

Screenshot

If you're looking to lint your GraphQL queries, check out this ESLint plugin: apollographql/eslint-plugin-graphql.

Install

graphql-schema-linter depends on graphql as a peer dependency.

In order to use graphql-schema-linter, you can either add it to an existing project that uses the graphql package:

# Using yarn
yarn add graphql-schema-linter

# Using npm
npm install --save graphql-schema-linter

Or, you may install it globally along side graphql:

# Using yarn
yarn global add graphql-schema-linter graphql

# Using npm
npm install -g graphql-schema-linter graphql

Usage

Usage: graphql-schema-linter [options] [schema.graphql ...]


Options:

  -r, --rules 

    only the rules specified will be used to validate the schema

    example: --rules fields-have-descriptions,types-have-descriptions

  -o, --rules-options 

    configure the specified rules with the passed in configuration options

    example: --rules-options '{"enum-values-sorted-alphabetically":{"sortOrder":"lexicographical"}}'

  -i, --ignore 

    ignore errors for specific schema members (see "Inline rule overrides" for an alternative way to do this)

    example: --ignore '{"fields-have-descriptions":["Obvious","Query.obvious","Query.something.obvious"]}'

  -f, --format 

    choose the output format of the report

    possible values: compact, json, text

  -s, --stdin

    schema definition will be read from STDIN instead of specified file

  -c, --config-directory

graphql-schema-linter dependencies

chalk columnify commander cosmiconfig glob

graphql-schema-linter development dependencies

@babel/cli @babel/core @babel/preset-env @babel/register graphql husky lint-staged mocha prettier

FAQs

What is graphql-schema-linter?

Command line tool and package to validate GraphQL schemas against a set of rules. Visit Snyk Advisor to see a full health score report for graphql-schema-linter, including popularity, security, maintenance & community analysis.

Is graphql-schema-linter popular?

The npm package graphql-schema-linter receives a total of 48,018 weekly downloads. As such, graphql-schema-linter popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is graphql-schema-linter well maintained?

We found indications that graphql-schema-linter is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is graphql-schema-linter safe to use?

While scanning the latest version of graphql-schema-linter, we found that a security review is needed. A total of 1 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 15 April-2024, at 21:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (48,018)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use graphql-schema-linter?

graphql-schema-linter

Install

Usage

graphql-schema-linter dependencies

graphql-schema-linter development dependencies

FAQs

What is graphql-schema-linter?

Is graphql-schema-linter popular?

Is graphql-schema-linter well maintained?

Is graphql-schema-linter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues