How to compose generators in our own ESM-based generator

[springcomp]

I’m authoring a custom ESM generator using TypeScript.
I’m having a hard time finding documentation for composing existing generator.

Is there any documentation available ?
Is this possible ? If so how one would achieve such features.

I have created a simple generator-readme to demonstrate the issue I have.

I’m having a hard time trying to compose with the existing generator-license generator:

  public async default() {

    if (this.options.license) {
      console.log(import.meta.url);
      const path = resolve('generator-license', import.meta.url);
      console.log(path);
      const licenseOpts: LicenseOptions = {
        publish: false,
      };
      this.composeWith<GeneratorLicense>('license', [], licenseOpts);
    }
  }

[mshima]

• composeWith is async, you need to await it.
• is generator-license registered. If it’s not you can composeWith the resolved path.

[mshima]

• composeWith is async, you need to await it.
• is generator-license registered? If it’s not you can composeWith the resolved path.

[springcomp]

• composeWith is async, you need to await it.
• is generator-license registered? If it’s not you can composeWith the resolved path.

Would you please help me out ?

I have not been able to make your suggestions work.
It still fails with a error:

You don’t seem to have a generator with the name "undefined" installed.

  public async default() {

    if (this.options.license) {
      const path = resolve('generator-license', import.meta.url);
      const licenseOpts: LicenseOptions = {
        publish: false,
      };
      await this.composeWith<GeneratorLicense>(path, licenseOpts);
    }
  }

I would like to compose with an embedded generator included as a dependency, rather than relying on the user having to install the required generator themselves.

[mshima]

If path is an url you should convert to file path.

[springcomp]

If path is an url you should convert to file path.

path is a file system path that points to the generator-license library under the node_modules/ folder.

[mshima]

I don’t know if you understood, but resolve return is an url.
See https://www.npmjs.com/package/import-meta-resolve#use
It’s file://* you should convert to file path.

[springcomp]

Hello @mshima thanks for clarifying.

I have indeed converted the file:// URL to a local path.
However, that still does not work.
In fact, it turns out that the composeWith method really expects a URL with a file:// scheme.
So the error remains.

import { fileURLToPath } from 'node:url';
…
  public async default() {

    if (this.options.license) {
      const path = resolve('generator-license', import.meta.url);
      const localPath = fileURLToPath(path);
      console.log(localPath);
      const licenseOpts: LicenseOptions = {
        publish: false,
      };
      await this.composeWith<GeneratorLicense>(localPath, licenseOpts);
    }
  }

I’m still having a hard time figuring out how to compose generators.

[github-actions]

This issue is stale because it has been open with no activity. Remove stale label or comment or this will be closed