@thibaudcolas/eslint-plugin-cookbook
Advanced tools
Shareable ESLint config, based on airbnb/javascript, bundled as a plugin
Shareable ESLint config, based on airbnb/javascript, bundled as a plugin.
We want shareable configs to have as low of an overhead as possible. Users shouldn't have to know exactly what plugins are required by the config, install them and manage their versions manually. This plugin contains a shareable config, with plugin dependencies automatically installed.
See https://github.com/eslint/eslint/issues/3458 for further discussion on this topic.
Install ESLint and the config:
npm install --save-dev eslint @thibaudcolas/eslint-plugin-cookbook
Then configure ESLint to use this config. As a .eslintrc.js in the root of your project:
module.exports = {
// https://github.com/thibaudcolas/eslint-plugin-cookbook
extends: "plugin:@thibaudcolas/cookbook/recommended",
};
This recommended config is Prettier-compatible. First, install Prettier:
npm install --save-dev prettier
Then, to configure Prettier itself, create a prettier.config.js file in the root of your project. You can use the following to get started:
// https://github.com/thibaudcolas/eslint-plugin-cookbook
module.exports = require("@thibaudcolas/eslint-plugin-cookbook/prettier.config");
Read on: Upgrading to a stricter ESLint config.
Should further customisation be required, rules coming from external plugins require the @thibaudcolas/cookbook prefix:
module.exports = {
// https://github.com/thibaudcolas/eslint-plugin-cookbook
extends: "plugin:@thibaudcolas/cookbook/recommended",
rules: {
- "react/react-in-jsx-scope": ["warn"],
+ "@thibaudcolas/cookbook/react/react-in-jsx-scope": ["warn"],
- "import/prefer-default-export": ["warn"],
+ "@thibaudcolas/cookbook/import/prefer-default-export": ["warn"],
},
};
--report-unused-disable-directives flag to ensure you do not use more eslint-disable comments than needed.To get the most out of this config, it is assumed that projects have the following tools set up:
1, terms: todo, fixme, xxx, location: start2, devDependencies: test/**, tests/**, spec/**, **/__tests__…2, extensions: .js2, props: false2, forbid: anyairbnberror, components: error, ignoreNonDom: false, ignoreNonDOM: falseerror, elements: img, object, area, inputtype=\image\, img: …error, labelComponents: , labelAttributes: , controlComponen…error, labelAttributes: label, controlComponents: , ignoreEl…error, components: error, elements: marquee, blinkerror, handlers: onClick, onMouseDown, onMouseUp, onKeyPress…error, handlers: onClick, onMouseDown, onMouseUp, onKeyPress…error, ignoreNonDOM: trueerror, audio: , video: , track: error, tr: none, presentationerror, ul: listbox, menu, menubar, radiogroup, tablist, tree…error, tags: , roles: tabpanelerror, components: Link, specialLink: to, aspects: noHref, i…error, allow: __REDUX_DEVTOOLS_EXTENSION_COMPOSE__, allowAft…error, exceptMethods: render, getInitialState, getDefaultPro…error, never, always: error, ignoreCase: trueerror, allowAllCaps: true, ignore: warnerror, alwayserror, ignorePureComponents: trueerror, ignore: , customValidators: , skipUndeclared: falseerror, order: static-variables, static-methods, instance-var…error, enforceDynamicLinks: alwayserror, customValidators: , skipShapeProps: trueerror, forbidDefaultForRequired: truewarn, allowInPropTypes: trueerror, allowRequiredDefaults: falseerror, props: never, children: nevererror, alwayserror, button: true, submit: true, reset: falseerror, syntaxerror, alwayserror, property assignmenterror, html: enforce, custom: enforce, exceptions: error, nevererror, commonjs: true, caseSensitive: trueerror, ignorePackages, js: never, mjs: never, jsx: nevererror, groups: builtin, external, internalerror, commonjs: trueerror, ignoreDestructuring: false, ignoreImport: false, igno…error, always, ignoreConstructors: false, avoidQuotes: trueerror, destructuring: any, ignoreReadBeforeAssign: trueerror, VariableDeclarator: array: false, object: true, Assig…error, isFinite, isNaN, addEventListener, blur, close, close…error, vars: all, args: after-used, ignoreRestSiblings: trueerror, functions: true, classes: true, variables: trueerror, properties: never, ignoreDestructuring: false, ignore…warnerror, always, exceptAfterSingleLine: falseerror, before: always, after: alwayserror, newIsCap: true, newIsCapExceptions: , capIsNew: false…error, selector: ForInStatement, message: for..in loops iter…error, defaultAssignment: falseerror, nevererror, alwayserror, always, line: exceptions: -, +, markers: =, !, block:…error, allowImplicit: trueerror, alwayswarnwarnerror, requireStringLiterals: trueerror, allowImplicit: true, checkForEach: falseerror, commentPattern: ^no default$error, allowKeywords: true, allowPattern: error, always, null: ignoreerror, 1warnerror, allowElseIf: falseerror, allow: arrowFunctions, functions, methodserror, exceptions: error, allowLoop: false, allowSwitch: falseerror, object: arguments, property: callee, message: argumen…error, alwayserror, props: trueerror, allowShortCircuit: false, allowTernary: false, allowT…error, allowEmptyReject: trueFAQs
Shareable ESLint config, based on airbnb/javascript, bundled as a plugin
We found that @thibaudcolas/eslint-plugin-cookbook demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."