fix

Fix every autofixable issue found by syncpack lint.

Examples

# Only fix issues in dependencies and devDependencies
syncpack fix --dependency-types prod,dev
# Only fix inconsistencies with exact versions (eg "1.2.3")
syncpack fix --specifier-types exact
# Only fix issues in "react" specifically
syncpack fix --dependencies react
# See more examples
syncpack fix --help
# See a short summary of options
syncpack fix -h

Options

* ! { } etc

When passing values to syncpack via the command line, remember to add quotes around values containing special characters so your shell does not interpret them.

--config <file-path>

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 fix --config ./config/syncpack.json

--dependencies <dependency-name-pattern>

Include dependencies whose name matches the given glob pattern.

To exclude, put a ! at the start of your query.

# Exact match for "react"

syncpack fix --dependencies 'react'

# Substring match for "react"

syncpack fix --dependencies '**react**'

# All dependencies under the AWS SDK scope

syncpack fix --dependencies '@aws-sdk/**'

# Exact match for "react" or "webpack" (2 approaches)

syncpack fix --dependencies 'react' --dependencies 'webpack'
syncpack fix --dependencies '{react,webpack}'

# Substring match for "react" or "webpack" (2 approaches)

syncpack fix --dependencies '**react**' --dependencies '**webpack**'
syncpack fix --dependencies '**{react,webpack}**'

--dependency-types <comma-separated-dependency-type-names>

Include dependencies of the given dependency types and/or custom types.

To exclude, put a ! at the start of your query.

# devDependencies only

syncpack fix --dependency-types dev

# dependencies and devDependencies only

syncpack fix --dependency-types dev,prod

# everything except peerDependencies

syncpack fix --dependency-types '!peer'

--log-levels <comma-separated-log-level-names>

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 fix --log-levels off

# Only show verbose debugging logs

syncpack fix --log-levels debug

# Show everything

syncpack fix --log-levels error,warn,info,debug

--no-ansi

Syncpack will print colours and clickable hyperlinks to the terminal using ANSI escape code unless this option is set.

syncpack fix --no-ansi

--show <comma-separated-detail-names>

Control what information is displayed in terminal output

Name	Description
instances	Show every instance of every dependency
hints	Show a hint alongside dependencies developed in this repo
statuses	Show specifically how/why a dependency or instance is valid or invalid
all	Shorthand to enable all of the above
none	Shorthand to disable all of the above

# Only opt into showing status codes

syncpack fix --show statuses

# Show all instances, not just their names

syncpack fix --show instances

# Show highest level of detail

syncpack fix --show all

# Show lowest level of detail

syncpack fix --show none

--sort <choice>

Change the order in which dependencies are displayed

# Sort by count, in descending order

syncpack fix --sort count

# Sort A-Z by name

syncpack fix --sort name

--source <file-pattern>

Only run syncpack fix 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:

1. If --source CLI options are provided, use those.
2. If source is defined in configuration, use that.
3. If using npm workspaces or Yarn workspaces, read workspaces from ./package.json.
4. If using pnpm, read packages from ./pnpm-workspace.yaml.
5. If using Lerna, read packages from ./lerna.json.
6. Default to 'package.json' and 'packages/*/package.json'.

# only the root package
syncpack fix --source 'package.json'

# only packages matching a glob

syncpack fix --source 'packages/beta-*'

# multiple values can be provided

syncpack fix --source 'package.json' --source 'packages/beta-*'

--specifier-types <comma-separated-specifier-type-names>

Include only instances whose version specifiers are of the given specifier types.

To exclude, put a ! at the start of your query.

# Exact versions only

syncpack fix --show instances --specifier-types exact

# Missing or unsupported versions

syncpack fix --show instances --specifier-types missing,unsupported

# Latest or workspace protocol only

syncpack fix --show instances --specifier-types latest,workspace-protocol

--help

Display a list of CLI options and other help information.

# Display a short summary of commands and options

syncpack fix -h

# Display full help with examples

syncpack fix --help