Retire liblcm refusals once FieldWorks pins a liblcm with #410/#413/#414

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
backend

Research direction

Read LiblcmRefusals, LiblcmRefusalSweepTests and UnstorablePropertyTests, then check the FieldWorks SilLcmVersion pin and whether a liblcm release includes fixes #410, #413 and #414. After that release is pinned, rerun the sweep and reduce the refusal rules to cases liblcm still throws, keeping DroppedProperty/OnDropped for remaining refusals. The issue says control characters still need handling under liblcm#415.

Written by the indexing model from the issue text.

Description

SIL.TextEditing.LCModel refuses text properties and values that liblcm 11.0.0-beta0180 throws on (LiblcmRefusals, reported through OnDropped). The liblcm fixes sillsdev/liblcm#410, #413 and #414 remove almost all of those throws.

Evidence, from a local build of the three PRs combined (-p:SilLcmVersion=11.0.0-stack410-413-414.gb9b80fa, packed into the local feed):

  • Nothing is refused by property number any more: 50, 129, 150–155, 159 and 160 all load.
  • Most integer range rules and the string rules for properties 1–5, 7, 130, 133, 145 and 146 are unnecessary: 7457 integer and 9178 string cases are "liblcm loads, rules refuse".
  • There are 0 cases of "liblcm throws, rules accept".
  • 9 refusal tests fail as expected: the 5 in LiblcmRefusalSweepTests and 4 in UnstorablePropertyTests.

When FieldWorks pins a liblcm release with those fixes:

  1. Bump SilLcmVersion.
  2. Rerun the sweep and shrink LiblcmRefusals to what still throws. The sweep is the single source of truth.
  3. Keep DroppedProperty/OnDropped for anything left. Control characters are still deleted on save; see sillsdev/liblcm#415.

Blocked on a liblcm release and the FieldWorks pin.

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.