keymanapp / keymanapp/keyman

refactor(common): rename `common/web/types` to `common/web/common-types` to match module name

Open
#12,542 0 comments 0 reactions 0 assignees View on GitHub
common/ refactor
Dominant language
Pascal
Stars
534
Forks
143
Avg merge
2d 10h
Merged PRs (30d)
113

Description

There are several subdirectories named `types` (and several named `common`) in our source tree, and none `common/types`, so it's not so easy to find the source for the `@keymanapp/common-types` module. Therefore I'd suggest to rename `common/web/types` to `common/web/common-types`.

We could also discuss if more renames would make sense so that all subdirectories match the module name they provide.

Currently that affects these directories/modules:
```
web/src/engine/osk/gesture-processor: @keymanapp/gesture-recognizer
web/src/engine/predictive-text/templates: @keymanapp/models-templates
web/src/engine/predictive-text/worker-thread: @keymanapp/lm-worker
web/src/engine/predictive-text/worker-main: @keymanapp/lexical-model-layer
web/src/engine/predictive-text/types: @keymanapp/lm-message-types
web/src/engine/predictive-text/wordbreakers: @keymanapp/models-wordbreakers
core/include/ldml: @keymanapp/ldml-keyboard-constants
common/web/types: @keymanapp/common-types
common/test/resources: @keymanapp/common-test-resources
resources/gosh: @keymanapp/resources-gosh
resources/build/version: @keymanapp/auto-history-action
resources/tools/strip-emoji: stripemoji
developer/src/server/src/win32/trayicon/addon-src: windows-trayicon
developer/src/server: @keymanapp/developer-server
developer/src/common/web/test-helpers: @keymanapp/developer-test-helpers
developer/src/common/web/utils: @keymanapp/developer-utils
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.