@xrplf/eslint-config
v1.10.1
Published
The XRPL Foundation's base TypeScript ESLint config, following our styleguide
Downloads
338
Readme
@xrplf/eslint-config
A super-strict TypeScript linting configuration for enforcing best practices.
Installation
First, install the needed development dependencies:
# Ensure TypeScript and the TS ESLint parser are installed
npm install --save-dev typescript @typescript-eslint/parser
# Ensure ESLint & Prettier are installed
npm install --save-dev eslint prettier
# Install plugins used by @xrplf/eslint-config
npm install --save-dev @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-prettier eslint-plugin-jsdoc eslint-plugin-tsdoc eslint-plugin-array-func eslint-plugin-eslint-comments eslint-plugin-node
# Install the Xpring ESLint config
npm install --save-dev @xrplf/eslint-config
Usage
Then, configure your ESLint to use the Xpring configuration. An example ESLint configuration is provided below:
module.exports = {
root: true,
// Make ESLint compatible with TypeScript
parser: '@typescript-eslint/parser',
parserOptions: {
// Enable linting rules with type information from our tsconfig
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
// Allow the use of imports / ES modules
sourceType: 'module',
ecmaFeatures: {
// Enable global strict mode
impliedStrict: true,
},
},
// Specify global variables that are predefined
env: {
node: true, // Enable node global variables & Node.js scoping
es2020: true, // Add all ECMAScript 2020 globals and automatically set the ecmaVersion parser option to ES2020
},
plugins: [],
extends: ['@xrplf'],
rules: {},
overrides: [],
}
Recommended Configs
We provide four different configurations.
The main configuration is strict and assumes that the project you're linting uses React. This is
@xrplf/eslint-config
, or@xrplf
for short.If you're not using React but still want strict checking you can use
@xrplf/eslint-config/base
.If you need a looser rule set for the purpose of transitioning onto the strict rules and are using React you can use
@xrplf/eslint-config/loose
.Finally, if you need the looser rule set and are not using react you can use
@xrplf/eslint-config/loose-base
.
Loose Config
The looser configuration differs in the following ways:
- Longer line length limitation for functions
- More parameters allowed per function
- The very strict
no-unsafe-*
rules from@typescript-eslint
are disabled - Type assertions are allowed