X-GOVUK ESLint Config

Common ESLint configuration for X-GOVUK projects.

It is loosely based on the configuration proposed for use by GOV.UK Frontend.

Requirements

Node.js v22.22.0 or later.

Installation

npm install @x-govuk/eslint-config

Usage

See the ESLint documentation on combining configs. Example:

import xGovukConfig from "@x-govuk/eslint-config";

export default [
  ...xGovukConfig,
  {
    ignores: ["foo", "bar.js"],
  },
];

Contributing

Bug reports and feature requests are welcome. Please raise an issue or submit a pull request.

Releasing a new version

Update the version field in package.json and merge this change to main.

Then, create a new release using the GitHub web interface, using a tag in the form vX.Y.Z matching the new version (for example v1.2.3) and targeting main. Publishing the release pushes the tag, which triggers the publish workflow to publish the new version to NPM.

[!NOTE] Releasing a new version requires permission to publish packages to the @x-govuk organisation.