Latest version 18.1.0 overwriting pnpm-workspace.yaml

[zhm]

I see there was support added for pnpm workspaces, which is awesome. A couple behaviors that were unexpected for me:

• It overwrites pnpm-workspace.yaml and I end up with a pnpm-workspace.yaml that's actually a JSON file. Is this intentional?
• It doesn't seem to respect "named catalogs".

Example, I have this at the bottom of my pnpm-workspace.yaml for an expo/mobile project where I want these dependencies. In package.json I use catalog:mobile, and other projects like the web app I just use catalog:.

catalogs:
  mobile:
    query-string: 7.1.3
    tailwindcss: ^3.4.17

But it upgrades those dependencies anyways. (e.g. upgrades tailwind to v4)

[raineorshine]

Hi, thanks for reporting.

@jakeboone02 Could you look into this please?

[jakeboone02]

Yep, will do.

[jakeboone02]

@raineorshine Before 18.1.0, this library didn't write any YAML files, it only read them. It uses the js-yaml library, which is fine for reading YAML data but is lossy when it comes to formatting and comments. So even if we write the pnpm-workspace.yaml file in proper YAML syntax, it could still make diffs unnecessarily complicated and ugly, plus any comments would be completely removed.

I'm thinking about swapping out js-yaml (which hasn't seen meaningful activity since 2021) for yaml (newest release 1 month ago). This would allow ncu to make minimal changes to the pnpm-workspace.yaml file. This would make for cleaner diffs and avoid loss of information.

Any thoughts or other recommendations before I proceed?

[raineorshine]

npm-check-updates is very careful about only replacing version numbers in package.json, not rewriting the whole file. I didn't think about this for the pnpm-workspace.yaml file, but I think a similar policy would be advisable.

[jakeboone02]

Right, I definitely want to make the fewest changes possible to the file. My question was whether you were ok with me replacing the js-yaml package with yaml. I'll go ahead and do it in my PR to fix this issue and you can review it then.

[raineorshine]

Yes, I'm okay with that.