vercel-labs / vercel-labs/konsistent
Standardize convention reference terminology on vendor names
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 176
- Forks
- 6
- Avg merge
- 20h 26m
- Merged PRs (30d)
- 11
Description
The <vendor>/<name> reference syntax calls its first component a vendor in validation messages but a source prefix or prefix in implementation and documentation. This should have one name so references and conventionSources are explained consistently.
Relevant files:
packages/konsistent/src/config/schema.tspackages/konsistent/src/config/source-resolver.tspackages/konsistent/src/config/reference-expander.tsdocs/reference/reusable-conventions.mddocs/reference/configuration.md
Use “vendor” or “vendor name” throughout identifiers, types, validation messages, and documentation. Describe conventionSources as mapping vendor names to convention sources and preserve <vendor>/<convention-name> as the canonical reference form.
Backward compatibility: internal names and documentation can be renamed or removed without compatibility shims. No konsistent.json key or behavior needs to change; if a schema-facing rename is introduced, retain the old form as deprecated and emit a non-failing CLI warning when it is used.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the terminology and schema handling in packages/konsistent/src/config/schema.ts, source-resolver.ts, and reference-expander.ts, then compare the two listed reference documents. Update the affected identifiers, validation messages, and explanations so vendor names and / are used consistently, while preserving configuration behavior and documenting any deprecated schema-facing form if needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100