@royalnavy/eslint-config-react

ESLint Config React

This package provides the Royal Navy ESLint and Prettier configuration.

ESLint

ESLint statically analyzes your code to quickly find problems. ESLint is built into most text editors and you can run ESLint as part of your continuous integration pipeline.

Prettier

Prettier is an opinionated code formatter. It removes original styling and ensures that all outputted code conforms to a consistent style.

Installation

The Royal Navy ESLint config is available as an NPM package.

// npm
npm install @royalnavy/eslint-config-react

// yarn
yarn add @royalnavy/eslint-config-react

In the root of your project create the following files:

.eslintrc.js

module.exports = {
  extends: ['@royalnavy/eslint-config-react'],
}

.prettier.config.js

module.exports = require('@royalnavy/eslint-config-react/prettier.config.js')

Questions

The Design System is maintained by a team at the Royal Navy. If you want to know more about the Royal Navy Design System, please email the Design System Team.

Documentation

The documentation website contains all the information you need to build your application using the Royal Navy Design System.

Contributing

The contributing guide resource presents information about our development process.

Changelog

If you have recently updated then read the release notes

Roadmap

The Design System Roadmap Board contains the work that has been prioritised for the next 12 months.

License

The Royal Navy Design System is licensed under the Apache License 2.0.