eslint-config-google-jsdocless

ESLint shareable config for the Google JavaScript style guide (ES2015+ version)

This is a fork of the original eslint-config-google project by @andrewgjohnson to bring the original project into compliance with ESLint v9 now that require-jsdoc and valid-jsdoc have been deprecated.

Installation

$ npm install --save-dev eslint eslint-config-google-jsdocless

Usage

Once the eslint-config-google-jsdocless package is installed, you can use it by specifying google-jsdocless in the extends section of your ESLint configuration.

{
  "extends": "google-jsdocless",
  "rules": {
    // Additional, per-project rules...
  }
}

Using the google-jsdocless config with eslint:recommended

There are several rules in the eslint:recommended ruleset that Google style is not opinionated about that you might want to enforce in your project.

To use Google style in conjunction with ESLint's recommended rule set, extend them both, making sure to list google-jsdocless last:

{
  "extends": ["eslint:recommended", "google-jsdocless"],
  "rules": {
    // Additional, per-project rules...
  }
}

To see how the google-jsdocless config compares with eslint:recommended, refer to the source code of index.js, which lists every ESLint rule along with whether (and how) it is enforced by the google-jsdocless config.

License

Apache-2 © Google