https://github.com/x-govuk/govuk-prototype-filters

Prototype with data using helpful template filters.
https://github.com/x-govuk/govuk-prototype-filters

government govuk govuk-prototype-kit nunjucks project prototyping

Last synced: 27 days ago
JSON representation

Prototype with data using helpful template filters.

• Host: GitHub
• URL: https://github.com/x-govuk/govuk-prototype-filters
• Owner: x-govuk
• License: mit
• Created: 2023-01-26T16:36:24.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T10:52:36.000Z (about 1 month ago)
• Last Synced: 2024-09-26T20:45:55.485Z (about 1 month ago)
• Topics: government, govuk, govuk-prototype-kit, nunjucks, project, prototyping
• Language: JavaScript
• Homepage: https://x-govuk.github.io/govuk-prototype-filters/
• Size: 1.03 MB
• Stars: 6
• Watchers: 3
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# GOV.UK Prototype Filters · [![test](https://github.com/x-govuk/govuk-prototype-filters/actions/workflows/test.yml/badge.svg)](https://github.com/x-govuk/govuk-prototype-filters/actions/workflows/test.yml)

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

```shell

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](https://x-govuk.github.io/govuk-prototype-filters/get-started/).

## Contributing

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

We use [StandardJS](https://standardjs.com) to ensure code follows [the GDS way](https://gds-way.cloudapps.digital/manuals/programming-languages/js.html). Use `npm run lint` to check your code before submitting a pull request.

## Testing

```shell

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.