@coinagerie/output 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +32 -32
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ ## 0.0.4 (2026-11-04)
2
+
3
+ ### 🧱 Updated Dependencies
4
+
5
+ - Updated coinagerie-configuration to 0.0.4
6
+ - Updated coinagerie-core to 0.0.4
7
+
8
+ ## 0.0.3 (2026-11-04)
9
+
10
+ ### 🧱 Updated Dependencies
11
+
12
+ - Updated coinagerie-configuration to 0.0.3
13
+ - Updated coinagerie-core to 0.0.3
14
+
1
15
  ## 0.0.2 (2026-11-04)
2
16
 
3
17
  ### 🧱 Updated Dependencies
package/README.md CHANGED
@@ -24,31 +24,31 @@ This project was generated from the [nestjs-service-project](../../configuration
24
24
 
25
25
  The words this package uses that the root glossary does not define, regenerated with `nx run coinagerie-output:coinagerie-check:write`.
26
26
 
27
- - **anchor**:
28
- - **boundary**:
29
- - **breadth**:
30
- - **bullet**:
31
- - **comparison**:
32
- - **continuation**:
33
- - **deliver**:
34
- - **delivery**:
35
- - **destination**:
36
- - **flush**:
37
- - **glossary**:
38
- - **hand**:
39
- - **lone**:
40
- - **malformed**:
41
- - **preamble**:
42
- - **reconcile**:
43
- - **refuse**:
44
- - **reload**:
45
- - **splice**:
46
- - **stale**:
47
- - **structural**:
48
- - **tokenize**:
49
- - **unmock**:
50
- - **unsorted**:
51
- - **vocabulary**:
27
+ - **anchor**: The HTML comment markers coinagerie:start and coinagerie:end that bracket the managed block in a markdown file.
28
+ - **boundary**: Edge where glossary text enters the package, where it is parsed and validated before any comparison or write happens.
29
+ - **breadth**: The maximumBreadth limit, set to four in this project's callidescope configuration, bounding callees per function.
30
+ - **bullet**: One word's entry in a glossary block, written as a dash, bolded word, and colon, read by the markdown parser.
31
+ - **comparison**: Outcome of ComparisonService.compare, listing missing words and stale words that a glossary and the codebase disagree on.
32
+ - **continuation**: An indented line that extends the definition of the bullet above it, joined to that word's text with newlines.
33
+ - **deliver**: Verb for handing a glossary comparison to a destination, through DeliveryService check or write.
34
+ - **delivery**: The DeliveryService and its module, which check or write glossaries to every configured destination.
35
+ - **destination**: An output file a glossary is rendered into: an anchored markdown block or a whole JSON file.
36
+ - **flush**: Method that stores the word being read with its joined lines, then clears the reader's current word and blank count.
37
+ - **glossary**: The map from each word to its definition, which the parsers fill and comparison checks against the codebase.
38
+ - **hand**: Manually written or manually scanned: tests use hand-written blocks, and tokenizing scans JSON by hand rather than regex.
39
+ - **lone**: A single start or end marker found without its partner, which the parser refuses since a block needs both.
40
+ - **malformed**: Glossary text the parser cannot read, which raises MalformedGlossaryError rather than being guessed at.
41
+ - **preamble**: Free text opening a generated block, made of the start anchor, heading, and description before the bullets.
42
+ - **reconcile**: Rewrites a glossary to exactly the codebase vocabulary, sorted, keeping existing definitions and dropping stale words.
43
+ - **refuse**: Rejects input the parser cannot read by throwing, such as a word listed twice in JSON.
44
+ - **reload**: Re-imports a module fresh inside a test so decorator metadata is read again for the delivery service.
45
+ - **splice**: Inserts or replaces the anchored block inside a file's content, preserving that file's own CRLF or LF line endings.
46
+ - **stale**: A word still defined in a glossary that the codebase no longer uses, and which reconcile drops.
47
+ - **structural**: The brackets, braces, comma and colon that carry JSON structure, which the tokenizer separates from literal text.
48
+ - **tokenize**: Splits already-valid JSON into strings, punctuation, and literals so a duplicated key can be found by hand.
49
+ - **unmock**: Calls vi.doUnmock to restore real modules in delivery tests after they were replaced by mocks.
50
+ - **unsorted**: Test input whose words are out of order, used to show reconcile sorts a glossary's words.
51
+ - **vocabulary**: The set of words the codebase uses, which comparison checks each glossary against to find missing or stale words.
52
52
 
53
53
  <!-- coinagerie:end -->
54
54
 
@@ -236,7 +236,7 @@ graph LR
236
236
  ### Project
237
237
 
238
238
  ![Lines of Code](https://img.shields.io/badge/Lines_of_Code-1985-22c55e?style=flat-square)
239
- ![Repository Size](https://img.shields.io/badge/Repository_Size-71.31_kB-6b7280?style=flat-square)
239
+ ![Repository Size](https://img.shields.io/badge/Repository_Size-71.57_kB-6b7280?style=flat-square)
240
240
  ![Folders](https://img.shields.io/badge/Folders-7-4a4a4a?style=flat-square)
241
241
  ![Source Files](https://img.shields.io/badge/Source_Files-31-3178c6?style=flat-square)
242
242
 
@@ -420,16 +420,16 @@ graph LR
420
420
  ### Markdown
421
421
 
422
422
  ![Markdown Files](https://img.shields.io/badge/Markdown_Files-2-083fa1?style=flat-square)
423
- ![Markdown Lines](https://img.shields.io/badge/Markdown_Lines-242-1f6feb?style=flat-square)
423
+ ![Markdown Lines](https://img.shields.io/badge/Markdown_Lines-256-1f6feb?style=flat-square)
424
424
  ![H1](https://img.shields.io/badge/H1-1-7c3aed?style=flat-square)
425
- ![H2](https://img.shields.io/badge/H2-9-8b5cf6?style=flat-square)
426
- ![H3](https://img.shields.io/badge/H3-15-a78bfa?style=flat-square)
425
+ ![H2](https://img.shields.io/badge/H2-11-8b5cf6?style=flat-square)
426
+ ![H3](https://img.shields.io/badge/H3-17-a78bfa?style=flat-square)
427
427
  ![H4](https://img.shields.io/badge/H4-0-c4b5fd?style=flat-square)
428
428
  ![H5](https://img.shields.io/badge/H5-0-ddd6fe?style=flat-square)
429
429
  ![H6](https://img.shields.io/badge/H6-0-ede9fe?style=flat-square)
430
- ![Paragraphs](https://img.shields.io/badge/Paragraphs-53-64748b?style=flat-square)
431
- ![Lists](https://img.shields.io/badge/Lists-9-16a34a?style=flat-square)
432
- ![List Items](https://img.shields.io/badge/List_Items-33-22c55e?style=flat-square)
430
+ ![Paragraphs](https://img.shields.io/badge/Paragraphs-57-64748b?style=flat-square)
431
+ ![Lists](https://img.shields.io/badge/Lists-11-16a34a?style=flat-square)
432
+ ![List Items](https://img.shields.io/badge/List_Items-37-22c55e?style=flat-square)
433
433
  ![Task List Items](https://img.shields.io/badge/Task_List_Items-0-4ade80?style=flat-square)
434
434
  ![Tables](https://img.shields.io/badge/Tables-2-0284c7?style=flat-square)
435
435
  ![Table Rows](https://img.shields.io/badge/Table_Rows-10-0ea5e9?style=flat-square)
package/package.json CHANGED
@@ -4,8 +4,8 @@
4
4
  "url": "https://github.com/organizzolini/codebase/issues"
5
5
  },
6
6
  "dependencies": {
7
- "@coinagerie/configuration": "0.0.2",
8
- "@coinagerie/core": "0.0.2",
7
+ "@coinagerie/configuration": "0.0.4",
8
+ "@coinagerie/core": "0.0.4",
9
9
  "@nestjs/common": "^11.1.21 || ^12.0.1",
10
10
  "reflect-metadata": "^0.2.2"
11
11
  },
@@ -57,5 +57,5 @@
57
57
  "strict": true
58
58
  },
59
59
  "types": "./dist/src/index.d.ts",
60
- "version": "0.0.2"
60
+ "version": "0.0.4"
61
61
  }