treedocs 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Lyons
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+# treedocs
+
+`treedocs` keeps a version-controlled architectural map of a repository in `treedocs.yaml`. It scans the filesystem into a nested YAML tree, stores descriptions and references beside paths, and reports drift when the repository changes.
+
+This rewrite is a Bun-native TypeScript CLI intended for npm distribution. The old Swift package, interactive terminal UI, DocC assets, Homebrew formulae, and historical migration scaffolding were removed so the package focuses on the useful portable workflow.
+
+## Install
+
+`treedocs` is published as an npm package with a Bun executable entrypoint. Install Bun first, then install the package:
+
+```bash
+npm install -g treedocs
+treedocs --help
+```
+
+For local development:
+
+```bash
+bun install
+bun run src/cli.ts --help
+```
+
+## Commands
+
+```bash
+treedocs init
+treedocs sync
+treedocs check
+treedocs show .
+treedocs explore src/ tests/
+treedocs ls
+treedocs inspect src/ --recursive
+treedocs update README.md "Project overview"
+treedocs update src/ --add-reference DOCS/Architecture.md
+treedocs update docs/api/ --link src/api/
+treedocs path renderer
+```
+
+Shared options:
+
+```bash
+-p, --path <path>       Repository root, defaults to .
+-n, --non-interactive   Accepted for script compatibility
+-f, --full-descriptions Render untruncated descriptions for show/explore/ls
+```
+
+Bare path usage is shorthand for `show`:
+
+```bash
+treedocs src/
+```
+
+## What It Keeps
+
+- Scans files and directories into `treedocs.yaml`
+- Treats nested `treedocs.yaml` files as delegated documentation boundaries
+- Preserves descriptions, references, and `_link` aliases during sync
+- Computes deterministic `sha256:` signatures from repository structure
+- Merges built-in excludes, config excludes, `.gitignore`, and `.treedocs/.treedocs_ignore`
+- Validates `treedocs.yaml` against the bundled JSON Schema
+- Renders full trees, subtrees, and shallow exploration views
+- Searches paths and descriptions for shell workflows
+
+## YAML Shape
+
+Generated files include a YAML language-server schema header and use schema version `0.2.0`:
+
+```yaml
+# yaml-language-server: $schema=https://dandylyons.github.io/treedocs/schemas/0.2.0/treedocs.schema.json
+schema_version: "0.2.0"
+project:
+  name: example
+  version: "0.0.0"
+  last_updated: "2026-07-05"
+signature: "sha256:..."
+tree:
+  README.md: Project overview
+  src:
+    _doc:
+      _description: Source files
+      _references:
+        - DOCS/Architecture.md
+    cli.ts: Command-line entrypoint
+```
+
+Directory documentation is stored under `_doc`. File entries can be compact strings or mappings with `_description`, `_references`, and `_link`.
+
+## Configuration
+
+Configuration is merged in this order:
+
+1. Built-in defaults
+2. `~/.config/treedocs/config.yaml`
+3. `.treedocs/config.yaml`
+4. `treedocs.yaml` `overrides`
+
+Supported keys:
+
+```yaml
+exclude:
+  - Generated/
+use_gitignore: true
+max_description_length: 120
+indent_size: 2
+align_columns: false
+check_severity: error # error or warn
+```
+
+Standard scanner excludes are `.git/`, `.build/`, `.swiftpm/`, `.treedocs/`, `.agents/`, `.opencode/`, `node_modules/`, and `treedocs.yaml`.
+
+## Development
+
+```bash
+bun install
+bun run typecheck
+bun run lint
+bun test
+bun run build
+bun run check
+```
+
+The package uses:
+
+- Bun for runtime, tests, and bundling
+- TypeScript for implementation
+- Biome with its default recommended formatting/linting setup
+- `yaml` for YAML parsing/serialization
+- `ajv` for JSON Schema validation
+
+## Publish
+
+Build and verify before publishing:
+
+```bash
+bun run check
+bun run build
+npm publish
+```
+
+The npm package ships `dist/treedocs.js`, `src/`, the bundled schema under `site/schemas/`, `README.md`, and `LICENSE`.