vercel-labs / vercel-labs/konsistent

Use “violation” instead of “diagnostic” for convention failures

Open
#68 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

Convention failures are called both “diagnostics” and “violations.” Standardize on “violation” for failed convention predicates while retaining warning and error as violation severity values; ordinary operational errors should continue to be called errors and remain conceptually separate from error-severity violations.

Relevant files:

  • packages/konsistent/src/core/diagnostics.ts
  • packages/konsistent/src/core/reporter.ts
  • packages/konsistent/src/commands/check.ts
  • packages/konsistent/README.md
  • docs/reference/cli.md

Rename diagnostic-oriented types, functions, fields, flags, output terminology, tests, and documentation to violation-oriented equivalents. Make operational error paths explicit enough that “error” cannot be mistaken for a convention violation without its severity context.

Backward compatibility: internal names, CLI terminology, and documentation can be renamed or removed without compatibility shims. No konsistent.json schema change is expected; if one becomes necessary, 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 tracing the diagnostic types and reporting flow in packages/konsistent/src/core/diagnostics.ts and reporter.ts, then inspect commands/check.ts and the listed README and CLI documentation. Update the named terminology and tests consistently, while keeping operational errors distinct from error-severity violations. Done means references use violation terminology and no konsistent.json schema change is introduced unless required.

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
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.