syncpack icon indicating copy to clipboard operation
syncpack copied to clipboard

docs: add cookbook to the readme

Open JamieMason opened this issue 3 years ago • 0 comments
trafficstars

Description

There are some examples scattered around:

  • https://github.com/JamieMason/syncpack/releases/tag/6.2.0
  • https://github.com/JamieMason/syncpack/releases/tag/6.1.0
  • https://github.com/JamieMason/syncpack/pull/64#issuecomment-1003592729

Suggested Solution

Add a Cookbook section of examples to README.md, something roughly like this:

👨🏻‍🍳 Cookbook

Use loose semver ranges for `devDependencies` only, with the rest of the repo using the default setting.

Some explanation here

{
  "semverGroups": [
    {
      "dependencies": ["**"],
      "dependencyTypes": ["devDependencies"],
      "packages": ["**"],
      "semverRange": "^"
    }
  ]
}
Force the version of `jest` to `*` (latest) for the whole monorepo, but only within `peerDependencies`

Some explanation here

{
  "versionGroups": [
    {
      "dependencies": ["jest"],
      "dependencyTypes": ["peerDependencies"],
      "packages": ["**"],
      "pinVersion": "*"
    }
  ]
}

JamieMason avatar Jan 03 '22 17:01 JamieMason