Skip to content

Commit 0d92812

Browse files
committed
Update READMEs
1 parent 4c6c5fa commit 0d92812

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
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:
44

5-
* [💀 Resolution failed](./docs/problems/NoResolution.md)
6-
* [❌ No types](./docs/problems/UntypedResolution.md)
7-
* [🎭 Masquerading as CJS](./docs/problems/FalseCJS.md)
8-
* [👺 Masquerading as ESM](./docs/problems/FalseESM.md)
9-
* [⚠️ ESM (dynamic import only)](./docs/problems/CJSResolvesToESM.md)
10-
* [🐛 Used fallback condition](./docs/problems/FallbackCondition.md)
11-
* [🤨 CJS default export](./docs/problems/CJSOnlyExportsDefault.md)
12-
* [❗️ Incorrect default export](./docs/problems/FalseExportDefault.md)
13-
* [❓ Missing `export =`](./docs/problems/MissingExportEquals.md)
14-
* [🚭 Unexpected module syntax](./docs/problems/UnexpectedModuleSyntax.md)
15-
* [🥴 Internal resolution error](./docs/problems/InternalResolutionError.md)
5+
- [💀 Resolution failed](./docs/problems/NoResolution.md)
6+
- [❌ No types](./docs/problems/UntypedResolution.md)
7+
- [🎭 Masquerading as CJS](./docs/problems/FalseCJS.md)
8+
- [👺 Masquerading as ESM](./docs/problems/FalseESM.md)
9+
- [⚠️ ESM (dynamic import only)](./docs/problems/CJSResolvesToESM.md)
10+
- [🐛 Used fallback condition](./docs/problems/FallbackCondition.md)
11+
- [🤨 CJS default export](./docs/problems/CJSOnlyExportsDefault.md)
12+
- [❗️ Incorrect default export](./docs/problems/FalseExportDefault.md)
13+
- [❓ Missing `export =`](./docs/problems/MissingExportEquals.md)
14+
- [🚭 Unexpected module syntax](./docs/problems/UnexpectedModuleSyntax.md)
15+
- [🥴 Internal resolution error](./docs/problems/InternalResolutionError.md)
16+
- [🕵️‍♂️ Named exports](./docs/problems/NamedExports.md)
1617

1718
## CLI
1819

packages/cli/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ A CLI for [arethetypeswrong.github.io](https://arethetypeswrong.github.io/).
44

55
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:
66

7-
* [💀 Resolution failed](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md)
8-
* [❌ No types](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md)
9-
* [🎭 Masquerading as CJS](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md)
10-
* [👺 Masquerading as ESM](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md)
11-
* [⚠️ ESM (dynamic import only)](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSResolvesToESM.md)
12-
* [🐛 Used fallback condition](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FallbackCondition.md)
13-
* [🤨 CJS default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSOnlyExportsDefault.md)
14-
* [❗️ Incorrect default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseExportDefault.md)
15-
* [❓ Missing `export =`](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/MissingExportEquals.md)
16-
* [🚭 Unexpected module syntax](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UnexpectedModuleSyntax.md)
17-
* [🥴 Internal resolution error](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md)
7+
- [💀 Resolution failed](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md)
8+
- [❌ No types](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md)
9+
- [🎭 Masquerading as CJS](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md)
10+
- [👺 Masquerading as ESM](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md)
11+
- [⚠️ ESM (dynamic import only)](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSResolvesToESM.md)
12+
- [🐛 Used fallback condition](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FallbackCondition.md)
13+
- [🤨 CJS default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSOnlyExportsDefault.md)
14+
- [❗️ Incorrect default export](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseExportDefault.md)
15+
- [❓ Missing `export =`](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/MissingExportEquals.md)
16+
- [🚭 Unexpected module syntax](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UnexpectedModuleSyntax.md)
17+
- [🥴 Internal resolution error](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md)
18+
- [🕵️‍♂️ Named exports](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md)
1819

1920
## Installation
2021

@@ -170,6 +171,7 @@ The available values are:
170171
- `unexpected-module-syntax`
171172
- `missing-export-equals`
172173
- `internal-resolution-error`
174+
- `named-exports`
173175

174176
In the CLI: `--ignore-rules`
175177

0 commit comments

Comments
 (0)