pnpm catalog fails to parse version in package.json #1965

yutakobayashidev · 2025-03-10T10:34:13Z

When using Orval with the catalog feature of pnpm workspace, an error occurs because it cannot parse the version in package.json.

{
  "name": "test",
  "dependencies": {
    "@tanstack/react-query": "catalog:"
  }
}

packages:
  - packages/*

catalog:
  "@tanstack/react-query": "^5.67.2"

~/pnpm-test/packages/test$ pnpm orval
🍻 Start orval v7.6.0 - A swagger client generator for typescript
🛑 petstore - Error: Invalid argument not valid semver ('catalog:' received)

I tried to modify the code so that it parses the pnpm-workspace.yaml, extracts the catalog version, and maps it to package.json as follows. What do you think? There might be adjustments needed, like handling cases where a name is not found in the catalog and retaining the original 'catalog:'. If everything looks good, I can create a pull request.

interface PnpmWorkspace {
  packages?: string[];
  catalog?: Record<string, string>;
}

const loadPnpmWorkspace = async (
  workspace = process.cwd(),
): Promise<PnpmWorkspace | undefined> => {
  const workspacePath = await findUp(['pnpm-workspace.yaml'], {
    cwd: workspace,
  });

  if (!workspacePath) {
    return undefined;
  }

  try {
    const content = await fs.readFile(workspacePath, 'utf8');
    return yaml.load(content) as PnpmWorkspace;
  } catch {
    return;
  }
};

const replaceCatalogReferences = (
  pkg: PackageJson,
  catalog: Record<string, string>,
): PackageJson => {
  const replaceDependencies = (
    deps?: Record<string, string>,
  ): Record<string, string> | undefined => {
    if (!deps) return undefined;

    const newDeps: Record<string, string> = {};
    for (const [name, version] of Object.entries(deps)) {
      if (typeof version === 'string' && version === 'catalog:') {
        newDeps[name] = catalog[name] || version;
      } else {
        newDeps[name] = version;
      }
    }
    return newDeps;
  };

  return {
    ...pkg,
    dependencies: replaceDependencies(pkg.dependencies),
    devDependencies: replaceDependencies(pkg.devDependencies),
    peerDependencies: replaceDependencies(pkg.peerDependencies),
  };
};

export const loadPackageJson = async (
  packageJson?: string,
  workspace = process.cwd(),
): Promise<PackageJson | undefined> => {

  const pkgPath = packageJson
    ? normalizePath(packageJson, workspace)
    : await findUp(['package.json'], { cwd: workspace });

  if (!pkgPath || !fs.existsSync(pkgPath)) {
    return;
  }

  const pkg = await import(pkgPath);

  const pnpmWorkspace = await loadPnpmWorkspace(workspace);
  const catalog = pnpmWorkspace?.catalog;

  if (!catalog) {
    return pkg;
  }

  return replaceCatalogReferences(pkg, catalog);
};

The text was updated successfully, but these errors were encountered:

yutakobayashidev · 2025-03-10T10:38:39Z

duplicate #1931

yutakobayashidev · 2025-03-10T10:50:03Z

I used version 7.6.0, but the issue persists. The catalog is used in multiple dependencies.

🛑 petstore - Oups... 🍻. An Error occurred while writing file => Error: Invalid argument not valid semver ('catalog:' received)

melloware · 2025-03-10T11:43:50Z

@shotanue can you confirm?

shotanue · 2025-03-10T17:40:24Z

7.6.0 seems to have fixed the issue I reported in #1931.
@melloware, Thank you for addressing it.

Here's my orval.config.ts that I'm using:

import { defineConfig } from "orval";
export default defineConfig({
  xxxxx: {
    input: "xxxxx/openapi.yaml",
    output: {
      mode: "split",
      client: "react-query",
      target: "xxxxxx",
      override: {
        query: {
          useSuspenseQuery: true,
+          version: 5,
        },
        mutator: {
          path: "./src/custom-instance.ts",
          name: "customInstance",
        },
      },
    },
  },
});

When using pnpm catalogs, it appears that specifying override.query.version = 5 is necessary.
I tried removing this option in 7.6.0, and it resulted in a "not valid semver" error.
It functions as a workaround for errors related to the pnpm catalogs protocol.
This may differ from the option's original purpose, though. 🤔

yutakobayashidev · 2025-03-10T19:49:18Z

I tried that workaround, but when there are other dependencies managed by the catalog, a slightly different error occurs. In #1931, it was not an error related to file writing. The issue is resolved and works fine by applying a patch that resolves the catalog version mentioned in the first comment.

🛑 petstore - Oups... 🍻. An Error occurred while writing file => Error: Invalid argument not valid semver ('catalog:' received)

melloware · 2025-03-10T19:50:25Z

@shotanue any thoughts?

shotanue · 2025-03-11T00:47:22Z

I apologize for not reading the issue body thoroughly.
This issue was actually a proposal for catalog support.

I did not come up with alternative workarounds.

As an Orval user, it would be better if Orval supported pnpm catalogs due to the current limitations that sometimes require workarounds, which don't always work reliably.

The proposal to support pnpm catalogs with sanitizing package.json is a good idea 👍 If it supported https://pnpm.io/catalogs#named-catalogs, it would make for an even better implementation.

The proposed solution could be applicable beyond react-query, eliminating the need for workarounds, which would be a great improvement for Orval.

melloware · 2025-03-11T05:42:43Z

Reopened. I know nothing about PNPM and catalog so this will most likely require a PR from a user...

arthurfiorette · 2025-03-12T20:39:40Z

Puting packageJson: 'fake', in options supresses this issue.suppresses

fernion · 2025-03-24T18:38:22Z

Just to add that on version 7.7.0 of Orval, in a monorepo using pnpm and catalogs, if the typescript dependency is specified as "catalog:" then it fails with the error:
Oups... 🍻. An Error occurred while splitting => Error: Invalid argument not valid semver ('catalog:' received)

Seems a related issue to this.

Puting packageJson: 'fake', in options supresses this issue.suppresses

This workaround circumvents the error, but the generated code is a lot different.

AllieJonsson · 2025-03-25T21:41:48Z

I have added a fix for this, but as I dont use pnpm myself I have a few questions:

Does pnpm fall back to using the default catalog if a package is not defined in a named catalog?
Do we need an option for specifying where your pnpm-workspace.yaml is located? Afaict from the docs it should always be in the root of your project?

fernion · 2025-03-26T14:27:11Z

Does pnpm fall back to using the default catalog if a package is not defined in a named catalog?
No, it will fail with an error No catalog entry 'some-package-name' was found for catalog 'customcatalog'.

Do we need an option for specifying where your pnpm-workspace.yaml is located? Afaict from the docs it should always be in the root of your project?
I believe this is correct (from the docs and from the usages I have seen).

yutakobayashidev closed this as completed Mar 10, 2025

yutakobayashidev reopened this Mar 10, 2025

melloware added the bug Something isn't working label Mar 10, 2025

melloware added this to the 7.6.0 milestone Mar 10, 2025

melloware added the workaround A workaround has been provided label Mar 10, 2025

melloware assigned shotanue Mar 10, 2025

melloware closed this as completed Mar 10, 2025

melloware reopened this Mar 11, 2025

melloware added enhancement New feature or request and removed bug Something isn't working workaround A workaround has been provided labels Mar 11, 2025

melloware removed this from the 7.6.0 milestone Mar 13, 2025

melloware added the good first issue Good for newcomers label Mar 13, 2025

AllieJonsson linked a pull request Mar 25, 2025 that will close this issue

feat(core): add support for pnpm catalogs #1989

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pnpm catalog fails to parse version in package.json #1965

pnpm catalog fails to parse version in package.json #1965

yutakobayashidev commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025 •

edited

Loading

melloware commented Mar 10, 2025

shotanue commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025 •

edited

Loading

melloware commented Mar 10, 2025

shotanue commented Mar 11, 2025

melloware commented Mar 11, 2025

arthurfiorette commented Mar 12, 2025

fernion commented Mar 24, 2025 •

edited

Loading

AllieJonsson commented Mar 25, 2025

fernion commented Mar 26, 2025

pnpm catalog fails to parse version in package.json #1965

pnpm catalog fails to parse version in package.json #1965

Comments

yutakobayashidev commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025 • edited Loading

melloware commented Mar 10, 2025

shotanue commented Mar 10, 2025

yutakobayashidev commented Mar 10, 2025 • edited Loading

melloware commented Mar 10, 2025

shotanue commented Mar 11, 2025

melloware commented Mar 11, 2025

arthurfiorette commented Mar 12, 2025

fernion commented Mar 24, 2025 • edited Loading

AllieJonsson commented Mar 25, 2025

fernion commented Mar 26, 2025

yutakobayashidev commented Mar 10, 2025 •

edited

Loading

yutakobayashidev commented Mar 10, 2025 •

edited

Loading

fernion commented Mar 24, 2025 •

edited

Loading