format
Sort package.json fields into a predictable order and nested fields alphabetically.
Options
Section titled “Options”--check
Section titled “--check”Lint formatting instead of fixing it and exit with a status code of 1 if issues are found.
syncpack format --check
--config <file-path>
Section titled “--config ”syncpack
searches the monorepo root directory for a config file which follows its naming convention, but this can be overridden by providing a path to a specific configuration file instead.
The only requirement is that the file must have a file extension and that it is one of .cjs
, .cts
, .js
, .json
, .mjs
, .mts
, .ts
, .yaml
, or .yml
.
syncpack format --config ./config/syncpack.json
--dry-run
Section titled “--dry-run”Cause syncpack to behave identically as when applying fixes, but never writing to disk.
syncpack format --dry-run
--log-levels <comma-separated-log-level-names>
Section titled “--log-levels ”Control how detailed the log output should be
Level | What is written to this channel |
---|---|
info | The standard output which forms syncpack's UI, including lint issues |
warn | Possible mistakes in your setup, or highlights of known gaps in syncpack |
error | Fatal exceptions or errors outside the normal running of syncpack |
debug | Extremely verbose detail on why syncpack assigns each status code |
# Turn off logging completely
syncpack format --log-levels off
# Only show verbose debugging logs
syncpack format --log-levels debug
# Show everything
syncpack format --log-levels error,warn,info,debug
--no-ansi
Section titled “--no-ansi”Syncpack will print colours and clickable hyperlinks to the terminal using ANSI escape code unless this option is set.
syncpack format --no-ansi
--source <file-pattern>
Section titled “--source ”Only run syncpack format
on package.json files matching the provided pattern(s).
Syncpack will look in the following places for glob patterns matching package.json files, in this order of precedence, and stop looking when a match is found:
- If
--source
CLI options are provided, use those. - If
source
is defined in configuration, use that. - If using npm workspaces or Yarn workspaces, read
workspaces
from./package.json
. - If using pnpm, read
packages
from./pnpm-workspace.yaml
. - If using Lerna, read
packages
from./lerna.json
. - Default to
'package.json'
and'packages/*/package.json'
.
# only the root package
syncpack format --source 'package.json'
# only packages matching a glob
syncpack format --source 'packages/beta-*'
# multiple values can be provided
syncpack format --source 'package.json' --source 'packages/beta-*'
--help
Section titled “--help”Display a list of CLI options and other help information.
# Display a short summary of commands and options
syncpack format -h
# Display full help with examples
syncpack format --help