keymanapp / keymanapp/keyman

feat(developer): Add support for 14.0 style word breaker spec

Open
#3,054 2 comments 0 reactions 0 assignees View on GitHub
developer/ feat
Dominant language
Pascal
Stars
534
Forks
143
Avg merge
2d 10h
Merged PRs (30d)
113

Description

**Is your feature request related to a problem? Please describe.**

Per https://github.com/keymanapp/help.keyman.com/pull/175#pullrequestreview-403869829, the word breaker spec has changed for lexical models. We need to update the model editor to support the additional field, or at least the 14.0 format which is an object rather than a string. At the same time, we should consider whether we want Developer 14.0 to support saving 12.0/13.0-format model files -- this has ramifications for future changes!

Old format:

```
wordBreaker: 'default',
```

New format (`joinWordsAt` is optional):

```
wordBreaker: {
use: 'default',
joinWordsAt: ['-'], // join words that contain hyphens
},
```

Contributor guide

Open the contributing guide

Research direction

Start in the model editor's wordBreaker parsing and saving entry points, using the linked word breaker specification change as context. Done means supporting the 14.0 object format, including optional joinWordsAt, and resolving whether 12.0/13.0 model files must remain save-compatible.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.