feat(config-loader): support a rule written by ESM #187
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
azu
commented
Sep 12, 2021
| import { validateConfig, validateRawConfig } from "@secretlint/config-validator"; | ||
|
|
||
| export function moduleInterop<T>(moduleExports: T): T { | ||
| if (moduleExports && (moduleExports as any).__esModule) { | ||
| return (moduleExports as any).default?.default!; |
There was a problem hiding this comment.
module.exports.default = 1
is default.default.
__esModule is broken mechanism in real CJS/ESM interop.
|
tip: just something that helped me with async imports: const _importDynamic = new Function('modulePath', 'return import(modulePath)')
await _importDynamic('node-fetch') // v3 is esm only |
azu
commented
Sep 13, 2021
|
|
||
| // FIXME: https://github.com/microsoft/TypeScript/issues/43329 | ||
| // module: node12 will be replace it | ||
| const _importDynamic = new Function("modulePath", "return import(modulePath)"); |
There was a problem hiding this comment.
Dynamic Import hack in CommonJS + TypeScript.
There was a problem hiding this comment.
This workaround should be removed in the future
- CSP Issue
- Performance Issue
- Type Issue
|
Yes. We have used |
Closed
This was referenced Sep 14, 2021
Merged
azu
commented
Oct 11, 2021
| @@ -123,7 +120,7 @@ export const loadPackagesFromRawConfig = ( | |||
| // TODO: any to be remove | |||
| const ruleModule: any = replacedDefinition | |||
| ? replacedDefinition.rule | |||
| : moduleInterop(require(moduleResolver.resolveRulePackageName(configDescriptorRule.id))); | |||
| : moduleInterop(await _importDynamic(moduleResolver.resolveRulePackageName(configDescriptorRule.id))); | |||
This was referenced May 24, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, secretlint can not load a rule that is written by ESM.
This PR aims to allow to load secretlint rule as ESM modules.
Blocker
TypeScript does not support
import()in CommonJSimport()when module isCommonJS· Issue #43329 · microsoft/TypeScript__esModuleinterop is broken.We need to pick
.default.default. It is ugly.export cosnt creatorinstead ofexport default#190