@binz/config-syncpack/README.md

Shared syncpack config

# Shared syncpack configuration

Format and validate dependencies using [syncpack](https://www.npmjs.com/package/syncpack).

## Setup

- Install `@binz/config-syncpack` and peer dependencies at the monorepo root:

  ```sh
  // install as a workspace reference
  pnpm add -w @binz/config-syncpack syncpack
  // or install as a dev dependency
  pnpm add -D @binz/config-syncpack syncpack
  ```

- Add syncpack configuration file:

  ```js
  // .syncpackrc.js

  module.exports = require('@binz/config-syncpack');
  ```

- Add syncpack scripts:

  ```jsonc
  // package.json

  "scripts": {
    ...
    "syncpack:fix": "syncpack format && syncpack fix-mismatches"
    "syncpack:update": "syncpack update"
    ...
  }
  ```

## Usage

Run repo wide syncpack fix script manually:

```sh
pnpm run syncpack:fix
```

Update monorepo wide dependencies:

```sh
npx syncpack update
pnpm run syncpack:update
```

Guided mode:

```sh
npx syncpack list
```

## References

- https://jamiemason.github.io/syncpack/guide/getting-started/