chore: Implement short translation keys#162
Merged
jbrooksuk merged 19 commits intocachethq:mainfrom Jan 2, 2025
Merged
Conversation
Member
|
Woah, huge thanks @danjohnson95 for undertaking this mammoth task! 🙏 I'm going to merge this in now and I'd love for future work to provide the tooling you mentioned. |
This was referenced Jan 2, 2025
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds translation keys for every string in the application, and does so in a consistent short-keys format.
All strings live inside the
cachetnamespace, and so are accessed like__('cachet::incident.new_button').I've separated out the translation keys roughly by the feature (or "resource") that they relate to. For example any strings related to "Incidents" belong in the
incidents.phpfile.I've created a predictable naming structure for some of the common page designs, so the table headers used on resource list pages are in
cachet::incident.list.headers.I've tried to keep this change as small as possible, so this PR doesn't contain the functionality to switch to different locales, but I'm happy to do that as a separate change.
If you're happy with this change, I've got some further tooling I can implement to keep the codebase clean - ie tests to ensure we're only using keys that exist, and linting rules to enforce consistencies in translation files.