rsbuild-plugin-arethetypeswrong 0.0.0 → 0.1.0

package/README.md

@@ -10,6 +10,10 @@ Rsbuild plugin for checking TypeScript type definitions with [arethetypeswrong](
   <a href="https://npmcharts.com/compare/rsbuild-plugin-arethetypeswrong?minimal=true"><img src="https://img.shields.io/npm/dm/rsbuild-plugin-arethetypeswrong.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
 </p>
 
+`rsbuild-plugin-arethetypeswrong` is the perfect partner for [Rslib](https://github.com/web-infra-dev/rslib). When building a library, arethetypeswrong helps you to analyze TypeScript types of the package to improve its compatibility with different module resolutions.
+
+<img width="1000" height="761" alt="image" src="https://github.com/user-attachments/assets/cce68a0d-baac-45c5-8b59-9e7999932e1c" />
+
 ## Usage
 
 Install:
@@ -18,10 +22,9 @@ Install:
 npm add rsbuild-plugin-arethetypeswrong -D
 ```
 
-Add plugin to your `rsbuild.config.ts`:
+Add plugin to your `rslib.config.ts` or `rsbuild.config.ts`:
 
 ```ts
-// rsbuild.config.ts
 import { pluginAreTheTypesWrong } from "rsbuild-plugin-arethetypeswrong";
 
 export default {
@@ -31,20 +34,81 @@ export default {
 
 ## Options
 
-### foo
+### enable
+
+Whether to enable arethetypeswrong.
+
+- Type: `boolean`
+- Default: `true`
 
-Some description.
+For example, only run arethetypeswrong in the CI environment:
+
+```ts
+pluginAreTheTypesWrong({
+  enable: Boolean(process.env.CI),
+});
+```
+
+### areTheTypesWrongOptions
+
+Options for arethetypeswrong. See [arethetypeswrong - Configuration](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/packages/cli/README.md#configuration) for more details.
+
+- Type:
+
+```ts
+interface areTheTypesWrongOptions {
+  ignoreRules?: ProblemFlag[];
+  ignoreResolutions?: ResolutionKind[];
+  summary?: boolean;
+  emoji?: boolean;
+}
+
+type ProblemFlag =
+  | "no-resolution"
+  | "untyped-resolution"
+  | "false-cjs"
+  | "false-esm"
+  | "cjs-resolves-to-esm"
+  | "fallback-condition"
+  | "cjs-only-exports-default"
+  | "named-exports"
+  | "false-export-default"
+  | "missing-export-equals"
+  | "unexpected-module-syntax"
+  | "internal-resolution-error";
+
+type ResolutionKind = "node10" | "node16-cjs" | "node16-esm" | "bundler";
+```
+
+- Default:
+
+```js
+const defaultOptions = {
+  ignoreRules: [];
+  ignoreResolutions: [];
+  summary: true;
+  emoji: true;
+};
+```
 
-- Type: `string`
-- Default: `undefined`
 - Example:
 
 ```js
 pluginAreTheTypesWrong({
-  foo: "bar",
+  areTheTypesWrongOptions: {
+    ignoreRules: ["false-cjs"],
+    ignoreResolutions: ["node16-cjs"],
+  },
 });
 ```
 
+## Credits
+
+Thanks to:
+
+- [arethetypeswrong](https://github.com/arethetypeswrong/arethetypeswrong.github.io) for making this possible.
+- [rsbuild-plugin-publint](https://github.com/rspack-contrib/rsbuild-plugin-publint) for the idea of linting as an Rsbuild plugin.
+
 ## License
 
 [MIT](./LICENSE).