@electrum-cash/eslint-config 1.1.0-development

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 General Protocols Pte Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @electrum-cash/eslint-config
+
+This repository contains an ESLint configuration for TypeScript projects in the `@electrum-cash/*` NPM package namespace. It is based on and extends the official Airbnb ESLint configuration and its TypeScript equivalent.
+
+## Dependencies
+
+Before you can use this you need to install the peer depenencies required by the configuration setup.
+
+```bash
+npm install --save-dev \
+  eslint \
+  typescript-eslint \
+  @typescript-eslint/parser \
+  @typescript-eslint/eslint-plugin \
+  @stylistic/eslint-plugin \
+  @chalp/eslint-airbnb
+```
+
+After installing the dependencies, you can install the module containing the configuration:
+
+```bash
+npm install --save-dev https://gitlab.com/electrum-cash/eslint-config
+```
+
+and put the following `eslint.config.mjs` in your project root directory:
+
+```ts
+export { default } from '@electrum-cash/eslint-config';
+```

package/eslint.config.mjs

@@ -0,0 +1,333 @@
+// Import globally available component required in different contexts (like window, document, Promise etc)
+import globals from 'globals';
+
+// Import support for typescript.
+import { parser } from 'typescript-eslint';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+
+// Import formatting relates extensions to eslint.
+import stylistic from '@stylistic/eslint-plugin';
+
+// Import community maintained fork of the airbnb rules.
+import airbnbTypescript from '@chalp/eslint-airbnb/typescript';
+
+//
+export default
+[
+	{
+		// Ignore common build artifacts and dependency files.
+		// NOTE: This needs to be the first object in the array, or eslint may fail due to trying to parse these files.
+		ignores:
+		[
+			'dist/**',
+			'public/**',
+			'node_modules/**',
+			'**/*.d.{ts,mts}'
+		],
+	},
+	{
+		// Configure which files to lint.
+		files:
+		[
+			'**/*.{ts,mts}',
+		],
+
+		languageOptions:
+		{
+			// Always enable full type-aware linting
+			parser: parser,
+			parserOptions: {
+				projectService: true,
+				tsconfigRootDir: import.meta.dirname,
+			},
+		},
+	},
+
+	// Enable the stylistic plugin.
+	{
+		plugins:
+		{
+			'@stylistic': stylistic,
+			'@typescript-eslint': typescriptEslint,
+		},
+	},
+
+	// Configure which globals are required in the various environments.
+	{
+		languageOptions:
+		{
+			globals:
+			{
+				...globals.browser,
+				...globals.es2021,
+			},
+		},
+	},
+
+	// Configure eslint-plugin-import to support typescript path aliases from tsconfig.json, with a default fallback if needed.
+	{
+		settings:
+		{
+			'import/resolver':
+			{
+				typescript: {},
+				node: {},
+			},
+		},
+	},
+
+	// Start with the airbnb ruleset.
+	...airbnbTypescript,
+
+	// Custom linting rules.
+	{
+		rules:
+		{
+			// require function expressions to have a name when it can't be inferred
+			// https://eslint.org/docs/rules/func-names
+			'func-names': [ 'error', 'as-needed' ],
+
+			// enforce intentional scoping for function declarations
+			// https://eslint.org/docs/rules/func-style
+			'func-style': [ 'error', 'expression' ],
+
+			// enforce position of line comments above the statement
+			// https://eslint.org/docs/rules/line-comment-position
+			'line-comment-position': [ 'error', {
+				position: 'above',
+				ignorePattern: '',
+			}],
+
+			// warn at very high nesting levels
+			// https://eslint.org/docs/rules/max-depth
+			'max-depth': [ 'warn', 5 ],
+
+			// warn if max number of lines exceeds 250 (consistent with GitLab code quality reports)
+			// turned off because of editor highlighting
+			// https://eslint.org/docs/rules/max-lines
+			'max-lines': [ 'off', {
+				max: 250,
+				skipBlankLines: true,
+				skipComments: true,
+			}],
+
+			// warn if max function length exceeds 25 (consistent with GitLab code quality reports)
+			// turned off because of editor highlighting
+			// https://eslint.org/docs/rules/max-lines-per-function
+			'max-lines-per-function': [ 'off', {
+				max: 25,
+				skipBlankLines: true,
+				skipComments: true,
+				IIFEs: true,
+			}],
+
+			// warn when the number of function parameters gets too large
+			// https://eslint.org/docs/rules/max-params
+			'max-params': [ 'warn', 5 ],
+
+			// disallow multiple statements per line for readability
+			// https://eslint.org/docs/rules/max-statements-per-line
+			'max-statements-per-line': [ 'error', { max: 1 }],
+
+			// disallow multiline ternaries for readability
+			// https://eslint.org/docs/rules/multiline-ternary
+			'multiline-ternary': [ 'warn', 'never' ],
+
+			// we prefer the readability of separated return statements
+			// can be ignored if done intentionally
+			// https://eslint.org/docs/rules/newline-before-return
+			'newline-before-return': [ 'warn' ],
+
+			// allow bitwise operators (e.g. for AnyHedge simulation)
+			// https://eslint.org/docs/rules/no-bitwise
+			'no-bitwise': [ 'off' ],
+
+			// allow the use of the continue statement because there is no clear
+			// argument against them
+			// https://eslint.org/docs/rules/no-continue
+			'no-continue': [ 'off' ],
+
+			// discourage use of line comments on the same line as code
+			// https://eslint.org/docs/rules/no-inline-comments
+			'no-inline-comments': [ 'warn' ],
+
+			// disabllow single-line blocks
+			// https://eslint.org/docs/rules/no-unexpected-multiline
+			'no-unexpected-multiline': [ 'off' ],
+
+			// we want to allow the use of for..in and for..of statements
+			// https://eslint.org/docs/rules/no-restricted-syntax
+			// https://eslint.org/docs/rules/guard-for-in
+			'no-restricted-syntax': [ 'off' ],
+			'guard-for-in': [ 'off' ],
+
+			// Disallow the use of Math.pow in favor of the ** operator for consistency
+			// with other arithmetic operators
+			// https://eslint.org/docs/rules/prefer-exponentiation-operator
+			'prefer-exponentiation-operator': [ 'error' ],
+
+			// warn about unused variables if not starting with underscore, in order to not break the pre-commit hooks
+			// https://eslint.org/docs/rules/no-unused-vars
+			'no-unused-vars': [ 'warn', { varsIgnorePattern: '^_', argsIgnorePattern: '^_',  caughtErrorsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_' }],
+			'@typescript-eslint/no-unused-vars': [ 'warn', { varsIgnorePattern: '^_', argsIgnorePattern: '^_',  caughtErrorsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_' }],
+
+			// do not allow re-declaring names in nested namespaces.
+			'no-shadow': [ 'error' ],
+
+			// for singleton classes it makes sense not to enforce this rule
+			// https://eslint.org/docs/rules/class-methods-use-this
+			'class-methods-use-this': [ 'off' ],
+
+			// encourages use of dot notation whenever possible
+			// https://eslint.org/docs/rules/dot-notation
+			'dot-notation': [ 'warn', { allowKeywords: true }],
+
+			// warn about a maximum number of classes per file
+			// https://eslint.org/docs/rules/max-classes-per-file
+			'max-classes-per-file': [ 'warn', 1 ],
+
+			// discourage unnecessary nested blocks
+			// https://eslint.org/docs/rules/no-lone-blocks
+			'no-lone-blocks': [ 'warn' ],
+
+			// Sometimes you want to execute async calls in loops sequentially
+			// https://eslint.org/docs/rules/no-await-in-loop
+			'no-await-in-loop': [ 'off' ],
+
+			// disallow use of constant expressions in conditions
+			// https://eslint.org/docs/rules/no-constant-condition
+			'no-constant-condition': [ 'error' ],
+
+			// require explicit file extension when importing from files.
+			// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
+			'import/extensions': [ 'error', 'ignorePackages', { 'js': 'always', 'ts': 'always' }],
+
+			// do not enforce any import ordering
+			// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md
+			'import/order': [ 'off' ],
+
+			// do not require default export
+			// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+			'import/prefer-default-export': [ 'off' ],
+
+			// allows shorthands on a case-by-case basis in order to maintain
+			// consistency across sections of code with multiple statements.
+			// https://eslint.org/docs/rules/object-shorthand
+			'object-shorthand': [ 'off' ],
+
+			// callbacks can either be named functions or arrow functions
+			'prefer-arrow-callback': [ 'error', {
+				allowNamedFunctions: true,
+			}],
+		},
+	},
+
+	// Custom formatting rules.
+	{
+		rules:
+		{
+			// enforce consistent line breaks after opening and before closing array brackets
+			// https://eslint.style/rules/array-bracket-newline
+			'@stylistic/array-bracket-newline': [ 'error', 'consistent' ],
+
+			// warn about consistent line breaks between array elements
+			// warn instead of error to allow intentional deviations
+			// https://eslint.style/rules/array-element-newline
+			'@stylistic/array-element-newline': [ 'warn', 'consistent' ],
+
+			// enforce spacing inside array brackets to be consistent with object brackets
+			// https://eslint.style/rules/array-bracket-spacing
+			'@stylistic/array-bracket-spacing': [ 'error', 'always', { objectsInArrays: false, arraysInArrays: false }],
+
+			// enforce allman brace style, disallow single line blocks
+			// https://eslint.style/rules/brace-style
+			// https://eslint.style/rules/operator-linebreak
+			'@stylistic/brace-style': [ 'error', 'allman', { allowSingleLine: true }],
+			'@stylistic/operator-linebreak': [ 'error', 'before', { overrides: { '=': 'ignore' } }],
+
+			// enforce consistent line breaks in function calls
+			// https://eslint.style/rules/function-call-argument-newline
+			'@stylistic/function-call-argument-newline': [ 'off', 'consistent' ],
+
+			// use tabs for indentation and use indentation in switch-cases for readability
+			// https://eslint.style/rules/indent
+			// https://eslint.style/rules/no-tabs
+			// NOTE: This is set to warn due to incompatibility with typescript in some cases
+			// https://github.com/typescript-eslint/typescript-eslint/issues/1824
+			'@stylistic/no-tabs': [ 'off' ],
+			'@stylistic/indent':
+			[
+				'warn',
+				"tab",
+				{
+					SwitchCase: 1,
+					MemberExpression: 1,
+					FunctionDeclaration: { parameters: 1, body: 1 },
+					FunctionExpression: { parameters: 1, body: 1 },
+					CallExpression: { arguments: 1 }
+				}
+			],
+
+			// Selectively disable to allow extra indent for object literals in class properties.
+			'@stylistic/indent':
+			[
+				'off',
+				{
+					selector: [ 'ClassProperty > ObjectExpression' ]
+				}
+			],
+
+
+			// allow multiple spaces for alignment
+			// https://eslint.style/rules/key-spacing
+			'@stylistic/key-spacing': [ 'error', { mode: 'minimum' }],
+			'@stylistic/no-multi-spaces': [ 'off' ],
+
+			// no spaces after if/for/while/catch/switch
+			// https://eslint.style/rules/keyword-spacing
+			'@stylistic/keyword-spacing': [ 'error', { overrides: {
+				if: { after: false },
+				for: { after: false },
+				while: { after: false },
+				throw: { after: false },
+				catch: { after: false },
+				switch: { after: false },
+			}}],
+
+			// specify the maximum length of a line in your program
+			// https://eslint.style/rules/max-len
+			'@stylistic/max-len': [ 'off', 200, 4, {
+				ignoreUrls: true,
+				ignoreComments: false,
+				ignoreRegExpLiterals: true,
+				ignoreStrings: true,
+				ignoreTemplateLiterals: true,
+			}],
+
+			// enforces new line after each method call in the chain to make it
+			// more readable and easy to maintain
+			// https://eslint.style/rules/newline-per-chained-call
+			'@stylistic/newline-per-chained-call': [ 'error', { ignoreChainWithDepth: 2 }],
+
+			// enforce that an object is either on one line, or every property is on a new line
+			// https://eslint.style/rules/object-curly-newline
+			'@stylistic/object-curly-newline': [ 'error', { consistent: true }],
+
+			// enforce consistency between anonymous and named functions
+			// https://eslint.style/rules/space-before-function-paren
+			'@stylistic/space-before-function-paren': [ 'error', {
+				anonymous: 'never',
+				named: 'ignore',
+				asyncArrow: 'always'
+			}],
+
+			// enforce each parameter on a separate line for functions that are not declared in a single line.
+			// https://eslint.style/rules/function-paren-newline
+			'@stylistic/function-paren-newline': [ 'error', 'multiline' ],
+
+			// allow grouping of class properties in TypeScript
+			// https://eslint.org/docs/rules/lines-between-class-members
+			'@stylistic/lines-between-class-members': [ 'error', 'always', { exceptAfterSingleLine: true }],
+		},
+	},
+];

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@electrum-cash/eslint-config",
+  "version": "1.1.0-development",
+  "description": "ESLint configuration for Electrum Cash projects",
+  "type": "module",
+  "main": "eslint.config.mjs",
+  "exports": {
+    ".": "./eslint.config.mjs"
+  },
+  "files": [
+    "eslint.config.mjs"
+  ],
+  "scripts": {
+    "syntax": "eslint eslint.config.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/electrum-cash/eslint-config.git"
+  },
+  "author": "Jonathan Silverblood",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/electrum-cash/eslint-config/issues"
+  },
+  "homepage": "https://gitlab.com/electrum-cash/eslint-config#readme",
+  "devDependencies": {
+    "@chalp/eslint-airbnb": "^1.3.0",
+    "@stylistic/eslint-plugin": "^4.4.1",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "eslint": "^9.39.2",
+    "eslint-import-resolver-typescript": "^3.10.1",
+    "eslint-plugin-import": "^2.32.0",
+    "globals": "^17.0.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.0"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "typescript-eslint": "^8.0.0",
+    "@stylistic/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@chalp/eslint-airbnb": "^1.3.0"
+  }
+}