Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.7 KB

readme.md

File metadata and controls

29 lines (20 loc) · 1.7 KB

@ahdcreative/prettier-config-ahdPrettier

@ahdcreative/prettier-config-ahd on npm CI status License: MIT

Shareable prettier config, following AHD Creative code style

Usage

Our default export contains all of our Prettier rules, along with specific plugins for SCSS syntax.

  1. Run npm install prettier @ahdceative/prettier-config-ahd --save-dev
  2. Add "extends": "@ahdcreative/prettier-config-ahd" to your .prettierrc

Install

  • Required Node
  • We recommend using nvm
  • Clone the project on to your computer
  • Run nvm install to ensure you have the correct Node version
  • Run npm install to install project dependencies
  • Ensure your editor is set up to use editorconfig, Prettier, Eslint and Stylelint

Development

  • Run nvm use to set Node to the correct version
  • Run tests via npm run test
  • Run linting via npm run lint
  • Run preflight checks before committing final code via npm run preflight