@colrealpro/react-luau-doctor 0.17.0 → 0.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README.md +20 -12
  2. package/dist/cli.js +93 -344
  3. package/dist/cli.js.map +13 -13
  4. package/docs/ci.md +11 -15
  5. package/docs/cli.md +4 -4
  6. package/docs/development.md +18 -17
  7. package/docs/rules.md +1 -1
  8. package/package.json +6 -7
  9. package/action.yml +0 -71
  10. package/dist/runtime-lock.json +0 -29
package/README.md CHANGED
@@ -4,31 +4,39 @@ Find React-Luau mistakes before they reach your Roblox UI.
4
4
 
5
5
  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.
6
6
 
7
- 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.
7
+ This beta CLI runs with Bun and 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.
8
8
 
9
9
  ## Get started
10
10
 
11
- Install [Bun](https://bun.com/) 1.3.14 or newer and Git, then build from source:
11
+ React-Luau Doctor requires [Bun](https://bun.com/) 1.4.0 or newer. Run it directly from npm with either Bun or npm:
12
12
 
13
13
  ```bash
14
- git clone https://github.com/colrealpro/react-luau-doctor.git
15
- cd react-luau-doctor
16
- bun install --frozen-lockfile
17
- bun run build
18
- bun ./dist/cli.js ./examples --verbose
19
- bun link
14
+ bunx @colrealpro/react-luau-doctor .
15
+ ```
16
+
17
+ ```bash
18
+ npx @colrealpro/react-luau-doctor .
20
19
  ```
21
20
 
22
- From your Roblox project's directory:
21
+ `npx` still requires Bun to be installed because the React-Luau Doctor CLI itself runs with Bun.
22
+
23
+ For a reusable `react-luau-doctor` command, install it globally with Bun:
23
24
 
24
25
  ```bash
26
+ bun add --global @colrealpro/react-luau-doctor
25
27
  react-luau-doctor .
26
28
  react-luau-doctor . --verbose
27
29
  ```
28
30
 
29
- The source checkout must remain available while you use the linked command. Run `bun unlink` in the tool's checkout to remove the link.
31
+ To work on React-Luau Doctor itself, clone the repository and use Bun for development:
30
32
 
31
- 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.
33
+ ```bash
34
+ git clone https://github.com/colrealpro/react-luau-doctor.git
35
+ cd react-luau-doctor
36
+ bun install --frozen-lockfile
37
+ bun run build
38
+ bun run ci
39
+ ```
32
40
 
33
41
  ## Read a finding
34
42
 
@@ -87,7 +95,7 @@ From your Roblox repository:
87
95
  react-luau-doctor ci install --yes
88
96
  ```
89
97
 
90
- 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.
98
+ Commit the generated `.github/workflows/react-luau-doctor.yml`. The workflow pins the exact npm version of React-Luau Doctor that generated it and runs that package with Bun, so your repository does not need to vendor the analyzer or its parser assets.
91
99
 
92
100
  By default, pull requests receive advisory findings without failing the check. Enable a gate with:
93
101