@colrealpro/react-luau-doctor 0.17.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ColRealPro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+# React-Luau Doctor
+
+Find React-Luau mistakes before they reach your Roblox UI.
+
+React-Luau Doctor checks `.lua` and `.luau` source files for hook mistakes, missing cleanup, render side effects, and avoidable rerenders. Findings include a category, severity, source location, and repair guidance. The `why` command explains individual findings and shows suggested changes where available.
+
+This is a beta developer tool written in TypeScript and run with Bun. It analyzes React-Luau source on your computer or CI runner. It does not run inside Roblox Studio, analyze JavaScript/TypeScript React, or edit your code automatically.
+
+## Get started
+
+Install [Bun](https://bun.com/) 1.3.14 or newer and Git, then build from source:
+
+```bash
+git clone https://github.com/colrealpro/react-luau-doctor.git
+cd react-luau-doctor
+bun install --frozen-lockfile
+bun run build
+bun ./dist/cli.js ./examples --verbose
+bun link
+```
+
+From your Roblox project's directory:
+
+```bash
+react-luau-doctor .
+react-luau-doctor . --verbose
+```
+
+The source checkout must remain available while you use the linked command. Run `bun unlink` in the tool's checkout to remove the link.
+
+The package has not been published to npm yet. Source installation and generated CI work without an npm release. Once published, npm can distribute this CLI even though the source being analyzed is Luau; users will still need Bun.
+
+## Read a finding
+
+For example, this component changes a prop during render:
+
+```luau
+local React = require(script.Parent.React)
+
+local function Label(props)
+    props.text = "Changed"
+    return React.createElement("TextLabel", { Text = props.text })
+end
+
+return Label
+```
+
+Doctor reports `react-luau/no-prop-mutation`. Compute a local value instead of writing to `props`.
+
+```bash
+react-luau-doctor why src/Label.luau:4
+react-luau-doctor rules explain react-luau/no-prop-mutation
+```
+
+Suggested changes are review guidance. Some are exact previews, others are example patterns that need adapting to your component.
+
+## What it checks
+
+The rule catalog covers correctness, hooks, effects, performance, Roblox behavior, and architecture. Checks include conditional hooks, incomplete dependency tables, connections without cleanup, state updates during render, fresh props crossing memo boundaries, and externally updated state that may be better represented by a Binding.
+
+```bash
+react-luau-doctor rules list
+react-luau-doctor . --category Hooks
+react-luau-doctor . --blocking error
+```
+
+Errors are the highest severity. Warnings identify likely problems, while suggestions include lower-confidence findings that deserve review. You can override each rule's severity or disable it. A clean report is not proof of runtime correctness, and the score is a heuristic, not a performance measurement.
+
+See the [rule catalog](docs/rules.md) and [analysis limits](docs/analysis.md).
+
+## Check a change
+
+```bash
+react-luau-doctor . --scope changed --base main
+react-luau-doctor . --scope lines --base main
+react-luau-doctor . --staged
+react-luau-doctor . --json-out doctor-report.json
+```
+
+`changed` compares findings against a Git base. `lines` keeps findings that overlap changed lines. `--staged` reads index content, so later unstaged edits do not affect the checked file contents.
+
+## Add CI
+
+From your Roblox repository:
+
+```bash
+react-luau-doctor ci install --yes
+```
+
+Commit the generated workflow and the entire `.github/actions/react-luau-doctor` directory. It contains the analyzer and its parser assets, so CI does not download an unpublished Doctor package. It installs the locked parser dependency and runs with Bun.
+
+By default, pull requests receive advisory findings without failing the check. Enable a gate with:
+
+```bash
+react-luau-doctor ci config --blocking error --yes
+```
+
+[CI setup](docs/ci.md) explains permissions, fork PRs, updates, outputs, and GitLab support. Local tests exercise reporting against a simulated GitHub API. A real GitHub Actions run is still required to validate your repository's permissions and runner behavior.
+
+## Configure a project
+
+Create `react-luau-doctor.config.json` in the directory where you run scans:
+
+```json
+{
+  "include": ["src/**/*.luau"],
+  "ignore": ["src/generated/**"],
+  "rules": {
+    "react-luau/no-array-index-as-key": "off",
+    "react-luau/exhaustive-deps": "error"
+  }
+}
+```
+
+Use narrow inline suppressions when an individual finding is intentional:
+
+```luau
+-- react-luau-doctor-disable-next-line no-array-index-as-key
+```
+
+See the [CLI and configuration reference](docs/cli.md) for scanning, reporting, cache controls, and suppression syntax.
+
+## Contribute
+
+Read [development and release checks](docs/development.md). For a false positive or missed issue, open an [issue](https://github.com/colrealpro/react-luau-doctor/issues) with the smallest Luau example you can share, the tool version, and the relevant configuration.
+
+MIT licensed. Inspired by [React Doctor](https://github.com/millionco/react-doctor); not affiliated with its authors, Roblox, or the React-Luau maintainers. See [third-party notices](THIRD_PARTY_NOTICES.md) for parser attribution.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,18 @@
+# Third-party notices
+
+## tree-sitter-luau
+
+This project redistributes `tree-sitter-luau.wasm` from
+`tree-sitter-grammars/tree-sitter-luau`, version 1.2.0.
+
+The grammar is MIT licensed. Its license text is included at
+`vendor/tree-sitter-luau.LICENSE`.
+
+Project: https://github.com/tree-sitter-grammars/tree-sitter-luau
+
+## web-tree-sitter
+
+The runtime parser is provided by `web-tree-sitter`, which is MIT licensed.
+Its license is installed with the npm dependency.
+
+Project: https://github.com/tree-sitter/tree-sitter

package/action.yml

@@ -0,0 +1,71 @@
+name: React-Luau Doctor
+description: "Review React-Luau pull requests and report introduced diagnostics."
+inputs:
+  blocking:
+    description: "Severity that fails the workflow: error, warning, or none."
+    default: none
+  scope:
+    description: "Pull request scan scope: changed, files, lines, or full."
+    default: changed
+  comment:
+    description: "Create or update a sticky pull request summary comment."
+    default: "true"
+  review-comments:
+    description: "Post inline review comments on changed lines."
+    default: "true"
+  commit-status:
+    description: "Publish score and issue counts as a commit status."
+    default: "true"
+  project:
+    description: "Project directories to scan, comma-separated. Asterisk scans the whole directory."
+    default: "*"
+  directory:
+    description: "Project directory to scan."
+    default: "."
+outputs:
+  score:
+    description: "Health score from 0 to 100."
+    value: ${{ steps.doctor.outputs.score }}
+  total-issues:
+    description: "Total diagnostics reported by this run."
+    value: ${{ steps.doctor.outputs.total-issues }}
+  fixed-issues:
+    description: "Number of diagnostics resolved by the pull request."
+    value: ${{ steps.doctor.outputs.fixed-issues }}
+  error-count:
+    description: "Error diagnostic count."
+    value: ${{ steps.doctor.outputs.error-count }}
+  warning-count:
+    description: "Warning diagnostic count."
+    value: ${{ steps.doctor.outputs.warning-count }}
+  affected-files:
+    description: "Number of files with diagnostics."
+    value: ${{ steps.doctor.outputs.affected-files }}
+runs:
+  using: composite
+  steps:
+    - uses: oven-sh/setup-bun@v2
+      with:
+        bun-version: "1.3.14"
+    - name: Install parser runtime
+      shell: bash
+      run: |
+        cd "$GITHUB_ACTION_PATH"
+        bun install --production --frozen-lockfile
+    - id: doctor
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+        DOCTOR_DIRECTORY: ${{ inputs.directory }}
+        DOCTOR_PROJECT: ${{ inputs.project }}
+        DOCTOR_BLOCKING: ${{ inputs.blocking }}
+        DOCTOR_SCOPE: ${{ inputs.scope }}
+      run: >-
+        bun "$GITHUB_ACTION_PATH/dist/cli.js" ci run
+        --directory "$DOCTOR_DIRECTORY"
+        --project "$DOCTOR_PROJECT"
+        --blocking "$DOCTOR_BLOCKING"
+        --scope "$DOCTOR_SCOPE"
+        ${{ inputs.comment == 'true' && '--comment' || '--no-comment' }}
+        ${{ inputs.review-comments == 'true' && '--review-comments' || '--no-review-comments' }}
+        ${{ inputs.commit-status == 'true' && '--commit-status' || '--no-commit-status' }}