Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix ignored typos due to 'allowCompoundWords:true' setting #36004

Merged
merged 10 commits into from
Sep 23, 2024
Merged

fix ignored typos due to 'allowCompoundWords:true' setting #36004

merged 10 commits into from
Sep 23, 2024

Conversation

OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar commented Sep 23, 2024 •
edited
Loading

The allowCompundWords setting in cSpell allows words like writingsuggestions and popovertargetaction. Without the setting, we would have to add these words to one of the ignore lists. But this has caused quite a lot of typos to fly under the radar, such as progess, demonstates, diragram etc.

The PR fixes missed typos.

Also, with allowCompundWords on, we'll have to mark these words to be flagged explicitly. This has been done in the second commit, but we'll have to keep looking for such words in the future and adding them to the lists.

I suggest, instead of doing the above, we turn off the setting and explicitly add found compound words to terms/ignore lists. And camelCase the variable names as much as possible. We'll have to add the following existing 241 compound words to the ignore lists:

aaabcc
aabaac
aacbbbcac
ACCEPTEDTOS
accname
adduser
adjtimescapheight
adjtimesexheight
adrianroselli
advertisementreceived
aggregatable
alastairc
alistapart
ALLOWFROM
alphanumerals
Animometer
Annonay
antialiasing
apacheconf
apachectl
ASCIIID
assetlinks
audiocontext
beforeinstallpromptevent
beforetoggle
belgin
blockable
Blockable
brians
Browsersync
browsingtopics
bytestring
CACHEDIR
catchable
Caterina
characterboundsupdate
Cheatsheet
checkboard
checkmarks
clipboardchange
Codelab
collectability
collinearity
concatenator
contenido
contentlost
contentscripts
contentvisibilityautostatechange
controlbar
cookieless
cooluser
crashextensions
credentialled
crookedtimber
cssgridgarden
csstricks
Cubehelix
cubemaps
currentscreenchange
customstateset
cycletracker
davidwalsh
demuxing
Demuxing
Descripton
dropshow
enablei
Engish
Ethere
everytime
evilsite
examplestyles
Fairchild
fencedframe
fencedframeconfig
fencedframes
filetext
filterfunctions
Flagfox
forwidth
gattserverdisconnected
generatable
GETMATCHEDRULES
givenname
greenblue
greenzero
growshrink
harpercollins
highspeed
imagebad
imagegrid
infobox
infoboxes
infobox's
innertext
interarrival
ipados
jamiedoe
Jinping
Kobabe
lazyloaded
letmein
lightpurple
Lindenberg
linecaps
Linecaps
longwinded
loopstarted
lowdelay
macaron
Malala
mathit
maxplaybackrate
megastore
metastring
miplevel
Miroslav
Misparsed
modulepreloaded
montecarlo
mouseentry
multifactor
multimemory
mygroupmarker
mysampler
mystatename
navigables
nextslide
Nodepad
noteblocks
notrendered
Nowrapping
offsetted
ontextformatupdate
ontextupdate
pagereveal
pageswap
paintable
paintsize
papermakers
permissionspolicy
pipline
Platformer
playbackrate
popovertarget
popovertargetaction
precache
precached
precaches
precaching
Precaching
preconnects
preloaders
premultiplication
prerenderingchange
prerenders
previousslide
pricelist
properities
pythonanywhere
pythonaware
rawupdate
readonlyinline
realpython
redblue
redyellow
redzero
requireinteraction
reselecting
Resizeable
resnapped
Ronaldo
rtctransform
samplepay
scanability
screenreaders
screenschange
seecompattable
selectchange
selectedness
Serpentina
shadowrootdelegatesfocus
shadowrootmode
shadowrootserializable
sharedmem
sharpyuv
shortlinks
Shortlinks
shrinkwap
shrinkwrapping
sinkchange
smashingmagazine
Snapshotting
somestate
srihash
stackexchange
Stormys
Stratford
styleable
subformula
subformulas
subheaders
subpattern
subpopover
subproject
Subsentence
subsetting
subteam
subteams
sunsetting
supersets
swashoff
targettable
textformatupdate
textupdate
timeframe
truthyness
tunetheweb
tutsplus
underliner
underlyingly
usecase
useinbandfec
valuechange
viewbox
virtualkeyboardpolicy
webappmanifest
webbundle
webcodecs
webdav
webdesignerdepot
webidentity
webtransport
whitepoint
wisedog
workgroups
Workgroups
writingsuggestions
zeroblue
zeroyellow
zerozero

@OnkarRuikar OnkarRuikar requested review from a team as code owners September 23, 2024 03:51
@OnkarRuikar OnkarRuikar requested review from fred-wang, sideshowbarker, hamishwillee, estelle and pepelsbey and removed request for a team September 23, 2024 03:51
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs Content:JS JavaScript docs Content:Other Any docs not covered by another "Content:" label Content:HTTP HTTP docs Content:Accessibility Accessibility docs Content:MathML MathML docs Content:Performance Web performance docs Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:Forms Learning area Forms docs labels Sep 23, 2024
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Sep 23, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 23, 2024 •
edited
Loading

