@niondigital/eslint-config-base 1.2.0

package/.eslintrc

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

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 nion digital GmbH, Germany
+
+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,20 @@
+# `@niondigital/eslint-config-base`
+
+This package provides an eslint config as used by nion digital as an extensible shared config.
+
+## Installation
+
+```sh
+npx install-peerdeps --dev @niondigital/eslint-config-base
+```
+
+## Usage
+
+Extend local eslint configuration with `@niondigital/eslint-config-base`:
+
+```json
+{
+	"extends": "@niondigital/eslint-config-base",
+	"rules": {}
+}
+```

package/index.js

@@ -0,0 +1,138 @@
+/* eslint-env node */
+module.exports = {
+	extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'eslint-config-airbnb'],
+	parser: '@typescript-eslint/parser',
+	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',
+
+		// naming conventions
+		camelcase: 'off',
+		'@typescript-eslint/naming-convention': [
+			'error',
+			{
+				selector: 'default',
+				format: ['camelCase']
+			},
+			{
+				selector: 'variable',
+				format: ['camelCase', 'UPPER_CASE']
+			},
+			{
+				selector: 'parameter',
+				format: ['camelCase'],
+				leadingUnderscore: 'allow'
+			},
+			{
+				selector: 'memberLike',
+				format: ['camelCase', 'PascalCase', 'UPPER_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']
+	},
+	overrides: [
+		{
+			files: ['**/__tests__/*.{j,t}s?(x)', '**/tests/unit/**/*.spec.{j,t}s?(x)'],
+			env: {
+				jest: true
+			}
+		},
+		// .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/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "@niondigital/eslint-config-base",
+	"version": "1.2.0",
+	"description": "niondigital base eslint config",
+	"keywords": [
+		"eslint",
+		"config",
+		"eslintconfig"
+	],
+	"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-find-rules": "^4.1.0",
+		"eslint-import-resolver-typescript": "^3.6.1",
+		"eslint-plugin-import": "^2.29.1",
+		"eslint-plugin-unused-imports": "^4.1.3",
+		"in-publish": "^2.0.1",
+		"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-import-resolver-typescript": "^3.6.1",
+		"eslint-plugin-import": "^2.29.1"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"gitHead": "0307c2691964ad304f62c86b64872deb1ecf290f"
+}