[#45705] - [5.4] Actions - typos
- Fixed in Code Base
- 12 Jul 2025
- Medium
- Build: 5.4-dev
- # 45705
- Diff
- brianteeman:typos
User tests: Successful: Unsuccessful:
Summary of Changes
This PR adds the typos action https://github.com/marketplace/actions/typos-action
It also includes a configuration file to exclude testing of certain folders with non-english content and a list of false-positive words that it should not report (typos.toml)
Most of the false positives are in javascript or are spelling errors we cannot fix for b/c
Testing Instructions
The action should fail and report that configurated should be configured
The action should pass
Link to documentations
Please select:
-
Documentation link for docs.joomla.org:
-
No documentation changes for docs.joomla.org needed
-
Pull Request link for manual.joomla.org:
-
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Repository |
| Labels |
Added:
PR-5.4-dev
|
||
Good job
Good job
I've been running this manually for the last year or so and submitted the pr to fix typos but now we are using actions in the project it made sense to add it to our tools
@brianteeman Could we add exceptions (exclusions) from the check? If we not remove but deprecate language strings which have a spelling error in their key name like e.g. those handled with your other PR #45706 , these strings will still be there (with a deprecation comment), so we would need exclusions for these cases.
yes you just add them to the excluded words in .github/workflows/typos.toml
yes you just add them to the excluded words in .github/workflows/typos.toml
@brianteeman Would that mean we exclude that word, e.g. "configurated", from the check wherever it occurs? Or is there a way like it is e.g. for PHPStan to exclude only certain occurrences?
you would need to check the docs
tecpromotion
- | Title |
|
||||||
I have tested this item ✅ successfully on c056c2a
Code review, worlks with CONFIGURATED
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45705.
I have tested this item ✅ successfully on c056c2a
I have verified that the GitHub action fails due to CONFIGURATED vs CONFIGURED.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45705.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45705.
@brianteeman When this PR here has been merged it will need an exclusion rule for the old, deprecated language string. I think I know how to do that, so if I shall do that let me know. But I'm pretty sure you will also be able to do it.
i can add it now
| Labels |
Added:
RTC
|
||
i can add it now
@brianteeman Your commit will work, but it will ignore all occurrences. Maybe we could use default.extend-ignore-words-re instead of default.extend-words? default.extend-ignore-words-re would allow us to use a regular expression like ^PLG_SYSTEM_SCHEMAORG_FIELD_SCHEMA_DESCRIPTION_NOT_CONFIGURATED so we could exclude only the deprecated keys. This would make sure that we still would detect that typo at other places while we keep the deprecated keys during the complete life time of 5.4.
I do anything I can to avoid using regex but feel free to modify the excludes with regex if you desire
I do anything I can to avoid using regex but feel free to modify the excludes with regex if you desire
For me it's vice versa, I don't have a problem with the regex but don't know (yet) how to exactly use it in the typos.toml.
Anyway, I think that can be done later with a follow-up PR.
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2025-07-12 15:53:28 |
| Closed_By | ⇒ | muhme |
Thank you @brianteeman, all commentators and all testers.
So we don't have any typos right now?