@coinagerie/core
v0.0.9
Published
Contracts for the coinagerie vocabulary toolchain: the glossary, the vocabulary report, and shared constants
Maintainers
Readme
@coinagerie/core
The contracts leaf of the coinagerie toolchain: the glossary and vocabulary-report shapes and the constants every other coinagerie package shares. It holds no behavior.
npm install @coinagerie/coreTest
nx run coinagerie-core:vitest👔 Conformetry
This project was generated from the nestjs-service-project conformetry template.
🪙 Coinagerie
The words this package uses that the root glossary does not define, regenerated with nx run coinagerie-core:coinagerie-check:write.
- anchor: The start and end HTML comment markers bounding the generated glossary block in a markdown destination, which the tool rewrites.
- breadth: The callee fan-out per function that callidescope caps here through maximumBreadth, set to one in this package's configuration.
- glossary: The headword-to-definition mapping a destination stores, listing each word the codebase uses with its meaning here.
- vocabulary: The set of words the codebase uses, which the report compares against each glossary destination to find missing and stale words.
🔭 Callidescope
Call stacks traced through projects/ic-suite/coinagerie/coinagerie-core, deepest first. Each frame shows what it takes, what it returns, and what its documentation says.
| Measure | Value | | --- | --- | | Callables | 4 | | Files | 12 | | Calls traced | 0 | | Call stacks | 0 | | Deepest stack | 0 | | Stacks through recursion | 0 | | Unfollowable calls | 3 |
Limits
What this project is judged against, as declared in its own callidescope.config.ts.
| Limit | Value |
| --- | --- |
| maximumDepth | 1 |
| maximumBreadth | 1 |
Call stacks (depth)
None.
Breadth
None.
🕸️ Codependix
Dependency graphs exported by codependix, regenerated by nx run configuration:codependix:write.
Nx Neighborhood
graph LR
coinagerie_cli["coinagerie-cli"]
coinagerie_configuration["coinagerie-configuration"]
coinagerie_core["coinagerie-core"]
coinagerie_output["coinagerie-output"]
coinagerie_cli --> coinagerie_core
coinagerie_configuration --> coinagerie_core
coinagerie_output --> coinagerie_core
classDef subject fill:#7c3aed,color:#fff,stroke:#4c1d95,stroke-width:2px
class coinagerie_core subjectNestJS Module Graph
flowchart LR
CoinagerieCoreModuleFile Imports
graph LR
file_callidescope_config_ts["callidescope.config.ts"]
file_codependix_config_ts["codependix.config.ts"]
file_codometer_config_ts["codometer.config.ts"]
file_coinagerie_config_ts["coinagerie.config.ts"]
file_eslint_config_ts["eslint.config.ts"]
file_src_index_ts["src/index.ts"]
file_src_index_unit_test_ts["src/index.unit.test.ts"]
file_src_modules_coinagerie_core_coinagerie_core_constants_ts["src/modules/coinagerie-core/coinagerie-core.constants.ts"]
file_src_modules_coinagerie_core_coinagerie_core_module_ts["src/modules/coinagerie-core/coinagerie-core.module.ts"]
file_src_modules_coinagerie_core_coinagerie_core_service_ts["src/modules/coinagerie-core/coinagerie-core.service.ts"]
file_src_modules_coinagerie_core_coinagerie_core_service_unit_test_ts["src/modules/coinagerie-core/coinagerie-core.service.unit.test.ts"]
file_src_modules_coinagerie_core_coinagerie_core_types_ts["src/modules/coinagerie-core/coinagerie-core.types.ts"]
file_testing_mocks_ts["testing/mocks.ts"]
file_testing_setup_ts["testing/setup.ts"]
file_vite_config_ts["vite.config.ts"]
file_vitest_config_ts["vitest.config.ts"]
file_src_index_unit_test_ts --> file_src_index_ts
file_src_modules_coinagerie_core_coinagerie_core_constants_ts --> file_src_modules_coinagerie_core_coinagerie_core_types_ts
file_src_modules_coinagerie_core_coinagerie_core_module_ts --> file_src_modules_coinagerie_core_coinagerie_core_service_ts
file_src_modules_coinagerie_core_coinagerie_core_service_unit_test_ts --> file_src_modules_coinagerie_core_coinagerie_core_service_ts⏲️ Codometer
Project
TypeScript
JavaScript
Python
JSON
YAML
TOML
Shell
SQL
HCL
CSS
Conventions
Jupyter
Markdown
