@x-govuk/govuk-prototype-filters

GOV.UK Prototype Filters ·

Use this GOV.UK Prototype Kit plugin to add helpful filters to Nunjucks templates. Rapidly modify and transform data while ensuring it follows the GOV.UK style guide.

Requirements

Node.js v18 or later.

Installation

npm install @x-govuk/govuk-prototype-filters

Usage

If you are using version 13 or later of the GOV.UK Prototype Kit, the filters will be immediately available for use in Nunjucks templates.

Learn more about how to get started.

Contributing

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

We use StandardJS to ensure code follows the GDS way. Use npm run lint to check your code before submitting a pull request.

Testing

npm test

Use npm run coverage to check code coverage.

Releasing a new version

npm run release

This command will ask you what version you want to use. It will then publish a new version on NPM, create and push a new git tag and then generate release notes ready for posting on GitHub.

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