eslint-config-humanmade

eslint-config-humanmade

Human Made coding standards for JavaScript.

Installation

This package is an ESLint shareable configuration, and requires babel-eslint, eslint, eslint-config-react-app, eslint-plugin-flowtype, eslint-plugin-import, eslint-plugin-jsx-a11y, eslint-plugin-react.

To install this config and the peerDependencies when using npm 5+:

npx install-peerdeps --dev eslint-config-humanmade@latest

(Thanks to Airbnb's package for the command.)

You can then use it directly on the command line:

eslint -c humanmade MyFile.js

Alternatively, you can create your own configuration and extend these rules:

extends:
- humanmade

Working with TypeScript

If you desire to use TypeScript for your project, you will need to add another dependency:

npm install --save-dev @typescript-eslint/parser

Once it's installed, update your configuration with the parser parameter:

parser: "@typescript-eslint/parser"
extends:
    - humanmade

Global Installation

When installing globally, you need to ensure the peer dependencies are also installed globally.

Run the same command as above, but instead with --global:

npx install-peerdeps --global eslint-config-humanmade@latest

This allows you to use eslint -c humanmade MyFile.js anywhere on your filesystem.

Changelog

1.0.0 (July 31, 2020)

Added:

• Added WordPress-Docs by default in PHPCS #177
• Added ESLint rule for requiring docblocks #209
• Added ESLint rule for JSX boolean values #183
• Added ESLint rule for sorting JSX props #195
• Added ESLInt Rules of Hooks ruleset #197
• Allow $namespace.php in function files #99
• Added Lerna for publishing packages #175

Updated:

• Adjust Stylelint class and ID selector patterns #199
• Updated WPCS to 2.2.1 #151
• Updated VIPCS to 2.0.0 #151
• Updated DealerDirect to 0.6 #151
• Fixed FunctionCallSignature inconsistency in phpcbf #200
• Allow for multiple variable assignments #201
• Allow for theme filenames when sniffing filename #202
• Updated .editorconfig for YAML & Markdown files #175

Changed:

• Formatted package.json files with tabs #175
• Moved ESLint .editorconfig to project root #175
• Renamed root readme.md to README.md #175
• Updated composer.json description #175
• Updated package.json files meta #175

Removed:

• Remove <file>, <basepath> and testVersion from ruleset #187, #198