Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewbranch committed Sep 6, 2024
1 parent 4c6c5fa commit 0d92812
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
24 changes: 13 additions & 11 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -170,6 +171,7 @@ The available values are:
- `unexpected-module-syntax`
- `missing-export-equals`
- `internal-resolution-error`
- `named-exports`

In the CLI: `--ignore-rules`

Expand Down

0 comments on commit 0d92812

Please sign in to comment.