@methiu/raigal 1.0.0 → 1.0.2

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.
package/README.md CHANGED
@@ -2,15 +2,14 @@
2
2
 
3
3
  **Catch the slop AI coding agents leave in your code.**
4
4
 
5
- [![npm version](https://img.shields.io/npm/v/raigal.svg)](https://www.npmjs.com/package/raigal) [![npm downloads](https://img.shields.io/npm/dm/raigal.svg)](https://www.npmjs.com/package/raigal) [![CI](https://github.com/meethiu/raigal/actions/workflows/ci.yml/badge.svg)](https://github.com/meethiu/raigal/actions/workflows/ci.yml) [![Node >= 20](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org) [![Discord](https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white)](https://discord.gg/Mzz4A6mfj6)
6
-
5
+ [![npm version](https://img.shields.io/npm/v/@methiu/raigal.svg)](https://www.npmjs.com/package/@methiu/raigal) [![npm downloads](https://img.shields.io/npm/dm/@methiu/raigal.svg)](https://www.npmjs.com/package/@methiu/raigal) [![CI](https://github.com/meethiu/raigal/actions/workflows/ci.yml/badge.svg)](https://github.com/meethiu/raigal/actions/workflows/ci.yml) [![Node >= 20](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org)
7
6
  The patterns Claude Code, Cursor, Codex, and OpenCode leave behind: narrative comments above self-explanatory code, swallowed exceptions, hidden fallbacks, `as any` casts, hallucinated imports, duplicated helpers, dead code, todo stubs, oversized functions. Tests pass. Lint passes. The code rots anyway.
8
7
 
9
8
  Raigal catches them. 50+ rules across 10 language targets (TypeScript, JavaScript, Expo / React Native, Python, Go, Rust, Ruby, PHP, C#, C/C++). Scores every change 0-100. Sub-second. Deterministic: no LLM in the runtime path, same code in, same score out.
10
9
 
11
10
  ## Quick start
12
11
 
13
- Raigal is proprietary software licensed to organizations on an admin-managed allowlist. Runs require authentication via organization credentials (`raigal login` or `RAIGAL_TOKEN`).
12
+ Raigal is demo software licensed to organizations on an admin-managed allowlist. Runs require authentication via organization credentials (`raigal login` or `RAIGAL_TOKEN`).
14
13
 
15
14
  ```bash
16
15
  # 1. Sign in with your organization account
@@ -25,10 +24,11 @@ In CI and automated workflows, provide your organization API key via the `RAIGAL
25
24
  Also available on npm, Yarn, Bun, and Homebrew:
26
25
 
27
26
  ```bash
28
- npm install -g raigal # npm
29
- yarn dlx raigal scan # Yarn
30
- bun add -g raigal # Bun
31
- brew install meethiu/tap/raigal # Homebrew
27
+ npm install -g @methiu/raigal
28
+
29
+ or
30
+
31
+ npm i @methiu/raigal
32
32
  ```
33
33
 
34
34
  See [Installation](#installation) for every option.
@@ -53,7 +53,7 @@ raigal hook install --claude # per-edit hook
53
53
  [![raigal](https://badges.raigal.dev/score/<owner>/<repo>.svg)](https://raigal.dev)
54
54
  ```
55
55
 
56
- Run `npx raigal@latest badge` to auto-generate. Free at [raigal.dev](https://raigal.dev).
56
+ Run `npx @methiu/raigal@latest badge` to auto-generate. Free at [raigal.dev](https://raigal.dev).
57
57
 
58
58
  ## See it in action
59
59
 
@@ -71,22 +71,22 @@ The same CLI is published to npm and Homebrew. Pick whichever fits your stack.
71
71
 
72
72
  ```bash
73
73
  # Run without installing
74
- npx raigal@latest scan
74
+ npx @methiu/raigal@latest scan
75
75
 
76
76
  # npm
77
- npm install --save-dev raigal
77
+ npm install --save-dev @methiu/raigal
78
78
 
79
79
  # yarn
80
- yarn add --dev raigal
80
+ yarn add --dev @methiu/raigal
81
81
 
82
82
  # pnpm
83
- pnpm add -D raigal
83
+ pnpm add -D @methiu/raigal
84
84
 
85
85
  # bun
86
- bun add -d raigal
86
+ bun add -d @methiu/raigal
87
87
 
88
88
  # Global
89
- npm install -g raigal
89
+ npm install -g @methiu/raigal
90
90
  ```
91
91
 
92
92
  Package installation does not run dependency lifecycle scripts. After installing, run `raigal-tools` once if you want bundled Ruff and golangci-lint coverage; the core scanner works without it.
@@ -113,7 +113,7 @@ Full reference for every channel, optional bundled tooling, and external tools:
113
113
 
114
114
  ## Usage
115
115
 
116
- Examples below use the installed `raigal` binary. For a one-off latest run, prefix the command with `npx raigal@latest`, for example `npx raigal@latest scan`.
116
+ Examples below use the installed `raigal` binary. For a one-off latest run, prefix the command with `npx @methiu/raigal@latest`, for example `npx @methiu/raigal@latest scan`.
117
117
 
118
118
  ### Command reference
119
119
 
@@ -272,7 +272,7 @@ raigal install claude cursor # alias for hook install
272
272
  raigal install hooks --claude # natural alias for hook install
273
273
  ```
274
274
 
275
- **Runtime adapters** (scan + feedback): `claude`, `cursor`, `gemini`, `pi`.
275
+ **Runtime adapters** (scan + feedback): `claude`, `cursor`, `gemini`, `pi`.
276
276
  **Rules-only** (agent reads rules): `codex`, `windsurf`, `cline`, `kilocode`, `antigravity`, `copilot`.
277
277
 
278
278
  Hook install flags: `--agent <names>`, `-g, --global`, `--project`, `--dry-run`, `--yes`, `--quality-gate`, plus per-agent shortcuts `--claude`, `--cursor`, `--gemini`, `--pi`, `--codex`, `--windsurf`, `--cline`, `--kilocode`, `--antigravity`, `--copilot`.
@@ -298,7 +298,7 @@ Expose Raigal as MCP tools for Claude Desktop, Cursor, Codex:
298
298
  "mcpServers": {
299
299
  "raigal": {
300
300
  "command": "npx",
301
- "args": ["-y", "raigal-mcp"]
301
+ "args": ["-y", "@methiu/raigal-mcp"]
302
302
  }
303
303
  }
304
304
  }
@@ -389,7 +389,7 @@ jobs:
389
389
  with:
390
390
  node-version: 24
391
391
  - name: Raigal Quality Gate
392
- run: npx --yes raigal@latest ci
392
+ run: npx --yes @methiu/raigal@latest ci
393
393
  env:
394
394
  RAIGAL_TOKEN: ${{ secrets.RAIGAL_TOKEN }}
395
395
  ```
@@ -397,7 +397,7 @@ jobs:
397
397
  **GitHub code scanning (SARIF)**: emit a SARIF 2.1.0 report and upload it so findings appear in the Security tab:
398
398
 
399
399
  ```yaml
400
- - run: npx raigal@latest scan . --sarif > raigal.sarif
400
+ - run: npx @methiu/raigal@latest scan . --sarif > raigal.sarif
401
401
  - uses: github/codeql-action/upload-sarif@v3
402
402
  with:
403
403
  sarif_file: raigal.sarif
@@ -419,7 +419,7 @@ pipelines:
419
419
  depth: full # branch diffs need history
420
420
  script:
421
421
  - git fetch origin "$BITBUCKET_PR_DESTINATION_BRANCH"
422
- - npx --yes raigal@latest ci --changes --base FETCH_HEAD
422
+ - npx --yes @methiu/raigal@latest ci --changes --base FETCH_HEAD
423
423
  ```
424
424
 
425
425
  `ci` applies the score gate and exit code, so no JSON parsing or hand-rolled threshold is needed. More providers: [CI/CD](docs/ci.md).
@@ -488,7 +488,7 @@ Raigal rules are shaped by public scans and benchmark-derived failure modes, not
488
488
 
489
489
  ## Community
490
490
 
491
- [Discord](https://discord.gg/Mzz4A6mfj6) for community chat and support · [Discussions](https://github.com/meethiu/raigal/discussions) for questions, rule requests, and false-positive triage · [Issues](https://github.com/meethiu/raigal/issues) for bugs
491
+ [Discussions](https://github.com/meethiu/raigal/discussions) for questions, rule requests, and false-positive triage · [Issues](https://github.com/meethiu/raigal/issues) for bugs
492
492
 
493
493
  ## Contributing
494
494
 
@@ -508,4 +508,4 @@ Auto-updated by `.github/workflows/contributors.yml`. [Link commit email](https:
508
508
 
509
509
  ## License
510
510
 
511
- Proprietary. All rights reserved. Use is permitted only under a written agreement with Raigal. See [LICENSE](LICENSE) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
511
+ Proprietary. All rights reserved. Use is permitted only under a written agreement with Raigal. See [LICENSE](LICENSE) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).