diff --git a/README.md b/README.md index a66f4b4..ccb180e 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,18 @@ This project attempts to analyze npm package contents for issues with their TypeScript types, particularly ESM-related module resolution issues. Packages can be explored via the [website](https://arethetypeswrong.github.io) or [CLI](./packages/cli). The following kinds of problems can be detected in the `node10`, `node16`, and `bundler` module resolution modes: -* [๐Ÿ’€ Resolution failed](./docs/problems/NoResolution.md) -* [โŒ No types](./docs/problems/UntypedResolution.md) -* [๐ŸŽญ Masquerading as CJS](./docs/problems/FalseCJS.md) -* [๐Ÿ‘บ Masquerading as ESM](./docs/problems/FalseESM.md) -* [โš ๏ธ ESM (dynamic import only)](./docs/problems/CJSResolvesToESM.md) -* [๐Ÿ› Used fallback condition](./docs/problems/FallbackCondition.md) -* [๐Ÿคจ CJS default export](./docs/problems/CJSOnlyExportsDefault.md) -* [โ—๏ธ Incorrect default export](./docs/problems/FalseExportDefault.md) -* [โ“ Missing `export =`](./docs/problems/MissingExportEquals.md) -* [๐Ÿšญ Unexpected module syntax](./docs/problems/UnexpectedModuleSyntax.md) -* [๐Ÿฅด Internal resolution error](./docs/problems/InternalResolutionError.md) +- [๐Ÿ’€ Resolution failed](./docs/problems/NoResolution.md) +- [โŒ No types](./docs/problems/UntypedResolution.md) +- [๐ŸŽญ Masquerading as CJS](./docs/problems/FalseCJS.md) +- [๐Ÿ‘บ Masquerading as ESM](./docs/problems/FalseESM.md) +- [โš ๏ธ ESM (dynamic import only)](./docs/problems/CJSResolvesToESM.md) +- [๐Ÿ› Used fallback condition](./docs/problems/FallbackCondition.md) +- [๐Ÿคจ CJS default export](./docs/problems/CJSOnlyExportsDefault.md) +- [โ—๏ธ Incorrect default export](./docs/problems/FalseExportDefault.md) +- [โ“ Missing `export =`](./docs/problems/MissingExportEquals.md) +- [๐Ÿšญ Unexpected module syntax](./docs/problems/UnexpectedModuleSyntax.md) +- [๐Ÿฅด Internal resolution error](./docs/problems/InternalResolutionError.md) +- [๐Ÿ•ต๏ธโ€โ™‚๏ธ Named exports](./docs/problems/NamedExports.md) ## CLI diff --git a/packages/cli/README.md b/packages/cli/README.md index 08cf38d..d7de7f0 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -4,17 +4,18 @@ A CLI for [arethetypeswrong.github.io](https://arethetypeswrong.github.io/). This project attempts to analyze npm package contents for issues with their TypeScript types, particularly ESM-related module resolution issues. The following kinds of problems can be detected in the `node10`, `node16`, and `bundler` module resolution modes: -* [๐Ÿ’€ Resolution failed](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md) -* [โŒ No types](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md) -* [๐ŸŽญ Masquerading as CJS](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md) -* [๐Ÿ‘บ Masquerading as ESM](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md) -* [โš ๏ธ ESM (dynamic import only)](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSResolvesToESM.md) -* [๐Ÿ› Used fallback condition](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FallbackCondition.md) -* [๐Ÿคจ CJS default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSOnlyExportsDefault.md) -* [โ—๏ธ Incorrect default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseExportDefault.md) -* [โ“ Missing `export =`](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/MissingExportEquals.md) -* [๐Ÿšญ Unexpected module syntax](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UnexpectedModuleSyntax.md) -* [๐Ÿฅด Internal resolution error](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md) +- [๐Ÿ’€ Resolution failed](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md) +- [โŒ No types](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md) +- [๐ŸŽญ Masquerading as CJS](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md) +- [๐Ÿ‘บ Masquerading as ESM](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md) +- [โš ๏ธ ESM (dynamic import only)](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSResolvesToESM.md) +- [๐Ÿ› Used fallback condition](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FallbackCondition.md) +- [๐Ÿคจ CJS default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSOnlyExportsDefault.md) +- [โ—๏ธ Incorrect default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseExportDefault.md) +- [โ“ Missing `export =`](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/MissingExportEquals.md) +- [๐Ÿšญ Unexpected module syntax](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UnexpectedModuleSyntax.md) +- [๐Ÿฅด Internal resolution error](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md) +- [๐Ÿ•ต๏ธโ€โ™‚๏ธ Named exports](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md) ## Installation @@ -170,6 +171,7 @@ The available values are: - `unexpected-module-syntax` - `missing-export-equals` - `internal-resolution-error` +- `named-exports` In the CLI: `--ignore-rules`