No description
Find a file
Severin Kaderli 71aae357c9
Update README.md
Signed-off-by: Severin Kaderli <severin@kaderli.dev>
2024-01-26 22:55:04 +01:00
.gitignore Initial commit 2024-01-26 21:02:04 +01:00
.prettierrc.json Initial commit 2024-01-26 21:02:04 +01:00
LICENSE Add README and LICENSE 2024-01-26 21:17:46 +01:00
package.json Bump version to 1.0.2 2024-01-26 21:21:26 +01:00
README.md Update README.md 2024-01-26 22:55:04 +01:00

Install

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

Configure

Add the configuration in the package.json file:

{
  "prettier": "@severinkaderli/prettier-config"
}

CI

The formatting can be checked using the following job in GitHub-compatible workflows.

check-format:
    name: Check formatting
    runs-on: ubuntu-latest
    steps:
        -   name: Checkout the repository
            uses: actions/checkout@v4

        -   name: Install Node.js
            uses: actions/setup-node@v3
            with:
                node-version: 20

        -   name: Add custom npm package registry
            run: npm config set @severinkaderli:registry https://git.kaderli.dev/api/packages/severinkaderli/npm/

        -   name: Install dependencies
            run: npm ci

        -   name: Check formatting
            run: npm run format:check