@coinagerie/vocabulary 0.0.16 → 0.0.18

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.0.18 (2026-11-11)
+
+### 🚀 Features
+
+- **codometer:** ✨ tighten the comment budgets and shorten every comment over them ([#2262](https://github.com/organizzolini/codebase/pull/2262), [#2261](https://github.com/organizzolini/codebase/issues/2261))
+
+### 🧱 Updated Dependencies
+
+- Updated coinagerie-configuration to 0.0.18
+- Updated coinagerie-languages to 0.0.18
+
+## 0.0.17 (2026-11-10)
+
+### 🚀 Features
+
+- **codometer:** ✨ gate JSDoc on every declaration kind and shorten long comments ([#2227](https://github.com/organizzolini/codebase/pull/2227), [#2226](https://github.com/organizzolini/codebase/issues/2226))
+
+### 🧱 Updated Dependencies
+
+- Updated coinagerie-configuration to 0.0.17
+- Updated coinagerie-languages to 0.0.17
+
 ## 0.0.16 (2026-11-10)
 
 ### 🧱 Updated Dependencies

package/dist/src/index.d.ts

@@ -32,30 +32,23 @@ export declare class DiscoveryService {
     private readonly ignoreRulesService;
     constructor(ignoreRulesService: IgnoreRulesService);
     /**
-     * The nearest folder at or above the root holding a `.git` entry, or the
-     * root itself outside any repository. A worktree's `.git` is a file, which
-     * counts the same.
+     * The nearest folder at or above `directory` holding `.git`, or `directory` itself. A worktree's `.git` file counts.
      */
     private findRepositoryRoot;
     /**
-     * Whether an `exclude.paths` glob names a folder outright, which excludes
-     * everything in it — so `exclude: ["dist"]` reads the way a `.gitignore`
-     * line does, and the folder is never walked.
+     * Whether an `exclude.paths` glob names a whole folder, so the folder is never walked, as a `.gitignore` line would.
      */
     private isExcludedFolder;
     /** Whether the configuration's globs keep a root-relative file. */
     private isSelected;
     /**
-     * The ignore files of every folder from the repository root down to, but
-     * not including, the scan root — whose own file the walk reads.
+     * Ignore files from the repository root down to, excluding, the scan root, whose own file the walk reads.
      */
     private readAncestorScopes;
     /** A path with forward slashes, which is what every glob is written in. */
     private toPosix;
     /**
-     * Every file under one folder that no ignore file claims, as absolute
-     * paths. Symbolic links are skipped rather than followed, so nothing is
-     * read twice and a link to an ancestor cannot loop.
+     * Every unignored file under one folder, as absolute paths. Symbolic links are skipped, so nothing is read twice or loops.
      */
     private walk;
     /**
@@ -70,27 +63,19 @@ export declare class FoldingModule {
 }
 
 /**
- * Folds the surface forms of a word into one headword, so the glossary lists
- * a term once however the code inflects it.
+ * Folds a word's surface forms into one headword, so each term is listed once.
  *
- * Plurals fold into their singular and inflected verbs into their lemma:
- * `aspects` into `aspect`, `configured` and `configuring` into `configure`.
- * Derivational families stay apart, so `configuration` keeps its own entry —
- * unless the configuration's own `fold` merges them.
+ * Plurals fold into their singular and inflected verbs into their lemma: `aspects` into `aspect`, `configured` into `configure`.
+ * Derivational families stay apart, so `configuration` keeps its own entry unless `fold` merges them.
  */
 export declare class FoldingService {
     constructor();
     /**
-     * The headword a lowercase word folds into: its singular, then its lemma.
-     *
-     * A fold that would leave a single letter (`ts` into `t`) is refused, since
-     * one-letter words are not terms.
+     * The headword a lowercase word folds into: its singular, then its lemma. A one-letter result is refused, since one-letter words are not terms.
      */
     fold(word: string): string;
     /**
-     * The headword a word is listed under: folded into its singular and lemma,
-     * then through the configuration's own `fold` when it has one. A fault in
-     * that function surfaces as an `InvalidConfigurationError` naming the file.
+     * The headword a word is listed under: folded, then passed through the configuration's `fold` when it has one. Faults name the file.
      */
     headword(word: string, configuration: ResolvedCoinagerieConfiguration): string;
 }
@@ -106,26 +91,16 @@ declare class IgnoreRulesService {
     /** A path as a scope sees it, or `undefined` when it lies outside the scope. */
     private toScopedPath;
     /**
-     * Whether the scopes ignore a repository-relative path, the innermost
-     * deciding — which is how a nested `!pattern` re-includes a file its parent
-     * ignored. A folder is judged with a trailing slash.
+     * Whether the scopes ignore a repository-relative path. The innermost scope decides, so a nested `!pattern` re-includes a file.
      */
     isIgnored(scopes: IgnoreScope[], relativePath: string): boolean;
     /**
-     * Reads one ignore file, or `undefined` when it does not exist.
-     *
-     * Case-sensitive on every platform, so the same file ignores the same paths
-     * on a developer's machine and in CI.
+     * Reads one ignore file, or `undefined` when absent. Matching is case-sensitive on every platform, so CI agrees with local runs.
      */
     readScope(args: ReadIgnoreScopeArguments): IgnoreScope | undefined;
 }
 
-/**
- * The rules of one `.gitignore`, and the folder they were written in.
- *
- * `base` is relative to the repository root, `""` for the root itself; the
- * patterns only ever see paths relative to it.
- */
+/** A `.gitignore`'s rules and folder; `base` is repo-relative. */
 declare interface IgnoreScope {
     base: string;
     matcher: Ignore;
@@ -145,15 +120,10 @@ export declare class VocabularyModule {
 }
 
 /**
- * The coinagerie pipeline: from a configuration to the sorted list of every
- * word the code uses.
- *
- * Discovers the files, splits every path into words, tokenizes every file a
- * language claims and splits its identifiers into words, folds each word into
- * its headword, leaves out the headwords the configuration excludes, then
- * de-duplicates and sorts. A fault in the configuration's `fold` aborts the
- * run, naming the configuration file. A file no language claims still
- * contributes its path.
+ * The coinagerie pipeline: from a configuration to the sorted words the code
+ * uses. Splits paths and identifiers into words, folds each into its headword,
+ * drops excluded headwords, then de-duplicates. A fault in `fold` aborts the
+ * run, naming the configuration file.
  */
 export declare class VocabularyService {
     private readonly discoveryService;
@@ -164,22 +134,13 @@ export declare class VocabularyService {
     /** The words of one file: its path's, then its identifiers'. */
     private collectFile;
     /**
-     * The headwords the configuration leaves out by exact word.
-     *
-     * Its words are folded the way the code's are, so exclusion compares
-     * headwords: excluding `service` covers `services`, and excluding
-     * `implements` covers the `implement` it folds into.
+     * The headwords the configuration excludes by exact word. Words fold the way code words do, so excluding `service` covers `services`.
      */
     private excludedHeadwords;
     /** Whether a pattern leaves out a word: it matches the word or its headword. */
     private matchesPattern;
     /**
-     * Every word the configured files use, sorted and de-duplicated.
-     *
-     * The files a configuration writes a glossary to are left out, so a run
-     * never reads its own output back as vocabulary. A headword a pattern
-     * matches is left out wholly, as a string leaves out a headword: the pattern
-     * is tested against each occurrence's lowercase word and its headword.
+     * Every word the configured files use, sorted and de-duplicated. Output files are skipped, so a run never reads its own glossary back.
      */
     collect(configuration: ResolvedCoinagerieConfiguration): Promise<string[]>;
 }
@@ -202,16 +163,11 @@ export declare class WordsService {
     /** Whether a lowercase word is a term rather than noise. */
     private isTerm;
     /**
-     * The words of one identifier, in the order written, repeats kept.
-     *
-     * Splits on every separator, then on case changes, keeping acronym runs
-     * together: `XMLHttpRequest` is `xml`, `http`, and `request`.
+     * The words of one identifier, in order, repeats kept. Splits on separators and case changes, keeping acronyms whole: `XMLHttpRequest` is `xml`, `http`, and `request`.
      */
     splitIdentifier(raw: string): string[];
     /**
-     * The words of a relative file path: every folder name, and the file name
-     * with only its final extension removed, so `glossary.service.ts`
-     * contributes `glossary` and `service`.
+     * The words of a relative file path: every folder name, plus the file name without its final extension.
      */
     splitPath(relativePath: string): string[];
 }

package/package.json

@@ -4,8 +4,8 @@
     "url": "https://github.com/organizzolini/codebase/issues"
   },
   "dependencies": {
-    "@coinagerie/configuration": "0.0.16",
-    "@coinagerie/languages": "0.0.16",
+    "@coinagerie/configuration": "0.0.18",
+    "@coinagerie/languages": "0.0.18",
     "@nestjs/common": "^11.1.21 || ^12.0.1",
     "ignore": "7.0.14",
     "pluralize": "^8.0.0",
@@ -62,5 +62,5 @@
     "strict": true
   },
   "types": "./dist/src/index.d.ts",
-  "version": "0.0.16"
+  "version": "0.0.18"
 }