Qumu ESLint Config

Qumu ESLint configuration.

Usage

1. Install the package

npm i -D @enghouse-qumu/eslint-config

2. Create an eslint.config.js file in the root of your project

Use following code as a starting point:

import { defineConfig } from 'eslint/config';
import { javascript, astro, markdown, typescript } from './index.js';

export default defineConfig([
  {
    extends: [javascript],
    files: ['**/*.js'],
  },
  {
    extends: [typescript],
    files: ['**/*.ts'],
  },
  {
    extends: [astro],
    files: ['**/*.astro'],
  },
  {
    extends: [markdown],
    files: ['**/*.md'],
  },
]);

If you don't use Astro or Markdown, you can remove those sections.

3. Override rules (optional)

You can override any rules by adding a rules property to your eslint.config.js file. For example:

import { defineConfig } from 'eslint/config';
import { javascript } from './index.js';

export default defineConfig([
  {
    extends: [javascript],
    files: ['**/*.js'],
    rules: {
      'no-console': 'off', // Disable no-console rule
    },
  },
]);

4. Skip linting specific files or directories (optional).

The configuration already ignores the most common files and folders (see ignores.js) but you can ignore more files/folders by doing the following:

import { defineConfig } from 'eslint/config';
import { javascript } from './index.js';

export default defineConfig([
  {
    extends: [javascript],
    files: ['**/*.js'],
  },
  {
    ignores: ['do-no-parse/**'],
  },
]);

Generate a new package

To generate a new Github package, all you have to do is run npm version <major|minor|patch> on the master branch.

This will generate a new tag that will then trigger the Package github action and create a release and publish to Github package.