Preview URLs (62 pages)
Flaws (8)

Note! 56 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/Privacy/Third-party_cookies
Title: Third-party cookies
Flaw count: 1

  • images:
    • External image URL

URL: /en-US/docs/Web/CSS/marker
Title: marker
Flaw count: 1

  • macros:
    • /en-US/docs/Web/CSS/url redirects to /en-US/docs/Web/CSS/url_value

URL: /en-US/docs/Web/CSS/marker-mid
Title: marker-mid
Flaw count: 1

  • macros:
    • /en-US/docs/Web/CSS/url redirects to /en-US/docs/Web/CSS/url_value

URL: /en-US/docs/Web/API/SVGLengthList
Title: SVGLengthList
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/SVGAnimatedLengthList/baseVal does not exist
    • /en-US/docs/Web/API/SVGAnimatedLengthList/animVal does not exist
    • /en-US/docs/Web/API/SVGTextPositioningElement/x does not exist

URL: /en-US/docs/Web/API/HTMLInputElement/reportValidity
Title: HTMLInputElement: reportValidity() method
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/invalid_event redirects to /en-US/docs/Web/API/HTMLInputElement/invalid_event

URL: /en-US/docs/Web/API/HTMLInputElement/checkValidity
Title: HTMLInputElement: checkValidity() method
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/invalid_event redirects to /en-US/docs/Web/API/HTMLInputElement/invalid_event
External URLs (5)

URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/React_resources
Title: React resources

URL: /en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Introducing_complete_toolchain
Title: Introducing a complete toolchain

URL: /en-US/docs/Web/API/Compute_Pressure_API
Title: Compute Pressure API

(comment last updated: 2024-09-23 14:02:40)

@OnkarRuikar OnkarRuikar mentioned this pull request Sep 23, 2024
Merged
@Josh-Cena
Copy link
Member

I don't think having a "blocklist" of typos is a good idea. I think we should turn off allowCompoundWords and add those existing compound words to the dictionary. What do you think?

bsmth
bsmth reviewed Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
bsmth
bsmth reviewed Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
bsmth
bsmth reviewed Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
OnkarRuikar
OnkarRuikar commented Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
OnkarRuikar
OnkarRuikar commented Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
OnkarRuikar
OnkarRuikar commented Sep 23, 2024
View reviewed changes
.vscode/ignore-list.txt Outdated Show resolved Hide resolved
OnkarRuikar and others added 2 commits September 23, 2024 13:44
@OnkarRuikar
Apply suggestions from code review
2618d0d
@OnkarRuikar @bsmth
Apply suggestions from code review
d461a8a 
Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
bsmth
bsmth approved these changes Sep 23, 2024
View reviewed changes
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you 👍🏻

@sideshowbarker sideshowbarker removed their request for review September 23, 2024 09:14
Josh-Cena
Josh-Cena approved these changes Sep 23, 2024
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome! I'm excided about all the new typos.

files/en-us/web/javascript/reference/errors/not_a_function/index.md Outdated Show resolved Hide resolved
@Josh-Cena Josh-Cena merged commit 0a9c10f into mdn:main Sep 23, 2024
9 checks passed
@OnkarRuikar OnkarRuikar deleted the cspell_cw branch September 24, 2024 01:02
fiji-flo pushed a commit that referenced this pull request Oct 2, 2024
@OnkarRuikar @bsmth
@Josh-Cena @fiji-flo
fix ignored typos due to 'allowCompoundWords:true' setting (#36004)
c791d58 
* fix ignored typos due to 'allowCompoundWords:true' setting

* add missed words as flag words

* remove allowCompoundWords setting

* Update files/en-us/web/mathml/element/mfenced/index.md

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Brian Thomas Smith <brian@smith.berlin>

* Update files/en-us/web/javascript/reference/errors/unexpected_token/index.md

* Update files/en-us/web/javascript/reference/errors/unexpected_token/index.md

* Update files/en-us/web/javascript/reference/errors/not_a_function/index.md

---------

Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fred-wang fred-wang fred-wang left review comments

@bsmth bsmth bsmth approved these changes

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@hamishwillee hamishwillee Awaiting requested review from hamishwillee hamishwillee is a code owner automatically assigned from mdn/yari-content-http

@estelle estelle Awaiting requested review from estelle estelle is a code owner automatically assigned from mdn/yari-content-html

@pepelsbey pepelsbey Awaiting requested review from pepelsbey pepelsbey is a code owner automatically assigned from mdn/core-yari-content

Assignees
No one assigned
Labels
Content:Accessibility Accessibility docs Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:Forms Learning area Forms docs Content:MathML MathML docs Content:Other Any docs not covered by another "Content:" label Content:Performance Web performance docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed system [PR only] Infrastructure and configuration for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@OnkarRuikar @Josh-Cena @fred-wang @bsmth