@enke.dev/lint

Install packages

Make sure to install the necessary peer dependencies:

npm i -D @enke.dev/lint eslint prettier @awmottaz/prettier-plugin-void-html

For Typescript support, additionally install:

npm i -D jiti typescript typescript-eslint

Prepare Eslint config

Create a eslint.config.js (or eslint.config.ts) file in the root of your project and add the following content:

import config from '@enke.dev/lint';

export default config;

[!NOTE] Using Typescript may requires the root directory where to find the tsconfig.json to be specified.
Therefore, a convenience function setTsConfigRootDir is provided to configure this option globally.

Extending a config

For example for setting up the Typescript parser, you can extend the base config like this:

import config, { setTsConfigRootDir } from '@enke.dev/lint';

export default defineConfig([
  // extend the base config
  ...config,
  // configure typescript parser to your needs
  setTsConfigRootDir(import.meta.dirname),
]);

[!TIP] Extending configurations works the same way with all other configs provided by this package.

Using Monorepos

The VSCode Eslint plugin can be configured to pick up packages correctly by updating your settings.json, e.g.:

{
  "eslint.workingDirectories": ["./packages/*"]
}

Prepare Prettier config

A shared prettier configuration can be used by creating a prettier.config.js (or prettier.config.ts) file in the root of your project with the following content:

import config from '@enke.dev/lint/prettier.config.js';

export default config;

Prepare Stylelint config (experimental)

Uses some common presets and can be used in CSS, SASS and SCSS files.
It will enforce a specific property order and specific custom property prefixes if configured.

As this is totally opt-in, all necessary dependencies must be installed first:

npm i -D @enke.dev/lint stylelint stylelint-config-rational-order stylelint-config-standard-scss stylelint-order

Create a stylelint.config.js file in the root of your project and add the following content:

// @ts-check

import { defineConfig } from '@enke.dev/lint/stylelint.config.js';

export default defineConfig({ cssCustomPropertyPrefix: 'your-prefix' });

For now, no TypeScript support is possible.

Development

This repo self-tests the configuration by linting itself: npm run lint.
Therefore, a text.config.ts is used.

And additionally, a naive test is in place to check that the linter actually finds issues: npm run test.
It uses the native Node test runner against some obviously faulty code in the test directory.