Fastify plugin generates module with an invalid path

[tajnymag]

🐛 Bug Report

The output of the fastify plugin generates without a separator on Windows 11. Probably a mismatched separator.

To reproduce, I've created a test repository and a test workflow. Compared to #186 this issue happens only windows and not linux.

Reproduction

• repository: https://github.com/tajnymag/openapi-ts-json-schema-poc
• generator: https://github.com/tajnymag/openapi-ts-json-schema-poc/blob/main/test-component-separator-error.cjs
• specification: https://github.com/tajnymag/openapi-ts-json-schema-poc/blob/main/component-separator-error.yaml
• action run: https://github.com/tajnymag/openapi-ts-json-schema-poc/actions/runs/8132010880/job/22221963138

Expected behavior

// File autogenerated with "openapi-ts-json-schema". Do not edit :)

import componentsSchemasHelloWorld from "./componentsschemasHelloWorld";

const componentsSchemasHelloWorldWithId = {
  ...componentsSchemasHelloWorld,
  $id: "/componentsschemasHelloWorld",
} as const;

// Allows json-schema-to-ts to hydrate $refs via the "references" option
export type RefSchemas = [typeof componentsSchemasHelloWorldWithId];

// $ref JSON schemas to be registered with "fastify.addSchema"
export const refSchemas = [componentsSchemasHelloWorldWithId];

// Extra JSON schemas to be registered with "fastify.addSchema"
export const sharedSchemas = [];

Actual behavior

// File autogenerated with "openapi-ts-json-schema". Do not edit :)

import componentsSchemasHelloWorld from "./components/schemas/HelloWorld";

const componentsSchemasHelloWorldWithId = {
  ...componentsSchemasHelloWorld,
  $id: "/componentsschemasHelloWorld",
} as const;

// Allows json-schema-to-ts to hydrate $refs via the "references" option
export type RefSchemas = [typeof componentsSchemasHelloWorldWithId];

// $ref JSON schemas to be registered with "fastify.addSchema"
export const refSchemas = [componentsSchemasHelloWorldWithId];

// Extra JSON schemas to be registered with "fastify.addSchema"
export const sharedSchemas = [];

Run npx envinfo --preset jest

Paste the results here:

System:
    OS: Windows 11 10.0.22631
    CPU: (24) x64 13th Gen Intel(R) Core(TM) i7-13700K
  Binaries:
    Node: 21.6.2 - ~\scoop\apps\nodejs\current\node.EXE
    Yarn: 1.22.19 - ~\scoop\apps\nodejs\current\yarn.CMD
    npm: 10.2.4 - ~\scoop\apps\nodejs\current\npm.CMD
    pnpm: 8.15.3 - ~\scoop\apps\nodejs\current\pnpm.CMD

[toomuchdesign]

Hey @tajnymag,
this library and its dev environment should be now able to run on Windows. I'm releasing soon.

Thanks again for the issues and relevant repros! Feel free to contribute back or open other issues with any real world feedback ✌️

[tajnymag]

Hey @tajnymag, this library and its dev environment should be now able to run on Windows. I'm releasing soon.

Thanks again for the issues and relevant repros! Feel free to contribute back or open other issues with any real world feedback ✌️

Amazing. Thanks a lot! When I get time, I might have a look at extending the fastify plugin.

[toomuchdesign]

Sounds lovely! I intensively use openapi-ts-json-schema on a few real world projects, while the whole plugin part is still a semi-working proof of concept.

The idea behind Fastify plugin was to enable fastify and fastify/swagger to register all the needed schemas one by one and re-expose the OpenApi definition with the registered schemas exposed as components.schemas instead of being inlined as paths definitions.