@anolilab/prettier-config

Prettier shareable configuration

Package that contains shareable configuration for prettier — a popular opinionated code formatter.

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

Install

npm install --dev-save prettier @anolilab/prettier-config

yarn add -D prettier @anolilab/prettier-config

pnpm add -D prettier @anolilab/prettier-config

Usage

If you don’t have a .prettierrc.js or the other supported file names and .prettierignore, we can create the file for you after installing @anolilab/prettier-config, call pnpm prettier-config:install.

Note: If the script detects an existing .prettierrc.js file, it will not overwrite it.

File content of the `.prettierrc.js`

module.exports = {
    // brackets are required for arrow function parameter, even when there is only one parameter
    arrowParens: "always",
    // spaces are required at the beginning and end of the braces
    bracketSpacing: true,
    // formats quoted code embedded
    embeddedLanguageFormatting: "auto",
    // lf for newline
    endOfLine: "lf",
    // decide whether to break the html according to the display style
    htmlWhitespaceSensitivity: "css",
    // No need to automatically insert @prettier at the beginning of the file
    insertPragma: false,
    // use double quotes instead of single quotes in jsx
    jsxSingleQuote: false,
    // max 160 characters per line
    printWidth: 160,
    // use default break criteria
    proseWrap: "preserve",
    // object's key is quoted only when necessary
    quoteProps: "as-needed",
    rangeEnd: Number.POSITIVE_INFINITY,
    // format the entire contents of the file
    rangeStart: 0,
    // no need to write the beginning @prettier of the file
    requirePragma: false,
    // semicolon at the end of the line
    semi: true,
    // use single quotes
    singleQuote: false,
    // use 4 spaces for indentation
    tabWidth: 4,
    // all comma at the end
    trailingComma: "all",
    // use spaces instead of indentations
    useTabs: false,
    // vue files script and style tags indentation
    vueIndentScriptAndStyle: false,
};

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

License

The anolilab javascript-style-guide is open-sourced software licensed under the MIT license