tdmalone/eslint-config-tdmalone

My personal shareable ESLint config. Heavily influenced by the WordPress style. Includes ESLint recommended rules. For use in either browser or Node. Support for ES2018, Jest, JSDoc and jQuery.

eslint-config-tdmalone

My personal shareable ESLint config.

Heavily influenced by the WordPress style. Includes ESLint recommended rules. For use in either browser or Node. Support for ES2018, Jest, JSDoc and jQuery.

This is a heavily opinionated config, but I'm open to any suggestions. Feel free to file issues or open PRs.

Installation

Install globally to use on any project:

yarn global add eslint-config-tdmalone

Install locally to one project:

yarn add --dev eslint-config-tdmalone

You'll also need to have ESLint installed in the same manner.

Usage

Add this to your .eslintrc.js file:

module.exports = {
  'extends': [ 'tdmalone' ]
};

Then:

• Using globally?
  Run eslint "**/*.js".

• Using locally?
  Add "lint": "eslint \"**/*.js\"" to your package.json's "scripts" section, then run yarn lint

Additional Tips

• Outputting code coverage reports with Jest? Add --ignore-pattern coverage/ to your eslint command.
• Want ESLint to list the filenames it is linting, even if everything passes? Add DEBUG=eslint:cli-engine before your eslint command.

License

MIT.

eslint-config-tdmalone's Issues

Find/add rule to require at least one assertion in any Jest test

In the meantime, expect.hasAssertions(); can be used in each test.

Ensure yoda doesn't apply to gt/lt comparisons

As per https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/#yoda-conditions (via https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/#yoda-conditions), WP coding standards say yoda conditionals are best avoided when doing <, >, <= or >= comparisons.

However eslint's yoda rule appears to apply it regardless, without an obvious option to switch this off.

Add additional jsdoc rules

• Missing jsdoc description
• Require proper sentences (capital letters, full stops etc)

See https://github.com/gajus/eslint-plugin-jsdoc which definitely helps with the latter of these.

Suggest not using 'else'

Require explanation comment when disabling rules

Probably just a search for a comment before or after it.

(ideally same line comments would be possible but that may breaks ESLint even detecting the disable)