prettier-config-atomic

The Prettier configuration used in atom-community.

This configuration supports all the formats including typescript, javascript, json, yaml, and markdown.

Installation

npm install --save-dev prettier-config-atomic

Either add the following to your .npmrc if using pnpm to hoist the prettier bundled with the config

public-hoist-pattern[]=*

Or install prettier yourself in your devDependencies.

If using npm, the prettier dependency is hoisted automatically.

Usage

Add the following to your package.json

"prettier": "prettier-config-atomic",
"scripts": {
  "format": "prettier --write .",
  "test.format": "prettier . --check"
}

and run npm run format to format the files. You can also use npm run test.format in the CI to test formatting of the project.

To ignore some files from formatting, create a .prettierignore file and add the files to the list. This is usually the same as gitignore.

node_modules
pnpm-lock.yaml
package-lock.json
CHANGELOG.md
dist

Notice that the built folders like dist are in the above list.

Modifying the config

Instead of adding the prettier entry to package.json, create a prettier.config.js file at the root of the project with the following content:

module.exports = {
  ...require("prettier-config-atomic"),

  // add the modifications here:

  // an example:
  // semi: true,
}

GitHub Action Lint Job:

Lint:
  if: "!contains(github.event.head_commit.message, '[skip ci]')"
  runs-on: ubuntu-latest
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: 0
    - name: Commit lint ✨
      uses: wagoid/commitlint-github-action@v2

    - name: Install dependencies
      run: npm install

    - name: Format ✨
      run: npm run test.format

    - name: Lint ✨
      run: npm run test.lint