This package is ReverentGeek's preferred configuration settings for eslint.
- Install dependencies.
npm install --save-dev eslint eslint-config-reverentgeek
- Create an
eslint.config.js
file. - Add the following to the config file.
"use strict";
const rgConfig = require( "eslint-config-reverentgeek" );
module.exports = [
...rgConfig.configs.common,
{
rules: {
}
}
];
The blog config changes the code style to two-spaced indentions, which is better for copying code samples to blog posts.
"use strict";
const rgConfig = require( "eslint-config-reverentgeek" );
module.exports = [
...rgConfig.configs.browser,
...rgConfig.configs.blog,
{
rules: {
}
}
];
The node config adds specific support for Node.js and CommonJS modules.
"use strict";
const rgConfig = require( "eslint-config-reverentgeek" );
module.exports = [
...rgConfig.configs.node,
{
rules: {
"n/no-unpublished-require": [ "error", {
allowModules: [ "eslint-config-reverentgeek" ]
} ]
}
}
];
The node-esm config adds specific support for Node.js and ES modules (import
/export
).
import rg from "eslint-config-reverentgeek";
export default [
...rg.configs[ "node-esm" ],
{
rules: {
"n/no-unpublished-import": [ "error", {
allowModules: [ "eslint-config-reverentgeek" ]
} ]
}
}
];
The react config adds specific support for Node.js and ES modules (import
/export
).
import rg from "eslint-config-reverentgeek";
import react from "eslint-plugin-react";
export default [
...rg.configs[ "node-esm" ],
...rg.configs.react,
{
plugins: {
react,
},
rules: {
"n/no-unpublished-import": [ "error", {
allowModules: [ "eslint-config-reverentgeek" ]
} ]
}
}
];
The browser config sets the browser
environment and adds ES module support.
"use strict";
const rgConfig = require( "eslint-config-reverentgeek" );
module.exports = [
...rgConfig.configs.browser,
{
rules: {
}
}
];
- Install dependencies.
npm install --save-dev eslint@8 eslint-config-reverentgeek@4
- Create an
.eslintrc.js
file. - Add the following to the config file.
module.exports = {
extends: [ "reverentgeek" ]
};
The blog rule set changes to code style to two-spaced indentions, which is better for copying code samples to blog posts.
module.exports = {
extends: [ "reverentgeek/blog" ]
};
The node rule set adds specific support for Node.js and CommonJS modules.
"use strict";
module.exports = {
extends: [ "reverentgeek/node" ]
};
The node/module rule set adds specific support for Node.js and ES modules (import
/export
).
"use strict";
module.exports = {
extends: [ "reverentgeek/node/module" ]
};
The browser rule set the browser
environment and adds ES module support.
module.exports = {
extends: [ "reverentgeek/browser" ]
};