jsdoc-scribe 1.0.0 → 1.0.1

package/README.md

@@ -43,7 +43,7 @@ dotfolder are skipped automatically.
 gen-comments src/utils.ts                  # preview only -> utils.commented.ts
 gen-comments .                              # scan whole project, preview only
 gen-comments . --write                      # scan whole project, edit in place
-gen-comments src --write --force             # also re-document already-commented files
+gen-comments src --write --force            # also re-document already-commented files
 ```
 
 If you run `--write` outside a git repo, the CLI prints a one-line warning
@@ -62,9 +62,9 @@ or revert against.
    - `VariableStatement` (`const`/`let`/`var`, including arrow/function inits)
    - `PropertyAssignment` with a function/arrow value inside an object literal
    - `InterfaceDeclaration`, `TypeAliasDeclaration`, `EnumDeclaration`
-3. **Skip** any node that already has a leading `/** ... */` block (checked
-   via `ts.getLeadingCommentRanges`) — unless `--force` is passed. This makes
-   the tool idempotent: running it twice never duplicates comments.
+3. **Skip** any node that already has a leading `/** ... */` block — unless
+   `--force` is passed. This keeps the tool idempotent: running it twice
+   never duplicates comments.
 4. **Build** the comment block from pure syntax only:
    - An explicit type annotation is always used as-is.
    - With no annotation, it falls back to a syntactic guess: literal kind for
@@ -75,10 +75,9 @@ or revert against.
    - Modifiers (`async`, `static`, `private`, `readonly`, `abstract`,
      `export`, generator `*`) are read directly off the AST node.
 5. **Insert** the comment as plain text at the exact byte offset where the
-   node's own line indentation begins. All edits across a file are collected
-   first, then applied **bottom-to-top** so earlier offsets never shift.
-   The rest of the file is never re-printed or reformatted — only insertions
-   happen.
+   node's own line indentation begins. All edits are collected first, then
+   applied bottom-to-top so earlier offsets never shift — the rest of the
+   file is never re-printed or reformatted, only insertions happen.
 6. **Write** the result — to `<file>.commented.<ext>` by default, or back to
    the original file with `--write`.
 
@@ -101,31 +100,11 @@ const files = collectFiles('src');
   there would mangle the call expression. Anything with its own declaration
   (function decl, class member, variable, named object property) is covered.
 - Type/return inference is 100% syntactic. It is never "smart" about what
-  your code *means* — only what it *looks like* structurally. That's the
-  whole point: deterministic, reproducible output, every time.
+  your code *means* — only what it *looks like* structurally.
 - Multi-declarator statements (`const a = 1, b = 2;`) get one combined block
   rather than a per-declarator function-style doc.
 - `.d.ts` files are skipped (no implementation to document).
 
-## Development
-
-```bash
-git clone <your-repo-url>
-cd jsdoc-scribe
-npm install
-npm test          # runs the self-test suite (test/run.js)
-npm run demo      # runs the CLI against the bundled example/ files
-```
-
-## Publishing new versions
-
-```bash
-npm version patch   # or minor / major
-npm publish
-```
-
-`prepublishOnly` runs the test suite automatically before every publish.
-
 ## License
 
 MIT

package/lib/index.js

@@ -1,7 +1,7 @@
 "use strict";
 
 /**
- * jsdoc-scribe — lib/index.js
+ * comment-block-generator — lib/index.js
  * ----------------------------------------
  * A PURE, deterministic, AST-based JSDoc comment generator.
  * No AI / LLM / external API is used anywhere — every comment line is

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "jsdoc-scribe",
-    "version": "1.0.0",
-    "description": "Pure AST-based JSDoc comment generator for JS/TS - no AI involved.",
+    "version": "1.0.1",
+    "description": "Pure, deterministic, AST-based JSDoc comment generator for JavaScript & TypeScript. No AI involved — every comment line comes straight from the syntax tree.",
     "main": "lib/index.js",
     "bin": {
         "gen-comments": "./bin/cli.js"