NEAR Foundation's shareable config for Prettier
In your project, install Prettier and @nearfoundation/near-prettier-config
as dev dependencies:
npm install --save-dev prettier @nearfoundation/near-prettier-config
NEARFoundation's Prettier rules come bundled in @nearfoundation/near-prettier-config
. To enable these rules, add a prettier
property in your project's package.json
.
See the Prettier configuration docs for more details.
"prettier": "@nearfoundation/near-prettier-config"
If you don't want to use package.json
, you can use any of the supported extensions to export a string:
// `.prettierrc.json`
"@nearfoundation/near-prettier-config"
// `prettier.config.js` or `.prettierrc.js`
module.exports = '@nearfoundation/near-prettier-config';
This configuration is not intended to be changed, but if you have a setup where modification is required, it is possible. Prettier does not offer an "extends" mechanism as you might be familiar from tools such as ESLint.
To extend a configuration, you will need to use a prettier.config.js
or .prettierrc.js
file that exports an object:
module.exports = {
...require('@nearfoundation/near-prettier-config'),
semi: false,
};
https://github.com/NEAR-Edu/eslint-config-near is a related repo that is helpful.