tsl-react 0.0.1-next.1 → 0.0.2-next.0

package/dist/index.d.ts

@@ -1,58 +1,56 @@
-import * as tsl from 'tsl';
+import { Rule } from 'tsl';
 
-declare const rules: tsl.RulesSet<{
-    /**
-     * Prevents problematic leaked values from being rendered.
-     *
-     * Using the && operator to render some element conditionally in JSX can cause unexpected values being rendered, or even crashing the rendering.
-     *
-     * **Examples**
-     *
-     * ```tsx
-     * import React from "react";
-     *
-     * interface MyComponentProps {
-     *   count: number;
-     * }
-     *
-     * function MyComponent({ count }: MyComponentProps) {
-     *   return <div>{count && <span>There are {count} results</span>}</div>;
-     *   //           ^^^^^
-     *   //           - Potential leaked value 'count' that might cause unintentionally rendered values or rendering crashes.
-     * }
-     * ```
-     *
-     * ```tsx
-     * import React from "react";
-     *
-     * interface MyComponentProps {
-     *   items: string[];
-     * }
-     *
-     * function MyComponent({ items }: MyComponentProps) {
-     *   return <div>{items.length && <List items={items} />}</div>;
-     *   //           ^^^^^^^^^^^^
-     *   //           - Potential leaked value 'items.length' that might cause unintentionally rendered values or rendering crashes.
-     * }
-     * ```
-     *
-     * ```tsx
-     * import React from "react";
-     *
-     * interface MyComponentProps {
-     *   items: string[];
-     * }
-     *
-     * function MyComponent({ items }: MyComponentProps) {
-     *   return <div>{items[0] && <List items={items} />}</div>;
-     *   //           ^^^^^^^^
-     *   //           - Potential leaked value 'items[0]' that might cause unintentionally rendered values or rendering crashes.
-     * }
-     * ```
-     *
-     * @since 0.0.0
-     */
-    noLeakedConditionalRendering: (options?: "off" | undefined) => tsl.Rule<unknown>;
-}>;
+/**
+ * Prevents problematic leaked values from being rendered.
+ *
+ * Using the && operator to render some element conditionally in JSX can cause unexpected values being rendered, or even crashing the rendering.
+ *
+ * **Examples**
+ *
+ * ```tsx
+ * import React from "react";
+ *
+ * interface MyComponentProps {
+ *   count: number;
+ * }
+ *
+ * function MyComponent({ count }: MyComponentProps) {
+ *   return <div>{count && <span>There are {count} results</span>}</div>;
+ *   //           ^^^^^
+ *   //           - Potential leaked value 'count' that might cause unintentionally rendered values or rendering crashes.
+ * }
+ * ```
+ *
+ * ```tsx
+ * import React from "react";
+ *
+ * interface MyComponentProps {
+ *   items: string[];
+ * }
+ *
+ * function MyComponent({ items }: MyComponentProps) {
+ *   return <div>{items.length && <List items={items} />}</div>;
+ *   //           ^^^^^^^^^^^^
+ *   //           - Potential leaked value 'items.length' that might cause unintentionally rendered values or rendering crashes.
+ * }
+ * ```
+ *
+ * ```tsx
+ * import React from "react";
+ *
+ * interface MyComponentProps {
+ *   items: string[];
+ * }
+ *
+ * function MyComponent({ items }: MyComponentProps) {
+ *   return <div>{items[0] && <List items={items} />}</div>;
+ *   //           ^^^^^^^^
+ *   //           - Potential leaked value 'items[0]' that might cause unintentionally rendered values or rendering crashes.
+ * }
+ * ```
+ *
+ * @since 0.0.0
+ */
+declare const noLeakedConditionalRendering: (options?: "off" | undefined) => Rule<unknown>;
 
-export { rules };
+export { noLeakedConditionalRendering };

package/dist/index.js

@@ -1,5 +1,5 @@
-import { defineRule, createRulesSet } from 'tsl';
 import { compare } from 'compare-versions';
+import { defineRule } from 'tsl';
 import { SyntaxKind } from 'typescript';
 import { isLogicalNegationExpression } from '@react-analyzer/ast';
 import { unit } from '@react-analyzer/eff';
@@ -7,7 +7,7 @@ import { Report } from '@react-analyzer/kit';
 import { getAnalyzerOptions } from '@react-analyzer/shared';
 import * as RA from '@react-analyzer/core';
 
-// src/index.ts
+// src/rules/no-leaked-conditional-rendering.ts
 var messages = {
   noLeakedConditionalRendering: (p) => `Potential leaked value ${p.value} that might cause unintentionally rendered values or rendering crashes.`
 };
@@ -63,61 +63,4 @@ var noLeakedConditionalRendering = defineRule(() => {
   };
 });
 
