Skip to content

AZMAG/mag-prettier-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mag-prettier-config

GitHub release (latest SemVer) GitHub Release Date GitHub last commit GitHub issues Libraries.io dependency status for GitHub repo npm semver GitHub license

This is Maricopa Association of Governments (MAG) shareable Prettier config for use in project files. This module defines standard Prettier rules for code formatting to help format the code in all of our projects.

🔑 Keywords

config prettier prettier-config prettierrc prettierconfig code-style style-guide mag

⚙️ Installation

Install this Prettier config together with its peer dependencies:

Install with npm

$ npm i mag-prettier-config --save-dev
Install with yarn

$ yarn add mag-prettier-config --dev

Peer Dependencies

Peer dependencies need to be installed in order to make it work properly.

  • Prettier is an opinionated code formatter.

    Install with npm

    $ npm i prettier --save-dev
    Install with yarn

    $ yarn add prettier --dev

  • eslint-config-prettier turns off all rules that are unnecessary or might conflict with Prettier

    Install with npm

    $ npm i eslint-config-prettier --save-dev
    Install with yarn

    $ yarn add eslint-config-prettier --dev

Usage

Once you have installed the module and its peer dependencies you will need to add this reference to your package.json

{
  "prettier": "mag-prettier-config",
  "eslintConfig": {
      "extends": ["prettier"]
    },
}

Previously, rules had been defined directly in a .prettierrc or package.json

Any previous .prettierrc should be removed in favor of the shared config.

Options

Prettier ships with a handful of format options.

Prettier Options

Current Options

{
  "$schema": "http://json.schemastore.org/prettierrc",
  "printWidth": 100,
  "tabWidth": 2,
  "useTabs": false,
  "singleQuote": false,
  "trailingComma": "all",
  "endOfLine": "lf",
  "semi": false,
  "bracketSameLine": true,
  "bracketSpacing": true,
  "htmlWhitespaceSensitivity": "css",
  "arrowParens": "always"
}
Prettier rules

This project defines the following settings in the file.

Rule Value*
printWidth 100
tabWidth 2
useTabs false
singleQuote false
trailingComma all
endOfLine lf
semi false
bracketSameLine true
bracketSpacing true
htmlWhitespaceSensitivity css
arrowParens always

* Values in bold differ from the Prettier defaults.

If you change any options, it’s recommended to do it via the configuration file.

Version

version | 1.1.2

  • Updated | 2024-07-30

  • Created | 2021-11-08

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  1. MAJOR version when you make incompatible API changes bumps the major resets minor and patch
  2. MINOR version when you add functionality in a backwards-compatible manner bumps the minor resets patch
  3. PATCH version when you make backwards-compatible bug fixes and misc changes bumps only the patch

Technologies

A list of technologies used within the project:

Prettier ESLint npm vscode

⭐ Credits

Maricopa Association of Governments (MAG) and the MAG member agencies

⚡ Disclaimer

⚠️ Licensing

Copyright 2021 Maricopa Association of Governments (MAG)

This project is licensed under the MIT license.

GitHub license

(Back to top)