Shared configuration presets for eslint.

• @acdh-oeaw/eslint-config: recommended base config for typescript projects
• @acdh-oeaw/eslint-config/strict: enable additional strict rules for typescript projects
• @acdh-oeaw/eslint-config-node: additional recommended config for Node.js projects
• @acdh-oeaw/eslint-config-vue2: additional recommended config for Vue 2 projects
• @acdh-oeaw/eslint-config-vue: additional recommended config for Vue 3 projects
• @acdh-oeaw/eslint-config-nuxt: additional recommended config for Nuxt 3 projects
• @acdh-oeaw/eslint-config-react: additional recommended config for React projects
• @acdh-oeaw/eslint-config-next: additional recommended config for Next.js projects
• @acdh-oeaw/eslint-config-astro: additional recommended config for Astro projects
• @acdh-oeaw/eslint-config-storybook: additional recommended config for Storybook projects
• @acdh-oeaw/eslint-config-playwright: additional recommended config for Playwright projects

npm install -D eslint @acdh-oeaw/eslint-config
# additional configs
npm install -D @acdh-oeaw/eslint-config-vue @acdh-oeaw/eslint-config-nuxt

Add the configs to package.json:

{
	"eslintConfig": {
		"extends": [
			"@acdh-oeaw/eslint-config",
			"@acdh-oeaw/eslint-config-vue",
			"@acdh-oeaw/eslint-config-nuxt"
		]
	}
}

Optionally, enable additional rules, or enable strict preset:

{
	"eslintConfig": {
		"extends": [
			"@acdh-oeaw/eslint-config",
			"@acdh-oeaw/eslint-config/strict",
			"@acdh-oeaw/eslint-config-vue",
			"@acdh-oeaw/eslint-config-nuxt"
		]
	},
	"rules": {
		"@typescript-eslint/require-array-sort-compare": "error",
		"@typescript-eslint/strict-boolean-expressions": "error",
		"@typescript-eslint/explicit-module-boundary-types": "error"
	}
}

Add a script to package.json:

{
	"lint:check": "eslint . --cache --ignore-path .gitignore",
	"lint:fix": "npm run lint:check -- --fix"
}

You can then run npm run lint:check to lint, and npm run lint:fix to fix auto-fixable errors.

npm install -D lint-staged npm-run-all simple-git-hooks

To run the linter on every Git commit, add the following to package.json:

{
	"scripts": {
		"format:check": "prettier . --cache --check --ignore-path .gitignore",
		"format:fix": "npm run format:check -- --write",
		"lint:check": "eslint . --cache --ignore-path .gitignore",
		"lint:fix": "npm run lint:check -- --fix",
		"prepare": "npm run setup",
		"setup": "is-ci || simple-git-hooks",
		"validate": "run-p format:check lint:check"
	},
	"lint-staged": {
		"*.@(cjs|js|mjs|ts|tsx|vue)": ["eslint --cache --fix", "prettier --cache --write"],
		"*": "prettier --cache --ignore-unknown --write"
	},
	"simple-git-hooks": {
		"pre-commit": "npx lint-staged",
		"pre-push": "npm run validate"
	}
}

Install the VS Code vscode-eslint plugin by pressing Ctrl+P and pasting the following command:

ext install dbaeumer.vscode-eslint

Also, make sure to add vscode-eslint to the list of recommended plugins for your project in .vscode/extensions.json:

{
	"recommendations": ["dbaeumer.vscode-eslint"]
}

You may also want to enable "Fix auto-fixable errors on Save" in .vscode/settings.json:

{
	"editor.codeActionsOnSave": {
		"source.fixAll": true
	}
}