@anhcodo13/lattice 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KhucHieuNghi
+
+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

@@ -1,3 +1,71 @@
-# Temporary Holding Version
+# NKLattice
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+NKLattice is an independent, local CLI for architecture analysis and dependency governance across Next.js, Vite + React, and React applications. It supports standalone repositories and npm or pnpm workspaces.
+
+**Tiếng Việt:** NKLattice phân tích kiến trúc mã nguồn và kiểm tra phiên bản thư viện theo một policy chung cho nhiều ứng dụng Next.js, Vite và React. Xem [tài liệu tiếng Việt](https://khuchieunghi.github.io/nklattice/vi/docs/introduction/).
+
+## Install the CLI
+
+Requires Node.js 24 or newer. The npm package is `@anhcodo13/lattice`; the executable is `lattice`.
+
+```sh
+npm install --global @anhcodo13/lattice@0.1.0
+lattice --version
+lattice governance check path/to/app --expect-apps 1
+```
+
+## Build and try the source
+
+The source checkout uses pnpm 10.30.3:
+
+```sh
+corepack enable
+pnpm install --frozen-lockfile
+pnpm verify
+node dist/cli.js doctor examples/governance/apps/vite
+node dist/cli.js analyze examples/governance/apps/vite
+node dist/cli.js governance check examples/governance \
+  --workspace-root examples/governance \
+  --policy governance/policy.json --expect-apps 3
+```
+
+The analysis writes `report.html` and `analysis.json` into the app's `.nklattice-report/` directory. The HTML opens offline.
+
+## Architecture analysis
+
+NKLattice scans supported JS/TS and JSX/TSX files, resolves local imports, builds a module graph, and reports cycles, dependency concentration, long chains, duplicate imports, unused internal exports, component size, JSX depth, and approximate complexity. Define boundary policies and adjust thresholds or score weights in `.nklattice.json`.
+
+```sh
+node dist/cli.js init path/to/app
+node dist/cli.js analyze path/to/app --output path/to/report
+```
+
+The score is an explainable review aid, not a claim about runtime speed or correctness. See [findings](https://khuchieunghi.github.io/nklattice/docs/findings/) and [scoring](https://khuchieunghi.github.io/nklattice/docs/scoring/).
+
+## Dependency governance
+
+The versioned [central policy](governance/policy.json) requires exact versions. For each supported app, the CLI checks direct `package.json` declarations **and** matching npm/pnpm lockfile resolution. It returns exit `7` on drift and exit `3` for invalid input. The result lists the approved, declared, and locked versions.
+
+Profiles are `next`, `vite-react`, and `react`. NKLattice can infer them from direct dependencies or read an explicit app profile:
+
+```json
+{ "nklattice": { "profile": "next" } }
+```
+
+The [reusable governance workflow](.github/workflows/governance-check.yml) requires a reviewed 40-character `core-ref` and an `expected-apps` count. It checks out the CLI and policy from that commit, then fails if the number of managed apps differs. The [consumer workflow template](examples/consumer-workflow.yml) pins both the workflow `uses` ref and `core-ref` to the same SHA, with deployment depending on the governance job. Replace its placeholders and set `expected-apps` for each consuming repository. For a pnpm monorepo, pass its root as `--workspace-root` when running the CLI directly.
+
+```sh
+node dist/cli.js governance check ./my-app --policy ./governance/policy.json
+node dist/cli.js governance check ./monorepo/apps \
+  --workspace-root ./monorepo --policy ./governance/policy.json --expect-apps 3 --json
+```
+
+## Website and documentation
+
+- [English](https://khuchieunghi.github.io/nklattice/) · [Tiếng Việt](https://khuchieunghi.github.io/nklattice/vi/)
+- [Documentation](https://khuchieunghi.github.io/nklattice/docs/introduction/) · [Tài liệu](https://khuchieunghi.github.io/nklattice/vi/docs/introduction/)
+- [Strategy](STRATEGY.md) · [Roadmap](ROADMAP.md) · [Changelog](CHANGELOG.md)
+
+Build the Astro/Starlight website with `pnpm --dir docs install --frozen-lockfile && pnpm --dir docs verify`.
+
+NKLattice is released under the [MIT License](LICENSE).

package/dist/cli.d.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+interface CliOutput {
+    out(text: string): void;
+    err(text: string): void;
+}
+declare function runCli(arguments_: string[], output?: CliOutput): Promise<number>;
+
+export { type CliOutput, runCli };