@qodfy/core 0.1.0 → 0.1.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.
- package/README.md +52 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @qodfy/core
|
|
2
|
+
|
|
3
|
+
Scanner engine for Qodfy.
|
|
4
|
+
|
|
5
|
+
Most developers should use the CLI:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx qodfy scan
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This package contains the deterministic local scanner used by the `qodfy` CLI. It is published separately so Qodfy can later support more report formats, integrations, and programmatic usage without coupling everything to terminal output.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @qodfy/core
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { scanProject } from "@qodfy/core";
|
|
23
|
+
|
|
24
|
+
const report = await scanProject(process.cwd());
|
|
25
|
+
|
|
26
|
+
console.log(report.score);
|
|
27
|
+
console.log(report.issues);
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## What It Returns
|
|
31
|
+
|
|
32
|
+
`scanProject(projectPath)` returns a launch-readiness report with:
|
|
33
|
+
|
|
34
|
+
- project path
|
|
35
|
+
- Next.js detection result
|
|
36
|
+
- score from `0` to `100`
|
|
37
|
+
- issues with severity, title, message, and optional file path
|
|
38
|
+
- stats for scanned files, API routes, AI-related files, and large files
|
|
39
|
+
|
|
40
|
+
## Local-Only
|
|
41
|
+
|
|
42
|
+
`@qodfy/core` reads files from the local project path you provide. It does not call AI APIs, upload code, require login, or contact an external Qodfy server.
|
|
43
|
+
|
|
44
|
+
## Repository
|
|
45
|
+
|
|
46
|
+
GitHub: https://github.com/yassinifguisse1/qodfy
|
|
47
|
+
|
|
48
|
+
Issues and feedback: https://github.com/yassinifguisse1/qodfy/issues
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT
|