Added back CommonsJS output under /cjs

[arthurfiorette]

#1922 (comment) removed support for CommonsJS entirely without warnings and a major release. Since a lot of libraries depends on this package, adding a cjs bundle back should be considered.

You may argue that their libraries should migrate to ESM, however, one of the uses cases of this library is to generate json schemas inside a Typescript Plugin which is loaded by the TypeScript CJS source itself and will not be ported to ESM soon (if ever).

[arthurfiorette]

The main ts-json-schema-generator.ts file imported package.json to get its version, I was required to do that step as a post-process operation because I couldn't get the same ts source code transpiled into (cjs/esm) to work.

https://github.com/vega/ts-json-schema-generator/actions/runs/9105923115/job/25032310451#step:7:997

[domoritz]

I don't like this as it makes it harder to watch build. The cjs version used to work so can you try to make the import version work here as well?

[arthurfiorette]

I tried a lot but ran out of choices.

• import pkg from 'package.json' (or * as pkg) works in cjs but not in ESM as it requires a with {type: 'json'} statement

• require('package.json') works but not in ESM mode.

• using const _require = typeof require === 'undefined' ? createRequire(import.meta.url) : require should work but breaks in CJS even if createRequire(import.meta.url) does not gets executed.

• using fs.readFileSync requires __dirname (which can be created using import.meta.url in esm but breaks just like the above try) and a second build step to manually copy package.json to dist/cjs folders.

• Trying to bypass import.meta.url using `eval('import.meta.url') does not work.

I'm not sure if there's any other way to fix it without replacing the dist code. Also, as it gets built on CI before publishing, all official releases should work just as fine.

[arthurfiorette]

After all, the only thing I can say is:

Welcome to the hell of maintaining ESM/CJS modularity in modern JavaScript.

[domoritz]

True. I've wasted too many days with bundling and packaging stuff.

[arthurfiorette]

is there anything left?

[domoritz]

replaced by #1964