@lakindu_perera/toren 1.0.0 → 1.0.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 +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Understand any codebase in seconds.
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/toren)
|
|
5
|
+
[](https://www.npmjs.com/package/@lakindu_perera/toren)
|
|
6
6
|
[](LICENSE)
|
|
7
7
|
[](https://nodejs.org)
|
|
8
8
|
[](package.json)
|
|
@@ -26,15 +26,15 @@ Whether you've just cloned an open-source project, joined a new team, or are rev
|
|
|
26
26
|
|
|
27
27
|
## Features
|
|
28
28
|
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
29
|
+
- **Fast scanning** — recursively walks a project in milliseconds
|
|
30
|
+
- **Zero external dependencies** — pure Node.js stdlib only
|
|
31
|
+
- **Framework detection** — identifies React, Next.js, Vue, Angular, Go, Rust, Python, and more
|
|
32
|
+
- **Entry point detection** — pinpoints `index.js`, `main.ts`, `App.tsx`, `Application.java`, and other common entry files
|
|
33
|
+
- **File tree preview** — visual directory structure, up to 4 levels deep
|
|
34
|
+
- **Beautiful terminal output** — ANSI-styled, readable at a glance
|
|
35
|
+
- **JSON output** — machine-readable format for scripting and tooling integration
|
|
36
|
+
- **Smart ignore rules** — skips `node_modules`, `.git`, `dist`, `build`, `.venv`, and more
|
|
37
|
+
- **Extensible renderer architecture** — add new output formats without touching core logic
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -43,13 +43,13 @@ Whether you've just cloned an open-source project, joined a new team, or are rev
|
|
|
43
43
|
Install globally with npm:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
npm install -g toren
|
|
46
|
+
npm install -g @lakindu_perera/toren
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
Or run without installing:
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
|
-
npx toren
|
|
52
|
+
npx @lakindu_perera/toren
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
**Requirements:** Node.js 18.0.0 or higher.
|
|
@@ -313,7 +313,7 @@ Toren automates that first pass. In one command, you get a structured summary of
|
|
|
313
313
|
- [x] Entry point detection
|
|
314
314
|
- [x] `--doctor` install health check
|
|
315
315
|
- [x] `--uninstall` guided removal
|
|
316
|
-
- [x] Markdown renderer (`--format
|
|
316
|
+
- [x] Markdown renderer (`--format markdown`)
|
|
317
317
|
- [x] HTML renderer (`--format html`)
|
|
318
318
|
- [ ] YAML output
|
|
319
319
|
- [ ] `.torenignore` configuration file
|
|
@@ -335,7 +335,7 @@ Contributions are welcome and appreciated.
|
|
|
335
335
|
4. **Push** to your branch: `git push origin feature/my-feature`
|
|
336
336
|
5. **Open** a pull request
|
|
337
337
|
|
|
338
|
-
For bugs or feature requests, please [open an issue](https://github.com/
|
|
338
|
+
For bugs or feature requests, please [open an issue](https://github.com/lakindudev/toren/issues). Try to include a clear description and, for bugs, the output of `toren --doctor`.
|
|
339
339
|
|
|
340
340
|
**Code style notes:**
|
|
341
341
|
- Zero external runtime dependencies — keep it that way
|