https://github.com/arethetypeswrong/arethetypeswrong.github.io

Tool for analyzing TypeScript types of npm packages
https://github.com/arethetypeswrong/arethetypeswrong.github.io

Last synced: about 2 months ago
JSON representation

Tool for analyzing TypeScript types of npm packages

• Host: GitHub
• URL: https://github.com/arethetypeswrong/arethetypeswrong.github.io
• Owner: arethetypeswrong
• License: mit
• Created: 2023-01-27T01:41:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-22T21:55:03.000Z (2 months ago)
• Last Synced: 2024-07-31T04:01:55.922Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://arethetypeswrong.github.io
• Size: 24.7 MB
• Stars: 1,044
• Watchers: 11
• Forks: 36
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - arethetypeswrong/arethetypeswrong.github.io - Tool for analyzing TypeScript types of npm packages (TypeScript)

README

        
# [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. 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)

## CLI

You can check packages on disk with [`@arethetypeswrong/cli`](https://npmjs.com/@arethetypeswrong/cli). See [its README](./packages/cli/README.md) for usage.

## Contributing

Contributions are welcome! Take a look at the open issues or read about [how to contribute to open source](https://opensource.guide).