@codometer/output 0.0.64 → 0.0.65
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.
- package/CHANGELOG.md +8 -0
- package/README.md +67 -67
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -370,7 +370,7 @@ graph LR
|
|
|
370
370
|
### Project
|
|
371
371
|
|
|
372
372
|
|
|
373
|
-
|
|
374
374
|
|
|
375
375
|
|
|
376
376
|
|
|
@@ -558,16 +558,16 @@ graph LR
|
|
|
558
558
|
### Markdown
|
|
559
559
|
|
|
560
560
|
|
|
561
|
-
|
|
562
562
|
|
|
563
|
-
|
|
564
|
+
|
|
565
565
|
|
|
566
566
|
|
|
567
567
|
|
|
568
|
-
|
|
569
|
+
|
|
570
|
+
|
|
571
571
|
|
|
572
572
|
|
|
573
573
|
|
|
@@ -585,65 +585,65 @@ graph LR
|
|
|
585
585
|
|
|
586
586
|
The words this project uses that the root glossary does not define, regenerated with `nx run codometer-output:coinagerie-check:write`.
|
|
587
587
|
|
|
588
|
-
- **ab**:
|
|
589
|
-
- **absent**:
|
|
590
|
-
- **ambiguous**:
|
|
591
|
-
- **anchor**:
|
|
592
|
-
- **badge**:
|
|
593
|
-
- **baseline**:
|
|
594
|
-
- **breach**:
|
|
595
|
-
- **breadth**:
|
|
596
|
-
- **bullet**:
|
|
597
|
-
- **choose**:
|
|
598
|
-
- **comparison**:
|
|
599
|
-
- **compression**:
|
|
600
|
-
- **conditional**:
|
|
601
|
-
- **counter**:
|
|
602
|
-
- **deliver**:
|
|
603
|
-
- **delivery**:
|
|
604
|
-
- **delta**:
|
|
605
|
-
- **destination**:
|
|
606
|
-
- **discovery**:
|
|
607
|
-
- **doc**:
|
|
608
|
-
- **docstring**:
|
|
609
|
-
- **evaluate**:
|
|
610
|
-
- **fresh**:
|
|
611
|
-
- **generic**:
|
|
612
|
-
- **govern**:
|
|
613
|
-
- **hcl**:
|
|
614
|
-
- **interpolation**:
|
|
615
|
-
- **javascript**:
|
|
616
|
-
- **jupyter**:
|
|
617
|
-
- **level1**:
|
|
618
|
-
- **level2**:
|
|
619
|
-
- **level3**:
|
|
620
|
-
- **level4**:
|
|
621
|
-
- **level5**:
|
|
622
|
-
- **level6**:
|
|
623
|
-
- **marker**:
|
|
624
|
-
- **measure**:
|
|
625
|
-
- **measurement**:
|
|
626
|
-
- **nb**:
|
|
627
|
-
- **newline**:
|
|
628
|
-
- **notebook**:
|
|
629
|
-
- **paragraph**:
|
|
630
|
-
- **pipeline**:
|
|
631
|
-
- **preamble**:
|
|
632
|
-
- **py**:
|
|
633
|
-
- **replacement**:
|
|
634
|
-
- **retire**:
|
|
635
|
-
- **sample**:
|
|
636
|
-
- **scalar**:
|
|
637
|
-
- **selector**:
|
|
638
|
-
- **severity**:
|
|
639
|
-
- **shebang**:
|
|
640
|
-
- **splice**:
|
|
641
|
-
- **stale**:
|
|
642
|
-
- **statistic**:
|
|
643
|
-
- **thematic**:
|
|
644
|
-
- **todo**:
|
|
645
|
-
- **toml**:
|
|
646
|
-
- **trail**:
|
|
647
|
-
- **unreadable**:
|
|
588
|
+
- **ab**: Two-letter headword with no source occurrence here, so it names nothing in this project and should be dropped.
|
|
589
|
+
- **absent**: Describes a report or field that a reader tolerates missing, so the run treats it as no data rather than an error.
|
|
590
|
+
- **ambiguous**: Field of a target's metric index listing names that resolve to more than one instance, kept apart from unambiguous ones.
|
|
591
|
+
- **anchor**: Start and end marker comments that bracket a generated block in a markdown file, so a sync replaces only that span.
|
|
592
|
+
- **badge**: Shields-style markdown image line rendering one measured statistic, grouped into per-language sections of the generated codometer block.
|
|
593
|
+
- **baseline**: The previous codometer report a changes run diffs against, joined per project to produce each row's base value and delta.
|
|
594
|
+
- **breach**: Flag on a metric row recording that its value exceeded a configured limit, with the severity of the worst limit breached.
|
|
595
|
+
- **breadth**: Callidescope measure counting how many distinct callees a callable invokes directly, checked against the project's maximumBreadth limit.
|
|
596
|
+
- **bullet**: Markdown list item the generated block emits for each instance of a custom statistic, naming the location it came from.
|
|
597
|
+
- **choose**: Plain verb with no special meaning here; no source file uses it, so the entry is a stray headword.
|
|
598
|
+
- **comparison**: Rendered section that lays current measurements beside a baseline report, and the staleness check that compares generated output bytes to disk.
|
|
599
|
+
- **compression**: Gzip-versus-raw label attached to a size statistic, so a compressed figure is never mistaken for a raw byte count.
|
|
600
|
+
- **conditional**: Branching construct counted in shell scripts and drawn as the Shell Conditionals badge in the generated codometer block.
|
|
601
|
+
- **counter**: Named measurement tally, such as a custom convention, that the pipeline produces and the badge block must always render.
|
|
602
|
+
- **deliver**: Method on DeliveryService that produces every resolved output for a run and returns the names of stale ones.
|
|
603
|
+
- **delivery**: The module and service that write every resolved output for a run, then report which written outputs are stale.
|
|
604
|
+
- **delta**: Signed difference between a current value and its baseline, formatted with an em dash when there is nothing to compare.
|
|
605
|
+
- **destination**: A configured output target, such as a markdown file, JSON file, or console, that a run writes its report to.
|
|
606
|
+
- **discovery**: Gitignore-aware file walk shared with measurement, so the configuration listing finds the same files a run would measure.
|
|
607
|
+
- **doc**: Count of TypeScript documentation comment blocks, shown as the Doc Comments badge in the generated block.
|
|
608
|
+
- **docstring**: Tally of lines inside Python triple-quoted documentation strings, shown as a badge in the generated block.
|
|
609
|
+
- **evaluate**: Ordinary English verb with no project meaning; no source file uses it, so this headword is stray.
|
|
610
|
+
- **fresh**: Adjective for a generated output that matches a current run exactly, so a check reports it up to date rather than stale.
|
|
611
|
+
- **generic**: TypeScript tally of declarations that take type parameters, drawn as the Generic Declarations badge in the block.
|
|
612
|
+
- **govern**: Private ChangesService method that picks the limits deciding a metric's verdict: the failing ones when any breached, otherwise every limit.
|
|
613
|
+
- **hcl**: Tallies from HashiCorp Configuration Language files, rendered as one badge group in the generated codometer block.
|
|
614
|
+
- **interpolation**: Count of template expressions inside HashiCorp configuration files, shown as the HCL Interpolations badge in the generated block.
|
|
615
|
+
- **javascript**: Language group in the generated block covering JavaScript source, including the compiled size checked against a configured limit.
|
|
616
|
+
- **jupyter**: Language group for Jupyter notebooks in the generated block, counting notebook files, cells, classes and code lines.
|
|
617
|
+
- **level1**: Markdown statistic counting H1 headings, drawn as the H1 badge in the Markdown group of the generated block.
|
|
618
|
+
- **level2**: Markdown statistic counting H2 headings, drawn as the H2 badge in the Markdown group of the generated block.
|
|
619
|
+
- **level3**: Markdown statistic counting H3 headings, drawn as the H3 badge in the Markdown group of the generated block.
|
|
620
|
+
- **level4**: Markdown statistic counting H4 headings, drawn as the H4 badge in the Markdown group of the generated block.
|
|
621
|
+
- **level5**: Markdown statistic counting H5 headings, drawn as the H5 badge in the Markdown group of the generated block.
|
|
622
|
+
- **level6**: Markdown statistic counting H6 headings, drawn as the H6 badge in the Markdown group of the generated block.
|
|
623
|
+
- **marker**: String delimiting an anchored or document block, or a file such as .git whose presence marks a repository root.
|
|
624
|
+
- **measure**: Verb for running a codometer metric over the workspace, and noun for one measured value a limit can be checked against.
|
|
625
|
+
- **measurement**: Result of a codometer run over one project: the statistics and metrics that badges, reports, and limit checks read.
|
|
626
|
+
- **nb**: Short alias for the Jupyter statistics, destructured as nb so the notebook badges read compactly in the renderer.
|
|
627
|
+
- **newline**: Line terminator a generated markdown or JSON file must end with exactly once, since extra ones fail lint and staleness checks.
|
|
628
|
+
- **notebook**: Jupyter file whose cells, code lines, and classes feed the Notebook badges in the Jupyter group.
|
|
629
|
+
- **paragraph**: Markdown text run that the anchor writer separates from a preceding HTML comment with a blank line.
|
|
630
|
+
- **pipeline**: Ordered measurement stages a codometer run passes through, from parsing source files to producing the reports.
|
|
631
|
+
- **preamble**: Existing markdown content with trailing newlines trimmed and two newlines added, placed before a newly appended anchored block.
|
|
632
|
+
- **py**: Short alias for the Python statistics, destructured as py so the Python Files and Python Lines badges read compactly.
|
|
633
|
+
- **replacement**: Text swapped into an existing block via a callback, so a dollar sign in rendered markdown is never read as a pattern.
|
|
634
|
+
- **retire**: Metric that existed in the baseline but is missing from the current report, shown as removed with a zero value.
|
|
635
|
+
- **sample**: Test fixture standing in for a real report or statistics object, such as sampleReport and sampleStatistics in unit tests.
|
|
636
|
+
- **scalar**: Count of YAML values that are plain leaves rather than mappings or sequences, shown as the YAML Scalars badge.
|
|
637
|
+
- **selector**: Per-instance key in a custom statistic's configuration, such as the comment selector, that splits its breaches by instance.
|
|
638
|
+
- **severity**: Level of a breached limit, either fail or warn, where a failing breach outranks an advisory one in verdicts.
|
|
639
|
+
- **shebang**: Shell script first-line interpreter directive, the hash-bang line, tallied in the Shell group and drawn as the Shebangs badge.
|
|
640
|
+
- **splice**: Method on DocumentsService that replaces the section between markers in a document, leaving everything outside them untouched.
|
|
641
|
+
- **stale**: A committed output that no longer matches a regenerated run, so a check fails until it is rewritten.
|
|
642
|
+
- **statistic**: One measured value, such as a count or size, that a configuration names and the renderer groups into a badge.
|
|
643
|
+
- **thematic**: Markdown horizontal rule tally, lines of three or more dashes, asterisks, or underscores, shown as the Thematic Breaks badge.
|
|
644
|
+
- **todo**: Tally of marker comments left in JavaScript source for later work, shown as the TODO Comments badge.
|
|
645
|
+
- **toml**: Badge group for Tom's Obvious Minimal Language files, with the file and table counts drawn in the generated block.
|
|
646
|
+
- **trail**: Run of line terminators at a file's end, matched by TRAILING_NEWLINES and stripped before an anchored block is appended.
|
|
647
|
+
- **unreadable**: Report or config file that cannot be read or parsed; it is skipped with a warning instead of failing the whole run.
|
|
648
648
|
|
|
649
649
|
<!-- coinagerie:end -->
|
package/package.json
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
"url": "https://github.com/organizzolini/codebase/issues"
|
|
5
5
|
},
|
|
6
6
|
"dependencies": {
|
|
7
|
-
"@codometer/configuration": "0.0.
|
|
8
|
-
"@codometer/core": "0.0.
|
|
9
|
-
"@codometer/measurement": "0.0.
|
|
7
|
+
"@codometer/configuration": "0.0.65",
|
|
8
|
+
"@codometer/core": "0.0.65",
|
|
9
|
+
"@codometer/measurement": "0.0.65",
|
|
10
10
|
"@nestjs/common": "^11.1.21 || ^12.0.1",
|
|
11
11
|
"pino": "^10.3.1",
|
|
12
12
|
"pino-pretty": "^13.1.3",
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"strict": true
|
|
64
64
|
},
|
|
65
65
|
"types": "./dist/src/index.d.ts",
|
|
66
|
-
"version": "0.0.
|
|
66
|
+
"version": "0.0.65"
|
|
67
67
|
}
|