add only frontend
This commit is contained in:
@@ -14,6 +14,7 @@ Generate markdown documentation from directory structure. Optimized for LLM inge
|
||||
- Configurable depth, file size limits, ignore patterns
|
||||
- Optional upload to Proton Drive after generating output
|
||||
- Skip frontend files (`.html`, `.css`, `.js`, etc.)
|
||||
- Frontend only mode (include only frontend files and `README.md`)
|
||||
- Omit test files and inline test blocks (Go, Java, Rust)
|
||||
|
||||
## Build
|
||||
@@ -40,6 +41,9 @@ Generate markdown documentation from directory structure. Optimized for LLM inge
|
||||
# Skip frontend files (.html, .css, .js, etc.)
|
||||
dirmd -o output.md ~/repos/myproject --skip-frontend
|
||||
|
||||
# Frontend only (include only frontend files and README.md)
|
||||
dirmd -o output.md ~/repos/myproject --frontend-only
|
||||
|
||||
# Omit test files and inline test blocks
|
||||
# Go: excludes *_test.go
|
||||
# Java: excludes *Test.java, *Tests.java, src/test/java/*
|
||||
@@ -47,7 +51,7 @@ Generate markdown documentation from directory structure. Optimized for LLM inge
|
||||
dirmd -o output.md ~/repos/myproject --omit-test
|
||||
|
||||
# Combine filters
|
||||
dirmd -o output.md ~/repos/myproject --skip-frontend --omit-test
|
||||
dirmd -o output.md ~/repos/myproject --frontend-only --omit-test
|
||||
|
||||
# Generate and upload to Proton Drive (default: /my-files/md/<filename>)
|
||||
dirmd -o output.md ~/repos/myproject --proton-drive
|
||||
@@ -67,18 +71,26 @@ The `--omit-test` flag removes test files and inline test blocks to reduce token
|
||||
|
||||
The Rust stripping works by detecting the `#[cfg(test)]` attribute, then tracking brace depth until the module closes. Nested braces in string literals may occasionally throw off the count, but this is acceptable for RAG use cases.
|
||||
|
||||
Frontend files can be excluded separately with `--skip-frontend`:
|
||||
## Frontend Filtering
|
||||
|
||||
| Extension Type | Excluded With `--skip-frontend` |
|
||||
|---------------|-------------------------------|
|
||||
Two complementary flags control frontend file inclusion:
|
||||
|
||||
| Flag | Effect |
|
||||
|------|--------|
|
||||
| `--skip-frontend` | Exclude frontend files, keep everything else |
|
||||
| `--frontend-only` | Include only frontend files and `README.md`, exclude everything else |
|
||||
|
||||
Frontend extensions covered:
|
||||
|
||||
| Type | Extensions |
|
||||
|------|------------|
|
||||
| Templates | `.html`, `.htm`, `.gohtml`, `.tmpl` |
|
||||
| Stylesheets | `.css`, `.scss`, `.sass`, `.less` |
|
||||
| Scripts | `.js`, `.jsx`, `.mjs`, `.cjs`, `.ts`, `.tsx` |
|
||||
| JavaScript | `.js`, `.jsx`, `.mjs`, `.cjs` |
|
||||
| TypeScript | `.ts`, `.tsx` |
|
||||
| Frameworks | `.vue`, `.svelte` |
|
||||
|
||||
These flags can be combined freely:
|
||||
|
||||
dirmd -o docs.md ~/repos/myproject --skip-frontend --omit-test
|
||||
`--skip-frontend` and `--frontend-only` are mutually exclusive. Both can be combined with `--omit-test`.
|
||||
|
||||
## Vertical Slices Mode
|
||||
|
||||
@@ -123,13 +135,14 @@ Output is designed for RAG ingestion and LLM context windows, not human presenta
|
||||
| `--proton-drive` | Upload output to Proton Drive after writing locally | false |
|
||||
| `--drive-path` | Full remote path on Proton Drive (e.g. /my-files/md/report.md) | /my-files/md/<filename> |
|
||||
| `--skip-frontend` | Omit frontend file types (.html, .css, .js, .ts, .vue, .svelte, etc.) | false |
|
||||
| `--frontend-only` | Include only frontend file types and README.md | false |
|
||||
| `--omit-test` | Exclude test files (Go *_test.go, Java *Test.java) and strip #[cfg(test)] blocks from Rust | false |
|
||||
|
||||
## Proton Drive Integration
|
||||
|
||||
dirmd can optionally upload the generated markdown file(s) to Proton Drive using the [Proton Drive CLI](https://proton.me/support/drive-cli). The upload is performed only when `--proton-drive` is passed. Without it, dirmd behaves exactly as before — no Proton Drive dependency is required.
|
||||
|
||||
In vertical slices mode, all generated files (root + slices) are uploaded to `/my-files/md/`. The `--drive-path` flag is ignored in slices mode; each file is uploaded by its basename.
|
||||
In vertical slices mode, all generated files (root + slices) are uploaded to `/my-files/md/`. The `--drive-path` flag is ignored in slices mode ; each file is uploaded by its basename.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -158,6 +171,9 @@ For full documentation on the Proton Drive CLI, including installation, authenti
|
||||
# Skip frontend and omit tests
|
||||
dirmd -o docs.md ~/repos/project -f --skip-frontend --omit-test
|
||||
|
||||
# Frontend only with test omission
|
||||
dirmd -o docs.md ~/repos/project -f --frontend-only --omit-test
|
||||
|
||||
# Generate, then upload to default remote location
|
||||
dirmd -o docs.md ~/repos/project --proton-drive
|
||||
|
||||
|
||||
Reference in New Issue
Block a user