-// src/index.ts
-var rules = createRulesSet({
-  /**
-   * Prevents problematic leaked values from being rendered.
-   *
-   * Using the && operator to render some element conditionally in JSX can cause unexpected values being rendered, or even crashing the rendering.
-   *
-   * **Examples**
-   *
-   * ```tsx
-   * import React from "react";
-   *
-   * interface MyComponentProps {
-   *   count: number;
-   * }
-   *
-   * function MyComponent({ count }: MyComponentProps) {
-   *   return <div>{count && <span>There are {count} results</span>}</div>;
-   *   //           ^^^^^
-   *   //           - Potential leaked value 'count' that might cause unintentionally rendered values or rendering crashes.
-   * }
-   * ```
-   *
-   * ```tsx
-   * import React from "react";
-   *
-   * interface MyComponentProps {
-   *   items: string[];
-   * }
-   *
-   * function MyComponent({ items }: MyComponentProps) {
-   *   return <div>{items.length && <List items={items} />}</div>;
-   *   //           ^^^^^^^^^^^^
-   *   //           - Potential leaked value 'items.length' that might cause unintentionally rendered values or rendering crashes.
-   * }
-   * ```
-   *
-   * ```tsx
-   * import React from "react";
-   *
-   * interface MyComponentProps {
-   *   items: string[];
-   * }
-   *
-   * function MyComponent({ items }: MyComponentProps) {
-   *   return <div>{items[0] && <List items={items} />}</div>;
-   *   //           ^^^^^^^^
-   *   //           - Potential leaked value 'items[0]' that might cause unintentionally rendered values or rendering crashes.
-   * }
-   * ```
-   *
-   * @since 0.0.0
-   */
-  noLeakedConditionalRendering
-  // TODO: Port more rules from https://beta.eslint-react.xyz/docs/rules/overview
-});
-
-export { rules };
+export { noLeakedConditionalRendering };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsl-react",
-  "version": "0.0.1-next.1",
+  "version": "0.0.2-next.0",
   "description": "A unified plugin that combines all individual plugins from the react-analyzer monorepo into one.",
   "keywords": [
     "react",
@@ -28,11 +28,11 @@
   ],
   "dependencies": {
     "compare-versions": "^6.1.1",
-    "@react-analyzer/ast": "0.0.1-next.1",
-    "@react-analyzer/shared": "0.0.1-next.1",
-    "@react-analyzer/core": "0.0.1-next.1",
-    "@react-analyzer/kit": "0.0.1-next.1",
-    "@react-analyzer/eff": "0.0.1-next.1"
+    "@react-analyzer/core": "0.0.2-next.0",
+    "@react-analyzer/eff": "0.0.2-next.0",
+    "@react-analyzer/ast": "0.0.2-next.0",
+    "@react-analyzer/shared": "0.0.2-next.0",
+    "@react-analyzer/kit": "0.0.2-next.0"
   },
   "devDependencies": {
     "tsup": "^8.5.0",
@@ -51,6 +51,7 @@
   },
   "scripts": {
     "build": "tsup --dts-resolve",
+    "build:docs": "typedoc",
     "lint:publish": "pnpm publint",
     "lint:ts": "tsl"
   }

package/README.md

@@ -1,67 +0,0 @@
-# tsl-react
-
-[![Version](https://img.shields.io/npm/v/tsl-react?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/tsl-react)
-
-(WIP) Bring the same linting functionality that [`eslint-react.xyz`](https://eslint-react.xyz) has to the TypeScript LSP.
-
-This package provides the rulesets from [`beta.eslint-react.xyz/docs/rules/overview`](https://beta.eslint-react.xyz/docs/rules/overview) as custom rules for the [ArnaudBarre/tsl](https://github.com/ArnaudBarre/tsl) linting tool.
-
-## Installation
-
-```bash
-pnpm add -D tsl tsl-react
-```
-
-Then follow the [installation guide](https://github.com/ArnaudBarre/tsl?tab=readme-ov-file#installation) for tsl.
-
-## Enabling rules
-
-```diff
-// tsl.config.ts
-import { core, defineConfig } from "tsl";
-+ import { rules as react } from "tsl-react";
-
-export default defineConfig({
-  rules: [
-    ...core.all(),
-+    react.noLeakedConditionalRendering(),
-  ],
-});
-```
-
-## Specifying project-aware React configuration
-
-In your `tsconfig.json` or `jsconfig.json` add the following:
-
-```diff
-{
-  "compilerOptions": {
-+    "jsx": "react-jsx",
-    "plugins": [{ "name": "tsl/plugin" }],
-  },
-+  "react": {
-+    "version": "19.1.0" // or "detect" to automatically detect the version
-+    // other options can be added here
-+  }
-}
-```
-
-## Status
-
-### Implemented Rules
-
-- [x] `noLeakedConditionalRendering`: Prevents problematic leaked values from being rendered.
-- [ ] ...
-
-## License
-
-This project is licensed under the [MIT License](./LICENSE).
-
-## Acknowledgements
-
-We extend our gratitude to:
-
-- **[ArnaudBarre/tsl](https://github.com/ArnaudBarre/tsl)** for the core and AST type rewrite, which significantly streamlined custom rules development within TypeScript Language Service Plugin.
-- **[johnsoncodehk/tsslint](https://github.com/johnsoncodehk/tsslint)** for their early explorations of exposing the TypeScript Language Server diagnostic interface.
-- **[typescript-eslint/typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)** for providing the foundation where these custom rules were initially developed and tested.
-- **[Effect-TS/language-service](https://github.com/Effect-TS/language-service)** for inspiring the creation of [`typescriptreact-language-service`](https://github.com/react-analyzer/tsl/commit/01ab1d8d954d555bff65246c61af8c1028be78f1#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5) (now [`tsl-react`](https://github.com/react-analyzer/tsl)).