The relative paths to generate.js and log.js in the forge project are hardcoded in the generators

[ms14981]

At the very least, we need a warning comment in the forge project in the log.js and generate.js files.

Can we expose the files more publicly to make the behaviour more explicit? https://docs.npmjs.com/cli/v9/configuring-npm/package-json#files

References:

• const generate = require("../../../openapi-forge/src/generate"); in utils.js in JS generator.
• const generate = require("../../../openapi-forge/src/generate"); in features\support\base.ts in TS generator.
• const log = require("../src/log.js"); in CICD\compareTestResults.js in forge project
• const log = require("../src/log.js"); in CICD\updateWebpage.js in forge project
• path.join(__dirname, "..", "..", generator) in the test-generators command. This enforces the location of the file with this code AND the location of the generators supplied to test-generators.

[ColinEberhardt]

My preference would be to make this more clear, using a combination of using the files property, or additional logging, or similar.

Previously the various paths were passed as CLI args, but this resulted in additional complexity elsewhere - see #141

[ColinEberhardt]

Actually, I think there is a completely different and more conventional approach. Rather than considering these as files, we should consider this part of the public API for openapi-forge. Currently the API is a CLI tool, however, it could also provide a programmatic API.

With this in mind, the conventional approach would be to add an index.js file, which exports the public behaviour, and is pointed to via the main property of the package.json