Security News
Input Validation Vulnerabilities Dominate MITRE's 2024 CWE Top 25 List
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
eslint-config-rel1cx
Advanced tools
An ESLint config that self-adapting to project dependencies and TypeScript configuration.
An ESLint config that self-adapting to project dependencies and TypeScript configuration.
npm install --save-dev eslint-config-rel1cx eslint
pnpm add --save-dev eslint-config-rel1cx eslint
You profit automatically of automatic dependency and feature detection. Due to the nature of ESLint configs however this approach is significantly harder to customize.
// .eslintrc.js
module.exports = {
extends: "rel1cx",
};
This showcases the required setup to begin with customizing your config on an advanced level. Please check out the Examples
section below for more details.
// .eslintrc.js
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
module.exports = createConfig();
// .eslintrc.js
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
module.exports = createConfig({
incrementalAdoption: true,
});
You like all the features eslint-config-rel1cx
ships with but you heavily disagree with many rule settings?
Say no more. Simply pass { blankSlate: true }
to createConfig
and you still benefit from automatic dependency detection, the general override setup based on file patterns, but every rule will be set to off
.
This way, you can customize it entirely to your likings without having to create n overrides for rules and or rulesets.
While in the process of migration, you may end up in a situation where you cannot turn on compilerOptions.checkJs
from TypeScript itself due to e.g. builds breaking. However, by default certain rules will be disabled for JavaScript files because they are technically shadowed by TypeScript itself, e.g. no-undef
.
You can opt out of this behaviour by either:
enableJavaScriptSpecificRulesInTypeScriptProject
as true
to createConfig
compilerOptions.checkJs
once you're thereExample:
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
module.exports = createConfig({
enableJavaScriptSpecificRulesInTypeScriptProject: true,
});
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
const { getDependencies } = require("eslint-config-rel1cx/lib/getDependencies");
const {
createTypeScriptOverride,
} = require("eslint-config-rel1cx/lib/overrides/typescript");
const dependencies = getDependencies();
const customTypescriptOverride = createTypeScriptOverride({
...dependencies,
rules: {
// here goes anything that applies **exclusively** to typescript files based on the `files` glob pattern also exported from ../overrides/typescript
"@typescript-eslint/explicit-module-boundary-types": "warn", // downgrading the default from "error" to "warn"
},
});
module.exports = createConfig({
overrides: [customTypescriptOverride],
});
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
const { getDependencies } = require("eslint-config-rel1cx/lib/getDependencies");
const {
createReactOverride,
} = require("eslint-config-rel1cx/lib/overrides/react");
const dependencies = getDependencies();
const customReactOverride = createReactOverride({
...dependencies,
rules: {
"unicorn/no-abusive-eslint-disable": "off",
},
});
module.exports = createConfig({
overrides: [customReactOverride],
});
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
const { getDependencies } = require("eslint-config-rel1cx/lib/getDependencies");
const {
createReactOverride,
} = require("eslint-config-rel1cx/lib/overrides/react");
const dependencies = getDependencies();
const customReactOverride = createReactOverride({
...dependencies,
plugins: ["my-fancy-plugin"],
rules: {
"plugin/foo": "warn",
"plugin/bar": "error",
"plugin/baz": "off",
},
});
module.exports = createConfig({
overrides: [customReactOverride],
});
const { getDependencies } = require("eslint-config-rel1cx/lib/getDependencies");
const {
files,
parser,
defaultSettings,
} = require("eslint-config-rel1cx/lib/overrides/react");
const dependencies = getDependencies();
const myReactOverride = {
// using the internal react glob pattern
files,
// using the internal default react parser
parser,
// defining your custom rules
rules: {
"react/react-in-jsx-scope": "warn",
},
// using the default settings
settings: defaultSettings,
};
module.exports = {
overrides: [myReactOverride],
rules: {
"no-await-in-loop": "warn",
},
};
Everything is dynamically included based on your package.json
and when using TypeScript, your tsconfig.json
.
Rules are selectively applied based on file name patterns.
All rules are commented and link to their docs.
All rulesets and overrides are created through functions accepting an object matching this schema:
interface Project {
/**
* whether `@types/node` is present
*/
hasNodeTypes: boolean;
/**
* whether `@nestjs/core` is present
*/
hasNest: boolean;
typescript: {
/**
* whether `typescript` is present
*/
hasTypeScript: boolean;
/**
* the installed version
*/
version: string;
/**
* your tsConfig; used to detect feature availability
*/
config?: object;
};
react: {
/**
* whether any flavour of react is present
*/
hasReact: boolean;
/**
* whether `preact` is present
* currently without effect
*/
isPreact: boolean;
/**
* the installed version
*/
version: string;
};
/**
* your custom rules on top
*/
rules?: object;
}
This list only mentions the exports most people will need. For an exhaustive list, check out the source.
const { createTypeScriptOverride } = require('eslint-config-rel1cx/lib/overrides/typescript')
const { createReactOverride } = require('eslint-config-rel1cx/lib/overrides/react')
Please note that the test override should always come last.
const { createEslintCoreRules } = require('eslint-config-rel1cx/lib/plugins/eslint-core')
const { createImportRules } = require('eslint-config-rel1cx/lib/plugins/import')
const { createPromiseRules } = require('eslint-config-rel1cx/lib/plugins/promise')
const { createSonarjsRules } = require('eslint-config-rel1cx/lib/plugins/sonarjs')
const { createUnicornRules } = require('eslint-config-rel1cx/lib/plugins/unicorn')
const { createConfig } = require("eslint-config-rel1cx/lib/createConfig");
const {
createTypeScriptOverride,
} = require("eslint-config-rel1cx/lib/overrides/typescript");
const packageJson = require("./package.json");
// since `createTypeScriptOverride` is entirely configurable, we need to inform it about its environment
const tsOverrideConfig = {
react: {
hasReact: true,
},
rules: {
"@typescript-eslint/ban-ts-comment": "off",
},
typescript: {
hasTypeScript: true,
// sync with package.json should you upgrade TS
version: packageJson.dependencies.typescript,
},
};
// solely an override for TS
const tsOverride = createTypeScriptOverride(tsOverrideConfig);
// pass it into createConfig as array as it will be merged with the other overrides
module.exports = createConfig({ overrides: [tsOverride] });
This project follows semver.
This project uses code from following third-party projects:
Licenses are list in THIRD-PARTY-LICENSE
FAQs
An ESLint config that self-adapting to project dependencies and TypeScript configuration.
The npm package eslint-config-rel1cx receives a total of 6 weekly downloads. As such, eslint-config-rel1cx popularity was classified as not popular.
We found that eslint-config-rel1cx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer 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
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.