@hmcts/one-per-page

One per page

A framework that aims to make building GOV.UK style one question per page transactions easy.

Documentation

All documentation is stored in the [docs] folder.

Development

Prerequisites

Docker

time of writing this version 17.09.0-ce

Build and enter your docker development container

We use the Dockerfile and docker-compose.yml to create a development container used for running tests, etc.

To start the container run:

make

to see whats happening with this command see the Makefile.

Install dependencies

yarn install

Build the library

Once in the docker container shell, to build the library you can run: yarn

Example application

There is a straw man application in examples/test-app in this repository that you can use to manually test as you change this repository. When doing this it is recommended you use link this repository to the example using yarn link.

Creating a live link (one-per-page dev)

If you want to work on developing one-per-page with a test application, you can create a live link so changes to this repository by running: yarn link

Changelog

2.0.0 (2017-12-21)

• Add a list field that wraps other fields (f2a8743)
• Add bool.default for setting the default value (9cf17e0)
• Add convert to map values from one form to another (e2bfa8c)
• Allow only running specific tests (it.only) (0238b34)
• Allow users of FieldDescriptor to change what value field it produces (628e1df)
• Collect FieldValue classes in same module (e5d6efb)
• Collect some common reduce and map operations to reuse them easier (b05e394)
• Consume new fields for all basic fields (a47b691)
• Demo validating a fields converted value (c0a6eb7)
• Enable object field validation and mapping errors (7ae9660)
• Ensure that transformed object fields still expose their child fields (ad1821e)
• Expose new field interfaces (2bbd1d6)
• Prevent mutating the base field descriptor (744f7a4)
• Provide mappedErrors needed for summarising the errors (f56c80a)
• Refactor compoundField to subclass from FieldDescriptor (61a74a2)
• Refactor fieldDescriptor so you can return FieldValue from your functions (e4fb96d)
• Reimplement compoundField as object fieldDescriptor (34e8046)
• Reimplement date field using new convert and object fields (0e7ec76)
• Reimplement Form to support new field approach (cc69e6b)
• Reimplement ref field in new approach (b34f89b)
• Remove complexity from mapping the entries in an object (a771d17)
• Remove now unused formProxyHandler (854f20f)
• Remove value from answers block as its not used anymore (b20a352)
• Rename underlying field to better describe it (18d78ae)
• Replace old form interface with our new one (f199ce9)
• Rewrite fields to separate declaration of a field and the parsed value (0cd434e)
• Simplify cloning a field descriptor (e55de7b)
• Split fieldValue.test.js as it was too long (340ca08)
• Split FilledForm and Form in to their own packages (17888e6)
• Test date field (009cfec)
• Update list to parse from BodyParsers output (66e5e2c)
• Fix: Moment accepts months 0-indexed but parses them as you'd expect (0f91129)

<a name="2.0.0-5"></a>