sheerlox / import-from-esm Goto Github PK

Description

Add the ability to import an NPM package that contains an index.json file or has a main field pointing to a JSON file.

References

• semantic-release/commit-analyzer#537 (comment)
• semantic-release/semantic-release#3037 (comment)
• sheerlox/semantic-release@4009af3
• https://github.com/semantic-release/semantic-release/blob/02f2cb1c8b0e33b9ed3d7c27038423be61f7a7e0/test/get-config.test.js#L323-L347

Fuzz testing takes a lot of time to run, and decreases the feedback loop of the test workflow running on PRs significantly.

Running it as a separate workflow (e.g. on main commits) would also allow running it for longer, improving its benefits.

Working on: https://github.com/straw-hat-team/nodejs-monorepo/pull/119/files

I had to do the following:

// @ts-expect-error
import importFrom from "import-from-esm";

Since for some reason the type system is confused:

yarn build
src/openapi-web-sdk-generator.ts:2:8 - error TS1192: Module '"/Users/ubi/Developer/github.com/straw-hat-team/nodejs-monorepo/.yarn/cache/import-from-esm-npm-1.2.1-19132a3a23-17275e7d51.zip/node_modules/import-from-esm/index"' has no default export.

2 import importFrom from "import-from-esm";
         ~~~~~~~~~~


Found 1 error in src/openapi-web-sdk-generator.ts:2

Any thoughts?

A good way to test import-from-esm alignment with require's specs would be to validate its outcome against require's outcome using the same parameters (only ignoring ERR_REQUIRED_ESM errors from require).

This library is intended to be an almost drop-in replacement of sindresorhus/import-from (from which it is forked) that supports loading ESM & CJS modules like require() does.

Since import-from uses createRequire() under the hood, it throws the ERR_REQUIRE_ESM error when trying to import a pure ESM module.

The Node.js modules documentation states:

Due to the synchronous nature of require(), it is not possible to use it to load ECMAScript module files. Attempting to do so will throw a ERR_REQUIRE_ESM error. Use import() instead.

Switching from require() to a dynamic import() has a lot of implications, but these are the ones I encountered issues with:

• import() is asynchronous,
• file extensions must be specified for relative path,
• "dependencies (without an explicit path) for a given module are searched for relative to the module loading them" (source).

This library will provide a module loading strategy as close to CJS' as possible, as well as work around the above issues (except the first one, nothing can be done about this).

It's only breaking change from import-from should be adding an await in front of the importFrom() calls, and a .default when importing default exports.

Resources

• CommonJS module resolution strategy: https://nodejs.org/api/modules.html#all-together
• https://www.npmjs.com/package/import-meta-resolve

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Unable to read vulnerability information

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• chore(deps): update dependency @fast-check/ava to v1.2.1
• chore(deps): update dependency knip to v3.8.2
• chore(deps): update dependency tsd to v0.30.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• ci(action): update actions/download-artifact digest to f44cd7b
• ci(action): update actions/setup-node digest to b39b52d
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency ava to v6

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository