Add crate-ci/typos config file with false positives. #1106
Conversation
felixarntz
added
[Type] Bug
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
felixarntz
requested review from
joemcgill,
mukeshpanchal27,
thelovekesh and
westonruter
There was a problem hiding this comment.
@felixarntz I think this file should have been placed under .github since it's being used in CI at the moment.
There was a problem hiding this comment.
@thelovekesh Does the CI workflow automatically pick it up too if it's in the .github directory instead of the root directory?
There was a problem hiding this comment.
@felixarntz I think we can use config argument:
diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml
index 7fe8b067..cd468152 100644
--- a/.github/workflows/spell-check.yml
+++ b/.github/workflows/spell-check.yml
@@ -10,3 +10,5 @@ jobs:
- uses: actions/checkout@v3
- name: Search for misspellings
uses: crate-ci/typos@master
+ with:
+ config: ./.github/typos.toml
There was a problem hiding this comment.
Good. As at the moment this file is incorrectly getting included with the build since it isn't being ignored for export/dist, right?
There was a problem hiding this comment.
Oh yes. But moving it to .github will fix that.
There was a problem hiding this comment.
Feel free to open a follow up PR. Thanks!
Summary
It looks like our Spell Check underlying repository was updated and now complains about the word "dur", which however is intentional, as it abbreviates "duration" and is in fact a syntax requirement for the Server-Timing API. See failure here for reference: https://github.com/WordPress/performance/actions/runs/8513515250/job/23317345691?pr=1105
This fix is based on the documentation in https://github.com/crate-ci/typos?tab=readme-ov-file#false-positives