Skip to main content

Update formatting config action

This action copies the formatting configuration files from the build tools into the project. It overwrites the project's existing files. Use it to keep a project's formatting rules in sync with the build tools.

aptuitiv-build update-formatting-config

The following files are copied into the project root:

  • .editorconfig
  • .prettierignore
  • .prettierrc.cjs

Any other Prettier configuration files, like .prettierrc, .prettierrc.json, or prettier.config.js, are removed so that they don't conflict with the .prettierrc.cjs file.

Prettier also reads configuration from the prettier key in the package.json file, and that takes precedence over .prettierrc.cjs. The package.json file isn't changed, but you'll see a warning if it has a prettier key.

The init action also adds these files, but by default it only adds files that don't already exist. Use the --update-formatting-config option with the init action to overwrite them.

The update config action also updates these files, along with the package.json, .gitignore, and LICENSE files. It doesn't remove other Prettier configuration files.