@niondigital/eslint-config-base 1.9.0 → 2.0.0

package/README.md

@@ -1,32 +1,44 @@
 # `@niondigital/eslint-config-base`
 
-This package provides an eslint config as used by [nion digital](https://www.nion-digital.com) as an extensible shared config.
+Shared ESLint config as base by [nion digital](https://www.nion-digital.com).
 
 ## Installation
 
-```sh
+1. Install package as a dev dependency:
+
+```bash
 npx install-peerdeps --dev @niondigital/eslint-config-base
 ```
 
-## Usage
+2. Create `eslint.config.mjs` at the root and add the following code:
 
-Extend local eslint configuration with `@niondigital/eslint-config-base`:
+```js
+import getConfig from '@niondigital/eslint-config-base';
 
-```json
-{
-	"extends": "@niondigital/eslint-config-base",
-	"rules": {}
-}
+export default getConfig();
 ```
 
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2024 nion digital GmbH, Germany
+3. Add the following script in `package.json`:
 
-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.
+```js
+{
+  // ...
+  "scripts": {
+    // ...
+    "eslint": "eslint --fix \"src/**/*.ts\""
+  }
+}
+```
 
-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.
+4. (Optional) You can customize the config by passing an object:
+
+```js
+export default getConfig({
+	// Files to be ignored
+	ignores: [],
+	// Additional ESLint rules
+	additionalRules: {},
+	// Additional ESLint config
+	additionalConfig: [],
+});
+```

package/config.js

@@ -0,0 +1,18 @@
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+export default ({ ignores = [], additionalRules = {}, additionalConfig = [] } = {}) => {
+	const rules = {
+		'no-undef': 'off',
+		...additionalRules,
+	};
+
+	return defineConfig([
+		eslint.configs.recommended,
+		...tseslint.configs.recommended,
+		...additionalConfig,
+		{ ignores },
+		{ rules },
+	]);
+};

package/package.json

@@ -1,70 +1,20 @@
 {
 	"name": "@niondigital/eslint-config-base",
-	"version": "1.9.0",
-	"description": "niondigital base eslint config",
+	"type": "module",
+	"version": "2.0.0",
+	"author": "Dominik Gallitzendörfer <dominik.gallitzendoerfer@nion-digital.com>",
+	"main": "./config.js",
+	"repository": "https://github.com/niondigital/javascript-style",
+	"license": "MIT",
 	"keywords": [
 		"eslint",
-		"config",
-		"eslintconfig",
-		"niondigital"
+		"eslint-config"
 	],
-	"author": "David Seibert <david.seibert@nion-digital.com>",
-	"homepage": "https://github.com/niondigital/javascript-style",
-	"license": "MIT",
-	"main": "index.js",
-	"exports": {
-		".": "./index.js",
-		"./.editorconfig": "./.editorconfig"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/niondigital/javascript-style.git"
-	},
-	"scripts": {
-		"lint": "eslint .",
-		"lint:fix": "eslint . --fix"
-	},
-	"bugs": {
-		"url": "https://github.com/niondigital/javascript-style/issues"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"devDependencies": {
-		"@babel/runtime": "^7.23.9",
-		"@eslint/js": "^9.3.0",
-		"@types/eslint__js": "^8.42.3",
-		"@typescript-eslint/eslint-plugin": "^7.15.0",
-		"babel-preset-airbnb": "^4.5.0",
-		"babel-tape-runner": "^3.0.0",
-		"eclint": "^2.8.1",
-		"eslint": "^8.57.0",
-		"eslint-config-airbnb": "^19.0.4",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-find-rules": "^4.1.0",
-		"eslint-import-resolver-typescript": "^3.6.1",
-		"eslint-plugin-import": "^2.29.1",
-		"eslint-plugin-jest": "^28.8.0",
-		"eslint-plugin-unused-imports": "^4.1.3",
-		"in-publish": "^2.0.1",
-		"jest": "^29.7.0",
-		"safe-publish-latest": "^2.0.0",
-		"typescript": "^5.4.5",
-		"typescript-eslint": "^7.11.0"
-	},
 	"peerDependencies": {
-		"@typescript-eslint/eslint-plugin": "^7.15.0",
-		"eslint": "^8.2.0",
-		"eslint-config-airbnb": "^19.0.4",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-import-resolver-typescript": "^3.6.1",
-		"eslint-plugin-import": "^2.29.1",
-		"eslint-plugin-jest": "^28.8.0",
-		"eslint-plugin-unused-imports": "^4.1.3",
-		"jest": "*"
-	},
-	"engines": {
-		"node": ">=18.0.0"
+		"@eslint/js": "^9.37.0",
+		"eslint": "^9.37.0",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.46.0"
 	},
-	"gitHead": "c01cc9633f5ac6b6d2478a9b5274fda9ab72339c"
+	"gitHead": "977a04e3db155a623b3242fbe1d076be4ed2063e"
 }

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "./index.js"
-}

package/index.js

@@ -1,170 +0,0 @@
-/* eslint-env node */
-module.exports = {
-	parser: '@typescript-eslint/parser',
-	extends: [
-		'eslint:recommended',
-		'plugin:@typescript-eslint/recommended',
-		'eslint-config-airbnb',
-		'plugin:jest/recommended',
-		'prettier'
-	],
-	plugins: ['@typescript-eslint', 'eslint-plugin-unused-imports'],
-	rules: {
-		'comma-dangle': 'off',
-		// use tabs for indentation
-		indent: 0,
-		'no-tabs': 0,
-		// allow imports without file extensions
-		'import/extensions': ['error', 'always', { js: 'never', ts: 'never' }],
-		// require leading spaces in comments
-		'spaced-comment': [
-			'error',
-			'always',
-			{
-				markers: ['/']
-			}
-		],
-		'import/prefer-default-export': 0,
-
-		'@typescript-eslint/indent': ['error', 'tab'],
-
-		'no-use-before-define': 0,
-
-		// allow long lines
-		'max-len': 0,
-
-		// handle redeclares via typescript-eslint
-		'no-redeclare': 'off',
-		'@typescript-eslint/no-redeclare': 'error',
-
-		// shadowing
-		'no-shadow': 'off', // replaced by ts-eslint rule below
-		'@typescript-eslint/no-shadow': 'error',
-
-		// naming conventions
-		camelcase: 'off',
-		'no-underscore-dangle': 'off',
-		'@typescript-eslint/naming-convention': [
-			'error',
-			{
-				selector: 'default',
-				format: ['camelCase']
-			},
-			{
-				selector: ['function'],
-				format: ['camelCase', 'PascalCase'],
-				leadingUnderscore: 'allow'
-			},
-			{
-				selector: 'variable',
-				format: ['camelCase', 'UPPER_CASE'],
-				leadingUnderscore: 'allow'
-			},
-			{
-				selector: 'parameter',
-				format: ['camelCase'],
-				leadingUnderscore: 'allow'
-			},
-			{
-				selector: 'memberLike',
-				format: ['camelCase', 'PascalCase', 'UPPER_CASE', 'snake_case'],
-				leadingUnderscore: 'allow'
-			},
-			{
-				selector: 'import',
-				format: ['camelCase', 'PascalCase', 'UPPER_CASE', 'snake_case'],
-				leadingUnderscore: 'allow'
-			},
-			{
-				selector: 'typeLike',
-				format: ['PascalCase']
-			}
-			/*
-			{
-				selector: 'interface',
-				format: ['PascalCase'],
-				prefix: ['I']
-			}
-			*/
-		],
-
-		// types
-		'@typescript-eslint/no-explicit-any': 'off',
-		'@typescript-eslint/no-inferrable-types': 'off',
-
-		// member accessibility
-		'@typescript-eslint/explicit-member-accessibility': 'error',
-
-		// unused vars
-		'no-unused-vars': 'off',
-		'@typescript-eslint/no-unused-vars': 'off',
-		'unused-imports/no-unused-imports': 'error',
-		'unused-imports/no-unused-vars': [
-			'warn',
-			{
-				vars: 'all',
-				varsIgnorePattern: '^_',
-				args: 'after-used',
-				argsIgnorePattern: '^_'
-			}
-		],
-
-		// use of semicolons
-		semi: 'off',
-		'@typescript-eslint/semi': ['error'],
-
-		// this usage in classes
-		'class-methods-use-this': 'off',
-		'@typescript-eslint/class-methods-use-this': 'error'
-	},
-	overrides: [
-		{
-			files: ['**/*.test.{j,t}s?(x)'],
-			plugins: ['jest'],
-			env: {
-				'jest/globals': true
-			},
-			rules: {
-				'jest/no-disabled-tests': 'warn',
-				'jest/no-identical-title': 'error',
-				'jest/valid-expect': 'error'
-			}
-		},
-		// .js files (including config files in the package root directory) are likely to not be included
-		// in the tsconfig.json file. So we can't parse them with the regular parser as this would fail
-		// as it requires all linted files to be included in tsconfig
-		{
-			files: ['./*.js', './.*.js', '**/*.js', '**/.*.js'],
-			parserOptions: {
-				parser: 'espree'
-			},
-			rules: {
-				'@typescript-eslint/explicit-function-return-type': 'off',
-				'@typescript-eslint/naming-convention': 'off',
-				'import/no-unresolved': 'off'
-			}
-		},
-		// handle storybook config files indentation issues
-		{
-			files: ['./*.stories.js', './.*.stories.js', '**/*.stories.js', '**/.*.stories.js'],
-			parserOptions: {
-				parser: 'espree'
-			},
-			rules: {
-				'@typescript-eslint/indent': 'off',
-				'prettier/prettier': 'off'
-			}
-		}
-	],
-	settings: {
-		'import/resolver': {
-			typescript: {},
-			node: {
-				extensions: ['.js', '.jsx', '.ts', '.tsx']
-			}
-		},
-		'import/parsers': {
-			'@typescript-eslint/parser': ['.ts', '.tsx']
-		}
-	}
-};

package/test.test.js

@@ -1,5 +0,0 @@
-describe('yo', () => {
-	it('works', () => {
-		expect(1).toBe(1);
-	});
-});