feat(pnpm): add support for pnpm catalogs

[StefanWerW]

Question

Is it possible to use with pnpm catalog? https://pnpm.io/catalogs

When I ran fix-mismatches, it overwrote the catalog: declarations, and I could not find anything in the docs or code.

Code of Conduct

• I agree to follow the Code of Conduct

[JamieMason]

Hey @StefanWerW,
It is not supported currently. Speaking honestly purely just so you or someone else reading this is not waiting around, I'm not likely to support this any time soon, at least not until more package managers support it.

I know some projects have replaced syncpack with catalogs entirely, so that might be an option depending on what it is you need. I don't know what you can do with catalogs that you can't do in a syncpack config file, but that's not to say there isn't anything, just that I haven't found it yet.

Thanks a lot.

[StefanWerW]

Okay, good to know.

Thank you!

[mackermans]

+1 for supporting pnpm catalogs 🙏 I did solve it for my simple use case with a little scripting: I have syncpack enforce the use of catalog: for those dependencies listed in the default catalog in pnpm-workspace.yaml.

Here's my .syncpackrc.js, in case it helps anyone (maybe @StefanWerW):

// @ts-check
import { readFileSync } from 'node:fs'
import { parse } from 'yaml'

const getPnpmCatalogDependencies = () => {
  const workspaceConfig = readFileSync('pnpm-workspace.yaml', 'utf8')
  const pnpmWorkspaceConfig = parse(workspaceConfig)

  return Object.keys(pnpmWorkspaceConfig.catalog)
}

/** @type {import("syncpack").RcFile} */
const config = {
  versionGroups: [
    {
      label: 'Enforce pnpm default catalog',
      dependencies: getPnpmCatalogDependencies(),
      dependencyTypes: ['!local'],
      pinVersion: 'catalog:',
    },
    // rest of config...
  ],
}

export default config

By the way, I greatly value your work here @JamieMason, syncpack is incredible. It has saved me and my team so much trouble. ❤

[stanjhae]

#258 (comment)

This is good and great timing! I migrated my project from npm to pnpm and had this same issue.
Quick question, how do I use this script?

[JamieMason]

@stanjhae you would put that code into your syncpack config file, the config file must be a JavaScript or TypeScript file, exactly like the .syncpackrc.js @mackermans shared.

Because it is your config file, when you run syncpack it will be read. You don't need to run the script separately. 100% of what you need is in @mackermans code snippet.

[Airkro]

Syncpack can pin catalog, but can't lint catalog, maybe you guys should reopen this issue.

[JamieMason]

@Airkro could you explain more what you mean? I think I addressed this in this comment but maybe one of us is missing something?

[Airkro]

I using Syncpack to pin dependencies as catalog for a long time, but if run syncpack lint, it won't pass:

✘ name prop-types or version catalog: are not supported src\package.json > dependencies [UnsupportedMismatch]

[JamieMason]

Sure thing @Airkro,
It is not supported currently. Speaking honestly purely just so you or someone else reading this is not waiting around, I'm not likely to support this any time soon, at least not until more package managers support it.

I know some projects have replaced syncpack with catalogs entirely, so that might be an option depending on what it is you need. I don't know what you can do with catalogs that you can't do in a syncpack config file, but that's not to say there isn't anything, just that I haven't found it yet.

Thanks a lot.

[lentil32]

https://bun.sh/docs/install/catalogs
FYI, Bun now supports catalog from 1.2.14.