@getjerry/prettier-config
Usage
Install
pnpm i -D prettier @getjerry/prettier-config
Set the config in package.json
{
"prettier": "@getjerry/prettier-config"
}
Add scripts in package.json
For example:
{
"scripts": {
"format": "prettier --check .",
"format:fix": "prettier --write ."
}
}
Work together with eslint
:
{
"scripts": {
"lint": "eslint . && prettier --check .",
"lint:fix": "eslint --fix . && prettier --write ."
}
}
Customizations
Create a config file
To customize the config, create a prettier.config.js
file in the root of your project.
With ESM:
// prettier.config.js
import getjerryConfig from '@getjerry/prettier-config';
export default getjerryConfig;
With CJS:
// prettier.config.js
const getjerryConfig = require('@getjerry/prettier-config');
module.exports = getjerryConfig;
Override default config
// prettier.config.js
import getjerryConfig from '@getjerry/prettier-config';
export default {
...getjerryConfig,
// override default rules (not recommended, better to keep prettier config consistent among projects)
quoteProps: 'consistent',
// overrides for specific file patterns when necessary
overrides: [
{
files: ['**/assets/**'],
options: {
quoteProps: 'consistent',
},
},
],
};
Editor Integration
VSCode settings
Add the following settings to your .vscode/settings.json
:
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.insertSpaces": true,
"editor.tabSize": 2,
"files.encoding": "utf8",
"files.eol": "\n",
"files.trimFinalNewlines": true,
"files.trimTrailingWhitespace": true,
"[markdown]": {
"files.trimTrailingWhitespace": false,
},
}