vercel-labs / vercel-labs/konsistent

Qualify “source” as convention source or module source

Open
#71 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
176
Forks
6
Avg merge
20h 26m
Merged PRs (30d)
11

Description

The unqualified term “source” refers both to reusable convention providers and to TypeScript import/export module specifiers, with additional generic source identifiers in the parser. This makes types, variables, messages, and documentation ambiguous.

Relevant files:

  • packages/konsistent/src/config/source-resolver.ts
  • packages/konsistent/src/config/reference-expander.ts
  • packages/konsistent/src/typescript/types.ts
  • packages/konsistent/src/typescript/predicates/import-source.ts
  • docs/reference/reusable-conventions.md

Use the fully qualified terms “convention source” and “module source” throughout code and prose, including identifiers such as conventionSourceMap and moduleSource. Avoid bare source wherever either domain meaning is possible.

Backward compatibility: internal names and documentation can be renamed or removed without compatibility shims. No konsistent.json schema change is required; if a schema-facing field is renamed, retain the old name and behavior as deprecated and emit a non-failing CLI warning when it is used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by searching the five listed files and the surrounding TypeScript and documentation for ambiguous uses of “source.” Trace configuration and schema-facing names before renaming identifiers, then verify that internal terms distinguish convention sources from module sources and that any renamed schema-facing field keeps deprecated behavior with a non-failing CLI warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.