coinagerie-configure
Use when writing or changing a coinagerie.config.ts, choosing which files are scanned, excluding paths or words, reading another glossary into exclude.words, merging a word family with fold, declaring markdown or JSON glossary destinations, sharing one base configuration across folders, or when a configuration is rejected, a keyword list will not import, or a word is wrongly listed in the glossary.
How do I install this agent skill?
npx skills add https://github.com/organizzolini/codebase --skill coinagerie-configureIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides instructions for configuring the 'coinagerie' tool using TypeScript or JavaScript files. It enables a dynamic execution pattern where configuration logic is run by the tool at runtime. Additionally, the tool's core function of scanning project files creates a surface for indirect prompt injection if untrusted content is present in the workspace. No active malicious patterns were detected.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Writing a coinagerie configuration
A configuration is one default-exported plain object in
coinagerie.config.ts (or .mts, .cts, .js, .mjs, .cjs), loaded with
jiti, so TypeScript works and any field can be computed. Every field is
optional, and no file at all is valid: the run then scans the working
directory and prints.
The schema is strict at every level. A misspelled key fails the run, naming the file, instead of being ignored. Exporting a function is refused.
import { typescriptKeywords } from "@coinagerie/languages";
import type { CoinagerieConfiguration } from "@coinagerie/configuration";
export default {
include: ["src/**", "scripts/**"],
exclude: {
paths: ["**/*.test.ts", "**/generated/**", "coinagerie.config.ts"],
words: [...typescriptKeywords, "src", "index"],
},
fold: (word) => (word === "configuration" ? "configure" : word),
unfolded: ["pisces"],
outputs: [
{
description: "Words this project uses. Regenerate with `coinagerie --write`.",
path: "README.md",
type: "markdown",
},
],
} satisfies CoinagerieConfiguration;
The type import is optional and erased at load time. @coinagerie/languages
must be installed beside the configuration: an unresolvable import fails the
run as "Cannot find module".
The folder is the root
Every path and glob is relative to the folder the configuration file sits in, which is also the root the run scans. A path written in a shared base is read against the folder of the configuration that was loaded, not the base's.
includedefaults to every file, dot-files included. Globs match withpath.matchesGlob, where*and**never match a name starting with a dot: a customincludehas to name.github/**and its kin outright.exclude.pathstakes globs. A glob matching a folder prunes the whole folder. Globs match from the scanned folder, so["dist"]prunes only the top-leveldist; write**/distto prune it at any depth..gitignoreis honored on top of both, every one from the repository root (nearest ancestor holding.git) down, negations included.- A glossary destination is never scanned, but the configuration file is: its own keys become words. Exclude it by path, or accept them.
exclude.words
A list of entries, or a synchronous or asynchronous function returning one. An entry is a word, a string, or a regular expression. The function is where a configuration reads any other file, a parent glossary or a JSON file, because coinagerie never reads another glossary itself:
import { readFile } from "node:fs/promises";
import path from "node:path";
const parentWords = async (): Promise<string[]> =>
Object.keys(
JSON.parse(await readFile(path.join(__dirname, "../glossary.json"), "utf8")),
);
export default { exclude: { words: parentWords } };
- Nothing is excluded by default, not even language keywords. Spread the lists
@coinagerie/languagesexports as plain arrays:typescriptKeywords,pythonKeywords,sqlKeywords,shellKeywords,cssKeywords,hclKeywords,tomlKeywords,jsonKeywords,yamlKeywords. - Exclusion runs after folding, and each entry is lowercased and folded the
way the code's words are: excluding
servicealso coversservices, and excludingimplementscovers theimplementit folds into. - A string is one word, matched exactly. It is never split, so
"fooBar"never excludesfooorbar; list each. - A regular expression excludes every word it matches, so one pattern covers a
family such as plan IDs:
/^(task|test|risk)\d{3}$/, hash fragments/^(?=.*\d)[0-9a-f]{2,}$/, or lint rule IDs/^md\d{3}$/. It is tested against two forms of each word, and a match on either leaves the headword out as a string would: the lowercase word as the code wrote it (MD001ismd001), and the headword after folding andfold. Words are lowercase, so write the pattern for lowercase text or add theiflag. Thegandyflags are dropped, since they make a pattern stateful. Only a TypeScript or JavaScript configuration can hold one, since JSON cannot. - Words never hold a separator. In
task-001the001is a number, not a term, so onlytaskremains and no pattern matches it;TASK001is the one wordtask001, which/^(task|test|risk)\d{3}$/matches. - An excluded word leaves the glossary, and the next
--writedeletes its definition. Exclude a word because it carries no meaning of its own, not because its definition is missing.
fold
fold(word) => headword merges words the lemmatizer left apart, or repairs a
headword it got wrong. It runs after plural and inflection folding, so it
receives lemmas, and its result is the final headword.
fold: (word) =>
({ configuration: "configure", set: "setting" })[word] ?? word,
It must be synchronous and return a non-empty string without whitespace or
*. A throw, an empty or non-string result, or a promise fails the run,
naming the configuration file.
unfolded
A list of words listed exactly as written. Use it for a word that only looks
inflected: a singular ending in s (pisces, axios, nestjs) that folding
would strip of its last letter. An unfolded word skips plural and inflection folding
and fold; entries must be lowercase. Prefer it to a fold entry that maps
the trimmed form back.
unfolded: ["pisces", "axios"],
outputs
An array of destinations. With none, a run only prints, and --check and
--write refuse to run.
| Destination | Holds |
|---|---|
{ type: "markdown", path, description? } | a block between the coinagerie:start and coinagerie:end anchors |
{ type: "json", path } | the whole file, as a flat object sorted by word |
- A markdown file is created when absent, and gets the block appended at its end when it has no anchors yet, so point it at a README to add a section, or at a file of its own.
- A
descriptionis free prose under the heading. It may not contain a list item (-,*,+) or an HTML comment line, because that would parse back as glossary bullets. With none configured, prose already above the first bullet is kept. - Two destinations on one file are refused.
- Destinations are judged independently. Definitions never copy between a JSON and a markdown glossary, so keep one authoritative destination per scope.
One base for many folders
Put shared choices in one module and spread it; each folder's file adds only
what differs. The spread is shallow, so overriding exclude replaces all of
it:
import base from "../coinagerie.base";
export default {
...base,
exclude: { ...base.exclude, paths: [...(base.exclude?.paths ?? []), "fixtures"] },
outputs: [{ path: "README.md", type: "markdown" }],
};
When a folder's exclude.words reads its parent's glossary, the parent
decides what the child need not define. A word that leaves the parent returns
as missing in every child that excluded it, and moving its definition down is
a deliberate edit. Under Nx, declare the parent glossary as an input of each
child's target, or an edit to it will not re-run their checks.
Try before editing
Every field except exclude.words, fold, and unfolded has a command-line flag that
replaces it for one run: --include, --exclude-paths, --output-json,
--output-markdown, --description. The coinagerie-collect skill has the
table. A bare coinagerie run prints the result of a change without writing
anything.
When a run rejects the configuration
| Symptom | Cause and fix |
|---|---|
expected object, received function | the file exports a function; export a plain object |
Unrecognized key: "<name>" | a misspelled or misplaced field; fix the key |
Invalid input at exclude.words | an entry is neither a word nor a pattern, or it is not a list |
fold must return a non-empty string... | the function returned "", a space, *, a promise, or a non-string |
exclude.words boom | the function threw; the error carries the configuration's path |
Cannot find module | install the package beside the configuration |
Two outputs name a.json | give each destination its own file |
A description may not hold a list item... | the description has a -, *, +, or <!-- line; reword it |
fold threw on "<word>" | the fold function raised; fix it for that word |
Configuration file not found | a named --config is relative to the working directory |
For what to do about a failed check rather than a rejected configuration, use
the coinagerie-triage skill.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/organizzolini/codebase/coinagerie-configure">View coinagerie-configure on skillZs</a>