flamerjs 0.1.5 → 0.1.6
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 +29 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,10 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
**A fast sanity checker for AI-assisted codebases.**
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/flamerjs)
|
|
8
|
-
[](LICENSE)
|
|
5
|
+
[](https://github.com/dummy3ye/flamer/actions/workflows/ci.yml)
|
|
6
|
+
[](https://codecov.io/gh/dummy3ye/flamer)
|
|
7
|
+
[](https://www.npmjs.com/package/flamerjs)<br>
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
[](https://github.com/dummy3ye/flamer/commits/master)
|
|
10
|
+
[](https://github.com/dummy3ye/flamer/stargazers)
|
|
11
|
+
[](https://github.com/dummy3ye/flamer)
|
|
9
12
|
|
|
10
13
|
Flamer scans a repository for the common mistakes that appear when software is
|
|
11
14
|
assembled quickly with AI or other “vibe coding” workflows: unfinished
|
|
@@ -57,41 +60,45 @@ can be used locally, in pull requests, or in CI.
|
|
|
57
60
|
|
|
58
61
|
## Quick start
|
|
59
62
|
|
|
60
|
-
Run
|
|
63
|
+
Run the published CLI without installing it permanently:
|
|
61
64
|
|
|
62
65
|
```bash
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
+
npx flamerjs .
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
For a project-local installation, add Flamer as a development dependency:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npm install --save-dev flamerjs
|
|
73
|
+
npx flamerjs .
|
|
66
74
|
```
|
|
67
75
|
|
|
68
|
-
|
|
76
|
+
Or install it globally if you use it across repositories:
|
|
69
77
|
|
|
70
78
|
```bash
|
|
71
79
|
npm install --global flamerjs
|
|
72
80
|
flamerjs .
|
|
73
81
|
```
|
|
74
82
|
|
|
75
|
-
During development, `npm run dev` watches and rebuilds `dist/cli.js`.
|
|
76
83
|
The default output is a colorized terminal summary when run interactively.
|
|
77
84
|
Use `--format json` for automation and machine-readable output.
|
|
78
85
|
|
|
79
86
|
For a human-readable report:
|
|
80
87
|
|
|
81
88
|
```bash
|
|
82
|
-
|
|
89
|
+
flamerjs . --format summary
|
|
83
90
|
```
|
|
84
91
|
|
|
85
92
|
Analyze another repository:
|
|
86
93
|
|
|
87
94
|
```bash
|
|
88
|
-
|
|
95
|
+
flamerjs /path/to/repository --format summary
|
|
89
96
|
```
|
|
90
97
|
|
|
91
98
|
## CLI
|
|
92
99
|
|
|
93
100
|
```text
|
|
94
|
-
|
|
101
|
+
flamerjs [path] [options]
|
|
95
102
|
```
|
|
96
103
|
|
|
97
104
|
| Option | Description |
|
|
@@ -142,15 +149,23 @@ Findings are sorted by severity. Credential values are always redacted.
|
|
|
142
149
|
|
|
143
150
|
## Development
|
|
144
151
|
|
|
152
|
+
Clone the repository when you want to contribute or work on the scanner itself:
|
|
153
|
+
|
|
145
154
|
```bash
|
|
146
155
|
npm ci
|
|
147
|
-
npm run dev #
|
|
156
|
+
npm run dev # watch and rebuild dist/cli.js
|
|
148
157
|
npm test # run the test suite
|
|
149
158
|
npm run lint
|
|
150
159
|
npm run format:check
|
|
151
160
|
npm run build
|
|
152
161
|
```
|
|
153
162
|
|
|
163
|
+
To run the local build directly:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
node dist/cli.js .
|
|
167
|
+
```
|
|
168
|
+
|
|
154
169
|
The project uses Node.js and npm as its supported development toolchain.
|
|
155
170
|
`package-lock.json` is the canonical dependency lockfile.
|
|
156
171
|
The current test suite contains **175 tests**.
|