mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 11:45:49 +00:00
a6b4308a49
* Replace TSLint with ESLint + Prettier TSLint is deprecated, and ESLint is now officially supported by TypeScript. Additionally, Prettier is the industry standard for auto-formatting JS/TS code. That lets code reviews be about content rather than style. The `.eslintrc.js` file contains comments for the reasoning behind every configuration, so feel free to take a look at that as well. * Run src/ through Prettier * Add Mocha support for ESLint We do not actually lint Mocha files right now because they aren't in TS, but moving forward, this will give us better linting rules for our tests
76 lines
2.4 KiB
JavaScript
76 lines
2.4 KiB
JavaScript
module.exports = {
|
|
root: true,
|
|
|
|
parser: '@typescript-eslint/parser', // Make ESLint compatible with TypeScript
|
|
parserOptions: {
|
|
// Enable linting rules with type information from our tsconfig
|
|
tsconfigRootDir: __dirname,
|
|
project: ['./tsconfig.json'],
|
|
|
|
sourceType: 'module', // Allow the use of imports / ES modules
|
|
|
|
ecmaFeatures: {
|
|
impliedStrict: true, // Enable global strict mode
|
|
},
|
|
},
|
|
|
|
// Specify global variables that are predefined
|
|
env: {
|
|
browser: true, // Enable browser global variables
|
|
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
|
|
mocha: true, // Add Mocha testing global variables
|
|
},
|
|
|
|
plugins: [
|
|
'@typescript-eslint', // Add some TypeScript specific rules, and disable rules covered by the typechecker
|
|
'import', // Add rules that help validate proper imports
|
|
'mocha', // Add rules for writing better Mocha tests
|
|
'prettier', // Allows running prettier as an ESLint rule, and reporting differences as individual linting issues
|
|
],
|
|
|
|
extends: [
|
|
// ESLint recommended rules
|
|
'eslint:recommended',
|
|
|
|
// Add TypeScript-specific rules, and disable rules covered by typechecker
|
|
'plugin:@typescript-eslint/eslint-recommended',
|
|
'plugin:@typescript-eslint/recommended',
|
|
|
|
// Add rules for import/export syntax
|
|
'plugin:import/errors',
|
|
'plugin:import/warnings',
|
|
'plugin:import/typescript',
|
|
|
|
// Add rules for Mocha-specific syntax
|
|
'plugin:mocha/recommended',
|
|
|
|
// Add Airbnb + TypeScript support
|
|
'airbnb-base',
|
|
'airbnb-typescript/base',
|
|
|
|
// Add rules that specifically require type information using our tsconfig
|
|
'plugin:@typescript-eslint/recommended-requiring-type-checking',
|
|
|
|
// Enable Prettier for ESLint --fix, and disable rules that conflict with Prettier
|
|
'prettier/@typescript-eslint',
|
|
'plugin:prettier/recommended',
|
|
],
|
|
|
|
rules: {
|
|
// Unary operators are subject to Automatic Semicolon Insertion, which can cause bugs. However, we should allow them in for loops
|
|
'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
|
|
},
|
|
|
|
overrides: [
|
|
{
|
|
files: 'sha512.ts',
|
|
rules: {
|
|
// In general, it's more likely that & or | is a typo of && or ||,
|
|
// But for this file, we explicitly are using bitwise operators.
|
|
'no-bitwise': 'off'
|
|
}
|
|
}
|
|
]
|
|
}
|