@laozhu/prettier-config
Shareable @prettier config of @laozhu.
Installation
# Install with npx
$ npx install-peerdeps --dev @laozhu/prettier-config
# Install with NPM
$ npm i -D @laozhu/prettier-config prettier
# Install with yarn
$ yarn add --dev @laozhu/prettier-config prettier
Usage
After installation, you have two methods to use this configuration.
The first method
Create a .prettierrc.js
or prettier.config.js
file in your project root, then require this package in the file.
module.exports = require('@laozhu/prettier-config');
You can also overwrite any properties in this configuration.
module.exports = {
...require('@laozhu/prettier-config'),
proseWrap: 'never',
};
The second method
If your project have a package.json
file, add "prettier" key in your this file.
{
"name": "my-cool-project-name",
"version": "1.0.0",
"prettier": "@laozhu/prettier-config"
}
Note: This method does not offer a way to extend the configuration to overwrite some properties from the shared configuration. If you need to do that, use the first method.
Use with vscode
Search and install a vscode extension prettier, then add extension settings in vscode settings file.
{
// Prettier
"prettier.printWidth": 100,
"prettier.tabWidth": 2,
"prettier.useTabs": false,
"prettier.semi": true,
"prettier.singleQuote": true,
"prettier.quoteProps": "as-needed",
"prettier.jsxSingleQuote": false,
"prettier.trailingComma": "all",
"prettier.bracketSpacing": true,
"prettier.jsxBracketSameLine": false,
"prettier.arrowParens": "avoid",
"prettier.proseWrap": "preserve",
"prettier.htmlWhitespaceSensitivity": "css",
"prettier.endOfLine": "lf",
"prettier.requireConfig": true,
// Work together with eslint and stylelint
"prettier.eslintIntegration": true,
"prettier.stylelintIntegration": true,
"prettier.disableLanguages": ["javascript", "typescript", "javascriptreact", "typescriptreact"]
}
Ignoring files
If you don't want prettier to format some files of your project, create a .prettierignore
file in your project root, then add these files or directories in this file, it's the same as writing a .gitignore
file.
License
MIT