@zeitonline/eslint-config
v3.1.1
Published
Common eslint config for DIE ZEIT
Readme
@zeitonline/eslint-config
This package provides a shared Eslint configuration for projects at DIE ZEIT.
This is an ESM-only package.
Installation & Usage
1. Install the package
For example using npm:
npm install --save-dev @zeitonline/eslint-config2. Create or update the eslint.config.js file
Add an eslint.config.js (or .ts) file to the root of your project and extend the shared configuration. You can choose to use the base configuration or the Svelte-specific configuration:
Base Config
Intended for all JS or TS projects.
For JavaScript Projects (Default)
import zonEslintConfig from '@zeitonline/eslint-config';
export default [
...zonEslintConfig, // or zonEslintConfig.js
{
// Add your project-specific overrides here
},
];For TypeScript Projects
import zonEslintConfig from '@zeitonline/eslint-config';
export default [
...zonEslintConfig.ts,
{
// Add your project-specific overrides here
},
];Svelte Config
Intended for Svelte or SvelteKit projects. This config extends the base config and adds Svelte-specific plugins and rules.
For JavaScript Svelte Projects (Default)
import zonEslintConfigSvelte from '@zeitonline/eslint-config/svelte';
export default [
...zonEslintConfigSvelte, // or zonEslintConfigSvelte.js
{
// Add your project-specific overrides here
},
];For TypeScript Svelte Projects
import zonEslintConfigSvelte from '@zeitonline/eslint-config/svelte';
export default [
...zonEslintConfigSvelte.ts,
{
// Add your project-specific overrides here
},
];Type-Aware Rules
Use .tsTypeChecked instead of .ts (base and Svelte) to enable the type-aware rules of typescript-eslint. Run ESLint from the folder containing your tsconfig.json.
.ts no longer creates type information for Svelte files, so type-aware Svelte rules such as svelte/no-unused-props do nothing there. Use .tsTypeChecked to keep them.
In SvelteKit, run svelte-kit sync before linting, otherwise ./$types resolve as any. TS files outside your tsconfig.json (e.g. vitest.setup.ts) fail to parse; add them to include.
Vitest Config
Install @vitest/eslint-plugin and add ...zonEslintConfigVitest from @zeitonline/eslint-config/vitest to your config.
To also ignore everything in your .gitignore, add includeIgnoreFile() from @eslint/compat.
3. (Optional) Add a lint script to your package.json
To conveniently lint your files you may add a new script to your package.json:
{
"scripts": {
"lint": "eslint ."
}
}