fwmd: a standalone checker CLI (fwmd check / fwmd format)

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp
Domain
cli, tooling

Research direction

Read draft ADR 0034 and the editor-integration plan, especially decisions E-1 to E-15, before scoping implementation. The issue identifies tests/AotCheck as the current executable and calls for a host configuration for writing systems and styles, with front matter first. Done means the owner has decided the tracked design questions and the CLI scope is specified.

Written by the indexing model from the issue text.

Description

Nothing can run the Markdown or record-file checks on files today; the only Exe is tests/AotCheck. Add fwmd check [--schema] [--json]: findings (id, severity, line:col) as text or JSON, exiting non-zero when there are errors, for CI. Add fwmd format using the canonical writer. One native AOT binary, which later also runs fwmd lsp. This is phase 0 of the editor-integration plan (draft ADR 0034). It needs a host config for writing systems and styles; front matter comes first. Tracking until the owner decides E-1 to E-15.

Dominant language
C#
Stars
0
Forks
0
Avg merge
1h 43m
Merged PRs (30d)
43

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from sillsdev/SIL.TextEditing

All issues in sillsdev/SIL.TextEditing

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.