Rocketmakers prettier config

Package to return prettier config based on a set of internally defined standards. Full Documentation

Installation

Run the following to install the package as a dev dependency:

npm i --save-dev @rocketmakers/prettier-config

Once you have installed @rocketmakers/prettier-config you do not need to install any other formatting package, such as prettier, as these will be installed as transitive dependencies and you will still be able to run npx prettier ... successfully.

Config setup

This package has a dependency on prettier, as a result you do not need to install it directly.

Create a prettier.config.js file in the directory you intend to run prettier from, with the following contents:

// prettier.config.js
module.exports = require('@rocketmakers/prettier-config');

This will initialise prettier with the Rocketmakers agreed formatting rules. Although there are other methods of consuming a shared prettier configuration, the inclusion of a prettier.config.js works best when integrating with @rocketmakers/eslint to produce formatting warnings/errors in linting output. The above method also respects any ignore patterns you include within a .prettierignore file and is respected by VScode prettier plugins.

Formatting

Run the following scripts to format your code:

# return errors
npx prettier . --check

# fix formatting errors
npx prettier . --write

Ignore files

.prettierignore files are respected when using the above setup.