Architecture
4 pattern signals · 1 architecture pattern · 1 framework signal · 10 top-level directories
Here's what jsdoc-scribe found by reading your package.json and folder structure — no guessing beyond what's actually on disk. Every line below says what it saw and where.
WHAT KIND OF PROJECT IS THIS(4 signals)
These aren't mutually exclusive — real repos usually match more than one pattern at once. That's expected, not a contradiction.
CLI tool
package.json declares a
bin entry (gen-comments, gen-docs) — this can be run as a command from the terminal.Publishable library
package.json defines an
exports field — that's how a package exposes its public API to whoever installs it.Monorepo (npm workspaces)
this repo hosts 1 workspace package (
eslint-plugin-jsdoc-scribe) under one root, managed via npm workspaces.Layered/service-oriented layout
directory names like
routes/, services/ suggest the code is organized by responsibility, in layers.ARCHITECTURAL PATTERN(1 detected)
Detected from this project's own folder names, dependencies, and root-level config files — not mutually exclusive, and not a judgement of code quality. Each one links out to further reading.
Layered (N-Tier)
directories present: controllers, services, routes
Code is split into horizontal layers -- typically presentation, business logic, and data access -- where each layer only depends on the one beneath it. This keeps concerns separated and layers independently replaceable, at the cost of a change sometimes rippling through every layer.
Learn more WHAT IT'S BUILT WITH(1 signal)
FILE PATTERN
React
no
react dependency found, but the codebase has .tsx files, which is a common signal for React.HOW IT'S ORGANIZED(10 top-level directories)
Workspace packages
eslint-plugin-jsdoc-scribe
packages/eslint-plugin-jsdoc-scribe
JSDoc validation rules for ESLint, powered by jsdoc-scribe's native lint engine. Flat config only.
.github2 folders1 other
CI workflows (test/docs/publish) and issue/PR templates.
ISSUE_TEMPLATE2 other
workflows6 other
assets36 other
Static assets referenced by generated documentation (images, etc.).
bin2 JavaScript
CLI entry points (gen-comments, gen-docs, gen-dashboard).
daily-report15 other
docs-site4 folders1 JavaScript
data1 JSON
docs9 other
Generated documentation site output (gen-docs) plus this project's own backlog (docs/backlog).
posts32 other
static1 other
lib3 TypeScript15 JavaScript
Core library -- pure, deterministic modules (extractor, renderer, coverage, drift, lint, fix, import-graph, project-facts, quality).
packages1 folder
npm workspaces -- sibling packages published alongside the root package (e.g. eslint-plugin-jsdoc-scribe).
eslint-plugin-jsdoc-scribe2 folders1 JavaScript1 JSON1 other
rules13 JavaScript
test2 JavaScript
Hand-rolled deterministic test suite, run via `npm test` (node test/run.js). No test framework.
sample6 folders6 TypeScript2 JavaScript
Fixture source files used by `npm run demo`/`npm run docs` to exercise the tool against real-ish code.
angular5 TypeScript
express4 folders1 TypeScript
controllers1 TypeScript
middleware1 TypeScript
routes1 TypeScript
services1 TypeScript
nestjs2 folders
auth1 TypeScript
users2 folders3 TypeScript
dto1 TypeScript
entities1 TypeScript
nextjs2 folders
app2 folders
api
users1 TypeScript
pages1 folder
users1 TypeScript
react4 TypeScript
vanilla-js4 JavaScript
scripts2 JavaScript
test18 JavaScript
Hand-rolled deterministic test suite, run via `npm test` (node test/run.js). No test framework.