open-index/open-npm huggingface dataset:
npm package: @nosweat/vue
Description: Testing out a simple Vue plugin
Author: Cody Barr
Latest version: 0.1.2

# @nosweat/vue

@nosweat/vue is a library of components used within the nosweat organization.

# Installation

You can register individual components globally in your main.js file (for certain components like NSOdometer you'll also need to import the relevant CSS file):

```
import { NSOdometer } from '@nosweat/vue'
import '@nosweat/vue/dist/nosweat.css'
Vue.component(NSOdometer)
```

Or directly in your .vue files:

```javascript
import { NSOdometer } from '@nosweat/vue'
export default {
	components: {
		NSOdometer
	}
}
```

```css
<style lang="scss">
@import '@nosweat/vue/dist/nosweat.css';
</style>
```

# Components

`@nosweat/vue` is a library containing many helpful Vue components.

## NSOdometer

Simple vue component wrapper for the `odometer` package. Used for seamlessly transitioning numbers.

### Usage

`<NSOdometer :initial="0" :value="245"/>`

### Options

#### :initial

The initial number seen when the component is first scrolled into view. Defaults to `0`.

#### :value

The value NSOdometer should change to when it is scrolled into view.
npm package: @nosycode/starwars-names
Description: Get random Star Wars names
Author: nosycode
Latest version: 1.5.0

# starwars-names

[![Travis build](https://img.shields.io/travis/com/nosycode/starwars-names?style=flat-square)](https://travis-ci.com/github/nosycode/starwars-names)
[![Codecov coverage](https://img.shields.io/codecov/c/github/nosycode/starwars-names?style=flat-square)](https://codecov.io/github/nosycode/starwars-names)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
[![npm version](https://img.shields.io/npm/v/@nosycode/starwars-names?style=flat-square)](http://npm.im/@nosycode/starwars-names)
[![npm downloads](https://img.shields.io/npm/dm/@nosycode/starwars-names?style=flat-square)](https://npm-stat.com/charts.html?package=%40nosycode%2Fstarwars-names&from=2020-04-06)
[![MIT license](https://img.shields.io/npm/l/@nosycode/starwars-names?style=flat-square)](http://opensource.org/licenses/MIT)
npm package: @not-an-aardvark/node-release-script
Description: Script for automatically generating releases
Author: Teddy Katz
Latest version: 0.1.0

# node-release-script

An opinionated release script

## Usage

```
$ npm install -g @not-an-aardvark/node-release-script
$ node-release-script
```

## What does it do?

Note that this tool is very opinionated, is not intended to be a general-purpose release tool. If you're looking for that, consider using [semantic-release](https://github.com/semantic-release/semantic-release) instead.

This tool does the following:

* Generates a changelog from the git commits since last release
* Updates the version number in `package.json`, according to semantic versioning
* Creates a git commit for the release
* Creates a git tag for the release

Note that this does not push the updates anywhere. You should run `npm publish`, `git push`, and `git push --tag` afterwards to update the remotes.

The updated version number is determined based on the commit messages since the last release. Your commit messages should start one of the following prefixes:

* `Breaking`: semver-major
* `New`: semver-minor
* `Update`: semver-minor
* `Fix`: semver-patch
* `Docs`: semver-patch
* `Build`: semver-patch
* `Upgrade`: semver-patch
* `Chore`: semver-patch

The changelog will include links to issues and commits, based on the `origin` remote URL in your local git repository. To ensure that the links in the changelog work, make sure your remote is called `origin`, it uses the `https:` protocol, and it is linked to an existing reporitory on GitHub.

In order for commits to be added correctly, the changelog must be in a file called `CHANGELOG.md` in the project root. It must start with the text `# Changelog` followed by two linebreaks.

## License

MIT
npm package: @not-govuk/anchor
Description: A drop-in replacement for the 'a' element.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Anchor
=================

A drop in replacement for the HTML `<a>` tag that works with [React Router].


Preview
-------

![Preview][Preview]


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/anchor
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import { A } from '@not-govuk/anchor';

export const MyComponent = props => (
  <A href="#">My link</A>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```


[React Router]: https://reacttraining.com/react-router/
[Preview]: ../../__image_snapshots__/storyshots-itest-ts-image-storyshots-components-anchor-standard-1-snap.png
npm package: @not-govuk/anchor-list
Description: A list of anchors.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Anchor List
======================

A list of anchors. Items that contain links to the current page are
marked as active. Useful for navigation menus.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/anchor-list
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import AnchorList from '@not-govuk/anchor-list';

export const MyComponent = props => (
  <AnchorList items={[
    { href: '/', text: 'Inactive 1' },
    { href: '#main-content', text: 'Active' },
    { href: '/#main-content', text: 'Inactive 2' }
  ]} />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/app-composer
Description: Composes isomorphic React applications from a set of components.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Not Govuk - App Composer
========================

Composes isomorphic React applications from a set of components.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/app-composer
```

Then use it in your client-side code as follows:

```js
import { compose } from '@not-govuk/app-composer';

const MyApp = compose({
  AppWrap,
  ErrorPage,
  LoadingPage,
  PageWrap,
  pageLoader,
  browserRouterProps
});
```

And/or in your server-side code as follows:

```js
import { compose } from '@not-govuk/app-composer';

const MyApp = compose({
  AppWrap,
  ErrorPage,
  PageWrap,
  staticRouterProps
});
```

Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/app-plop-pack
Description: Generators for use within applications and prototypes.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Application plop-pack
================================

Generators for use within applications and prototypes.


Using this package
------------------

First install the package into your project:

```shell
npm install -D @not-govuk/app-plop-pack
```

Then use it in your `plopfile.js` as follows:

```js
module.exports = plop => {
  plop.load('@not-govuk/app-plop-pack');

  // ...
}
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

Build the package by compiling the source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/aside
Description: A component for displaying indirectly related content.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Aside
================

A component for displaying indirectly related content.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/aside
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Aside from '@not-govuk/aside';

export const MyComponent = props => (
  <Aside>
    <h2>Did you know?</h2>
    <p>You can put indirectly related content in an Aside component.</p>
  </Aside>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/asset-proxy
Description: A proxy for serving assets in local-dev environments.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Asset Proxy
======================

A proxy for serving assets in local-dev environments.

It will serve the assets built by webpack according to your `output.publicPath`,
and proxy all other requests to localhost on the next port to the one it is
listening on.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/asset-proxy
```

Then use it in your code as follows:

```js
const proxy = require('@not-govuk/asset-proxy');

const proxy = assetProxy({
  httpd: {
    host: '0.0.0.0',
    port: 8080
  },
  name: 'my-asset-proxy',
  webpackConfig: require('./webpack.config')
});
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/back-link
Description: A component to help users navigate back one page.
Author: Daniel A.C. Martin
Latest version: 0.17.4

Back link
=========

The [GDS Back link component].


Preview
-------

![Preview][Preview]


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/back-link
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import BackLink from '@not-govuk/back-link';

export const MyComponent = props => (
  <BackLink />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```


[GDS Back link component]: https://design-system.service.gov.uk/components/back-link/
[Preview]: ../../__image_snapshots__/storyshots-itest-ts-image-storyshots-components-back-link-text-1-snap.png
npm package: @not-govuk/breadcrumbs
Description: A component to help users to understand where they are within a website's structure and move between levels.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Breadcrumbs
======================

The [GDS Breadcrumbs component].

A component to help users to understand where they are within a website's structure and move between levels.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/breadcrumbs
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Breadcrumbs from '@not-govuk/breadcrumbs';

export const MyComponent = props => (
  <Breadcrumbs
    items={[
      { text: 'Home', href: '#' },
      { text: 'Passports, travel and living abroad', href: '#' },
      { text: 'Travel abroad', href: '#' }
    ]}
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```


[GDS Breadcrumbs component]: https://design-system.service.gov.uk/components/breadcrumbs/
npm package: @not-govuk/button
Description: A component to allow users to carry out an action.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Button
=================

A component to allow users to carry out an action.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/button
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Button from '@not-govuk/button';

export const MyComponent = props => (
  <Button>Save and continue</Button>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/button-group
Description: A component for grouping buttons and links on a single line.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Button Group
=======================

A component for grouping buttons and links on a single line.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/button-group
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import ButtonGroup from '@not-govuk/button-group';

export const MyComponent = props => (
  <ButtonGroup>
    <Button>Save and continue</Button>
    <Button classModifiers="secondary">Save as draft</Button>
    <A href="#">Cancel</A>
  </ButtonGroup>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/checkboxes
Description: A component to allow users to select one or more options.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Checkboxes
=====================

A component to allow users to select one or more options.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/checkboxes
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Checkboxes from '@not-govuk/checkboxes';

export const MyComponent = props => (
  <Checkboxes
    label={<h1 className="govuk-heading-l">Which types of waste do you transport?</h1>}
    name="waste"
    options={[
      { value: 'carcasses', label: 'Waste from animal carcasses' },
      { value: 'mines', label: 'Waste from mines or quarries' },
      { value: 'farm', label: 'Farm or agricultural waste' }
    ]}
    hint="Select all that apply."
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/client-component-helpers
Description: Helper functions for writing client components.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Client Component Helpers
===================================

Helper functions for writing client components.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/client-component-helpers
```

Then use it in your code as follows:

```js
import clientComponentHelpers from '@not-govuk/client-component-helpers';

// WRITEME

```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/client-renderer
Description: A client-side renderer of React applications served via the server-renderer.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Not Govuk - Client Renderer
===========================

A client-side renderer of React applications served via the server-renderer.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/client-renderer
```

Then use it in your code as follows:

```js
import { hydrateOrRender } from '@not-govuk/client-renderer';
import { AppWrap } from '../common/app-wrap';
import { PageWrap } from '../common/page-wrap';
import { ErrorPage } from '../common/error-page';
import { LoadingPage } from '../common/loading-page';
import { pageLoader } from '../common/page-loader';

hydrateOrRender(AppWrap, PageWrap, ErrorPage, LoadingPage, pageLoader);
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/component-helpers
Description: Helper functions for writing components.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Component Helpers
============================

Helper functions for writing components.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/component-helpers
```

Then use it in your code as follows:

```js
import componentHelpers from '@not-govuk/component-helpers';

// WRITEME

```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/component-test-helpers
Description: Helper functions for testing React components.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Not Govuk - Component Test Helpers
==================================

Helper functions for testing React components.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/component-test-helpers
```

Then use it in your code as follows:

```js
import componentTestHelpers from '@not-govuk/component-test-helpers';

// WRITEME

```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/components
Description: React components implementing the GOV.UK Design System.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Components
=====================

An implementation of the [GOV.UK Design System] in [React] that provides
support for writing internal applications in addition to public ones.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/components
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import { Header, Footer } from '@not-govuk/components';

export const MyComponent = props => (
  <Header
    // WRITEME
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```

[GOV.UK Design System]: https://design-system.service.gov.uk/
[React]: https://reactjs.org/
npm package: @not-govuk/cookie-banner
Description: A component to allow users to accept or reject cookies which are not essential to making your service work.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Cookie Banner
========================

A component to allow users to accept or reject cookies which are not essential to making your service work.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/cookie-banner
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import CookieBanner from '@not-govuk/cookie-banner';

export const MyComponent = props => (
  <CookieBanner
    aria-label="Cookies on [name of service]"
    messages={[
      {
        heading: 'Cookies on [name of service]',
        content: (
          <Fragment>
            <p className="govuk-body">We use some essential cookies to make this service work.</p>
            <p className="govuk-body">We’d also like to use analytics cookies so we can understand how you use the service and make improvements.</p>
          </Fragment>
        ),
        actions: (
          <Fragment>
            <Button value="accept" name="cookies">
              Accept analytics cookies
            </Button>
            <Button value="reject" name="cookies">
              Reject analytics cookies
            </Button>
            <A href="#">View cookies</A>
          </Fragment>
        )
      }
    ]}
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/create
Description: A project and prototype initialiser.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Create
=================

A project and prototype initialiser.


Using this package
------------------

Typically you would not install this package but rather call it with
`npx` or `npm init`. Similar to `npm init` this will not initialise Git
or even create a directory for you. We suggest that you set up your
directory with Git and its remote before you start. For example:

```shell
mkdir MY-PROJECT
cd MY-PROJECT
git init
git remote add origin https://github.com/MY-USER/MY-PROJECT.git
```

Once that is set up you can run:

```shell
npm init @not-govuk
```

Follow the prompts to set up your new project.


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/create-internal
Description: A project and prototype initialiser.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Create
=================

A project and prototype initialiser.


Using this package
------------------

Typically you would not install this package but rather call it with
`npx` or `npm init`. Similar to `npm init` this will not initialise Git
or even create a directory for you. We suggest that you set up your
directory with Git and its remote before you start. For example:

```shell
mkdir MY-PROJECT
cd MY-PROJECT
git init
git remote add origin https://github.com/MY-USER/MY-PROJECT.git
```

Once that is set up you can run:

```shell
npm init @not-govuk
```

Follow the prompts to set up your new project.


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/date-input
Description: A component to allow users to enter a date.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Date Input
=====================

A component to allow users to enter a date.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/date-input
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import DateInput from '@not-govuk/date-input';

export const MyComponent = props => (
  <DateInput
    label={<h1 className="govuk-heading-l">When was your passport issued?</h1>}
    name="passport-issued"
    hint="For example, 12 11 2007"
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/details
Description: A component to make a page easier to scan by letting users reveal more detailed information only if they need it.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Details
==================

The [GDS Details component].

Make a page easier to scan by letting users reveal more detailed information only if they need it.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/details
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Details from '@not-govuk/details';

export const MyComponent = props => (
  <Details summary="Help with nationality">
    We need to know your nationality so we can work out which elections you’re entitled to vote in. If you cannot provide your nationality, you’ll have to send copies of identity documents through the post.
  </Details>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```


[GDS Details component]: https://design-system.service.gov.uk/components/details/
npm package: @not-govuk/docs-components
Description: React components for use in documentation.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Not Govuk - Docs Components
===========================

React components for use in documentation.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/docs-components
```

Then use it in your code as follows:

```js
import docsComponents from '@not-govuk/docs-components';

// WRITEME

```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/engine
Description: An engine for running NotGovUK applications.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Engine
=================

An engine for running NotGovUK applications.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/engine
```

Then use it in your code as follows:

```js
const engine = require('@not-govuk/engine');
const { resolve } = require('path');

const isReady = require('./readiness');
const graphQLSchema = require('./graphql');

const AppWrap = require('../common/app-wrap');
const ErrorPage = require('../common/error-page');
const PageWrap = require('../common/page-wrap');
const pageLoader = require('../common/page-loader');

const entrypoints = require('../../dist/public/entrypoints.json');

const app = engine({
  AppWrap,
  ErrorPage,
  PageWrap,
  assets: {
    localPath: resolve(__dirname, '..', '..', 'dist', 'public'),
    publicPath: '/public/',
    entrypoints
  },
  auth: {
    method: AuthMethod.Basic,
    username: 'guest',
    password: 'password',
    roles: [],
    sessionsSecret: 'my-secret'
  }
  env: 'production',
  graphQL: {
    schema: graphQLSchema
  },
  httpd: {
    host: '0.0.0.0',
    port: 8080,
  },
  logger: {
    level: 'info'
  },
  isReady,
  mode: 'server',
  name: 'my-app'
  pageLoader,
  privacy: false,
  ssrOnly: false
});
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/error-message
Description: An error message associated with a form field.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Error Message
========================

An error message associated with a form field.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/error-message
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import ErrorMessage from '@not-govuk/error-message';

export const MyComponent = props => (
  <ErrorMessage>The date your passport was issued must be in the past</ErrorMessage>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/error-summary
Description: A component to summarise any errors a user has made.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Error Summary
========================

A component to summarise any errors a user has made.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/error-summary
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import ErrorSummary from '@not-govuk/error-summary';

export const MyComponent = props => (
  <ErrorSummary
    title="There is a problem"
    items={[
      {
        text: "The date your passport was issued must be in the past",
        href: "#"
      },
      {
        text: "Enter a postcode, like AA1 1AA",
        href: "#"
      }
    ]}
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/express-adapter
Description: Adapts to Express middleware to run on Restify.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Express-Adapter
==========================

Adapts to Express middleware to run on Restify.

This is probably far from perfect, but it works sufficiently for my purposes.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/express-adapter
```

Then use it in your code as follows:

```js
import { adapt } from '@not-govuk/express-adapter';
import { someExpressMiddleware } from '@someone/something;
import { restifyServer } from './my-server.js';

const restifyMiddleware = adapt(someExpressMiddleware);

restifyServer.use(restifyMiddleware);

[...]
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

Build the package by compiling the source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/fieldset
Description: A set of form fields.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - FieldSet
===================

A set of form fields.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/fieldset
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import FieldSet from '@not-govuk/fieldset';

export const MyComponent = props => (
  <FieldSet legend="My fieldset">Content</FieldSet>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/file-upload
Description: A component to help users select and upload a file.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - File Upload
======================

A component to help users select and upload a file.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/file-upload
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import FileUpload from '@not-govuk/file-upload';

export const MyComponent = props => (
  <FileUpload
    id="file-upload-1"
    name="file-upload-1"
    label="Upload a file"
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/footer
Description: A page footer providing copyright, licensing and other information about your service and department.
Author: Daniel A.C. Martin
Latest version: 0.17.4

Footer
======

The [GDS Footer Component]; a page footer providing copyright, licensing
and other information about your service and department.

This has been adapted to also support _not_ including the standard GOV.UK
notices; making this also suitable for non-GOV.UK services.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/footer
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Footer from '@not-govuk/footer';

export const MyComponent = props => (
  <Footer govUK />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```

[GDS Footer component]: https://design-system.service.gov.uk/components/footer
npm package: @not-govuk/form
Description: A component to collect information from the user.
Author: Daniel A.C. Martin
Latest version: 0.17.4

Not Govuk - Form
================

A component to collect information from the user.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/form
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Form from '@not-govuk/form';

export const MyComponent = props => (
  <Form action="/result" method="get">
    <Form.TextInput
      name="fullName"
      label={<h2>What is your name?</h2>}
      hint="Write your firstname followed by your surname"
      validators={[
        required()
      ]}
    />
    <Form.Radios
      name="sex"
      label={<h2>Sex?</h2>}
      options={[
        { value: 'male', label: 'Male' },
        { value: 'female', label: 'Female' },
        { value: 'no', label: 'No thanks, we\'re British' }
      ]}
      validators={[
        required('Provide your sex')
      ]}
    />
    <Form.DateInput
      name="dob"
      prettyName="date of birth"
      label={<h2>What is your date of birth?</h2>}
      validators={[
        required('Provide your date of birth'),
        past(),
        after('1900-01-01')()
      ]}
    />
    <Form.Radios
      name="married"
      label={<h2>Are you married?</h2>}
      options={[
        { value: 'Y', label: 'Yes' },
        { value: 'N', label: 'No' }
      ]}
      validators={[
        required('Provide your marital status')
      ]}
    />
    <Form.Submit value="Submit" />
  </Form>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/form-field
Description: A component for collecting a piece of data from the user.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Form Field
=====================

A component for collecting a piece of data from the user.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/form-field
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import FormField from '@not-govuk/form-field';

export const MyComponent = props => (
  <FormField
    name="name"
    label={<h1 className="govuk-heading-l">What is the name of the event?</h1>}
    hint="The name you’ll use on promotional material."
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/form-group
Description: A group of form fields.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Form Group
=====================

A group of form fields.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/form-group
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import FormGroup from '@not-govuk/form-group';

export const MyComponent = props => (
  <FormGroup
    hint="Enter your date of birth"
    id="dob"
    label="Birthday"
  >
    Content
  </FormGroup>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/forms
Description: An intuitive isometric forms framework for React.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Not Govuk - Forms
=================

An intuitive isometric forms framework for React.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/forms
```

Then use it in your code as follows:

```js
import forms from '@not-govuk/forms';

// WRITEME

```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```
npm package: @not-govuk/head
Description: A React component for altering the contents of the HTML head tag, that works across multiple frameworks.
Author: Daniel A.C. Martin
Latest version: 0.16.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

NotGovUK - Head
===============

A React component for altering the contents of the HTML head tag, that works across multiple frameworks.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/head
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Head from '@not-govuk/head';

export const MyComponent = props => (
  <Head>
    <title>My new title</title>
  </Head>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Building

Build the package by compiling the source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/header
Description: A component that shows users whether they are on GOV.UK and which service they are using.
Author: Daniel A.C. Martin
Latest version: 0.17.4

Header
======

The [GDS Header component] that shows users whether they are on GOV.UK
and which service they are using.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/header
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Header from '@not-govuk/header';

export const MyComponent = props => (
  <Header
    govUK
    navigation={[
      {
        href: "#1",
        text: "Navigation item 1",
        active: true,
      },
      {
        href: "#2",
        text: "Navigation item 2",
      },
      {
        href: "#3",
        text: "Navigation item 3",
      },
      {
        href: "#4",
        text: "Navigation item 4",
      },
    ]}
    organisationHref="#"
    serviceName="Service name"
    serviceHref="#"
  />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```


[GDS Header component]: https://design-system.service.gov.uk/components/header/
npm package: @not-govuk/hint
Description: Hint text for a form field.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Hint
===============

Hint text for a form field.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/hint
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Hint from '@not-govuk/hint';

export const MyComponent = props => (
  <Hint id="field-id-hint">Hint text</Hint>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/input
Description: A component to allow users to enter a small, single piece of data.
Author: Daniel A.C. Martin
Latest version: 0.17.4

NotGovUK - Input
================

A component to allow users to enter a small, single piece of data.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/input
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import Input from '@not-govuk/input';

export const MyComponent = props => (
  <Input name="foo" width="2" />
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

Run the unit tests.

```shell
npm test
```


### Building

Build the package by compiling the TypeScript source code.

```shell
npm run build
```


### Clean-up

Remove any previously built files.

```shell
npm run clean
```
npm package: @not-govuk/inset-text
Description: A block of text that is inset.
Author: Daniel A.C. Martin
Latest version: 0.17.4

Inset Text
==========

A block of text that is inset.


Using this package
------------------

First install the package into your project:

```shell
npm install -S @not-govuk/inset-text
```

Then use it in your code as follows:

```js
import React, { createElement as h } from 'react';
import InsetText from '@not-govuk/inset-text';

export const MyComponent = props => (
  <InsetText>
    It can take up to 8 weeks to register a lasting power of attorney if there are no mistakes in the application.
  </InsetText>
);

export default MyComponent;
```


Working on this package
-----------------------

Before working on this package you must install its dependencies using
the following command:

```shell
pnpm install
```


### Testing

```shell
npm test
```


### Building

```shell
npm run build
```


### Clean-up

```shell
npm run clean
```