prettier

Check the formatting of a project with Prettier. The task runs in a node container and is skipped when the sources and the Prettier configuration are unchanged.

Install firstCopy Anchor Link

The task runs the tool from node_modules, and a container task only sees the files it declares and the outputs of its dependencies, so the install must be a dependency. Include the entry of your package manager (npm, yarn or pnpm) and extend the task to add it, which works with any of them and keeps the entry free of a package manager:

includes:
  npm:
    git: https://github.com/no0dles/hammerkit.git
    ref: v1.22.0
    path: catalog/npm
  prettier:
    git: https://github.com/no0dles/hammerkit.git
    ref: v1.22.0
    path: catalog/prettier

tasks:
  format:
    extend: prettier:check
    deps: [npm:install]

extend keeps the entry's image, sources and commands and adds the dependency (see extending).

TasksCopy Anchor Link

InputsCopy Anchor Link

Writing the formattingCopy Anchor Link

The entry only checks. A task that rewrites its own sources cannot be cached, so there is no --write task; run npx prettier --write on your machine when you want one. The configuration is read from a .prettierrc* file; a project that keeps it in package.json needs no extra step, because that file is read too.

The entryCopy Anchor Link

# Checks the formatting of a project with Prettier. The project's own dependencies must be
# installed first, see the page of this entry.
envs:
  # tag of the node image prettier runs in
  NODE_VERSION: 24
  # folder with the sources to check, relative to the working directory
  SOURCE_DIR: src

tasks:
  check:
    description: check the formatting of the sources with prettier
    image: node:${NODE_VERSION}-alpine
    src: [package.json, '.prettierrc*', '${SOURCE_DIR}']
    cmds:
      - node_modules/.bin/prettier --check ${SOURCE_DIR}