Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@jsenv/eslint-config
Advanced tools
ESLint config file consists into a single big object. This package allows to split this object to compose and reuse them.
This is achieved by a function capable to compose subsets of ESLint configuration.
composeEslintConfig is a function returning an eslint config object being the composition of eslint config objects passed in arguments.
const {
composeEslintConfig,
eslintConfigBase,
} = require("@jsenv/eslint-config");
const eslintConfig = composeEslintConfig(
eslintConfigBase,
// first "group": enable html plugin
{
plugins: ["html"],
settings: {
extensions: [".html"],
},
},
// second "group": enable react plugin
{
plugins: ["react"],
settings: {
extensions: [".jsx"],
},
},
);
module.exports = eslintConfig;
ESLint config | Description |
---|---|
eslintConfigBase | Enable latest js features |
eslintConfigForPrettier | Disable eslint rules already handled by prettier |
eslintConfigToPreferExplicitGlobals | Force code to use global variables explicitly; like window.event |
The following code is meant to be put into an .eslintrc.cjs file and does the following:
const {
composeEslintConfig,
eslintConfigBase,
jsenvEslintRules,
jsenvEslintRulesForImport,
eslintConfigToPreferExplicitGlobals,
eslintConfigForPrettier,
} = require("@jsenv/eslint-config");
const eslintConfig = composeEslintConfig(
eslintConfigBase,
{
rules: {
...jsenvEslintRules,
"operator-assignment": ["error", "always"], // override jsenv rules
},
},
// import plugin
{
plugins: ["import"],
settings: {
"import/resolver": {
"@jsenv/eslint-import-resolver": {
rootDirectoryUrl: __dirname,
packageConditions: ["node", "import"],
},
},
"import/extensions": [".js", ".mjs"],
},
rules: jsenvEslintRulesForImport,
},
// files are written for Node.js by default
{
env: {
node: true,
},
},
// package is "type": "module" so:
// 1. disable commonjs globals by default
// 2. Re-enable commonjs into *.cjs files
{
globals: {
__filename: "off",
__dirname: "off",
require: "off",
exports: "off",
},
overrides: [
{
files: ["**/*.cjs"],
env: {
commonjs: true,
},
// inside *.cjs files. restore commonJS "globals"
globals: {
__filename: true,
__dirname: true,
require: true,
exports: true,
},
},
],
},
// several files are written for browsers, not Node.js
{
overrides: [
{
files: ["**/**/*.html", "**/src/**/*.js"],
env: {
browser: true,
node: false,
},
settings: {
"import/resolver": {
"@jsenv/eslint-import-resolver": {
rootDirectoryUrl: __dirname,
packageConditions: ["browser", "import"],
},
},
},
},
],
},
// html plugin
{
plugins: ["html"],
settings: {
extensions: [".html"],
},
},
eslintConfigToPreferExplicitGlobals,
// We are using prettier, disable all eslint rules
// already handled by prettier.
eslintConfigForPrettier,
);
module.exports = eslintConfig;
The above configuration uses @jsenv/eslint-import-resolver to resolve import so it needs to be installed.
npm install --save-dev @jsenv/eslint-import-resolver
Rules | Description |
---|---|
jsenvEslintRules | jsenv rules for ESLint |
jsenvEslintRulesForImport | jsenv rules for eslint-plugin-import |
jsenvEslintRulesForReact | jsenv rules for project using react and eslint-plugin-react |
It will be supported by default in ESLint 8. Until then you need:
"@babel/eslint-parser"
and "@babel/core"
in your devDependencies"@babel/eslint-parser"
npm install --save-dev @babel/eslint-parser
npm install --save-dev @babel/core
.eslintrc.cjs:
const {
composeEslintConfig,
eslintConfigBase,
} = require("@jsenv/eslint-config");
const eslintConfig = composeEslintConfig(
eslintConfigBase,
// use "@babel/eslint-parser" until top level await is supported by ESLint default parser
{
parser: "@babel/eslint-parser",
parserOptions: {
requireConfigFile: false,
},
},
);
module.exports = eslintConfig;
const {
composeEslintConfig,
eslintConfigBase,
jsenvEslintRulesForReact,
} = require("@jsenv/eslint-config");
const eslintConfig = composeEslintConfig(
eslintConfigBase,
// react
{
plugins: ["react"],
settings: {
react: {
version: "detect",
},
},
rules: jsenvEslintRulesForReact,
},
);
module.exports = eslintConfig;
"@babel/eslint-parser"
and "@babel/plugin-syntax-jsx"
in your devDependencies@babel/plugin-syntax-jsx
in babel config file"@babel/eslint-parser"
npm install --save-dev @babel/eslint-parser
npm install --save-dev @babel/plugin-syntax-jsx
babel.config.cjs:
const babelPluginSyntaxJSX = require("@babel/plugin-syntax-jsx");
module.exports = {
plugins: [
[
babelPluginSyntaxJSX,
{
pragma: "React.createElement",
pragmaFrag: "React.Fragment",
},
],
],
};
.eslintrc.cjs:
const {
composeEslintConfig,
eslintConfigBase,
jsenvEslintRulesForReact,
} = require("@jsenv/eslint-config");
const eslintConfig = composeEslintConfig(
eslintConfigBase,
// jsx
{
parser: "@babel/eslint-parser",
parserOptions: {
ecmaFeatures: {
jsx: true,
},
},
settings: {
extensions: [".jsx"],
},
},
);
module.exports = eslintConfig;
In ".vscode/settings.json"
file, add
"eslint.validate": ["javascript", "html"]
FAQs
Create ESLint configuration for any project
The npm package @jsenv/eslint-config receives a total of 18 weekly downloads. As such, @jsenv/eslint-config popularity was classified as not popular.
We found that @jsenv/eslint-config demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.