ci: add automated spellcheck for PRs

.github/workflows/ci.yml

@@ -34,3 +34,16 @@ jobs:
         run: yarn install --immutable
       - name: Lint JavaScript files
         run: yarn lint:js
+
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 20.x
+        uses: actions/[email protected]
+        with:
+          node-version: '20.x'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Spellcheck .mdx files
+        run: yarn lint:spelling

cspell-allowed-words.txt

@@ -0,0 +1,316 @@
+# Words that are not spellchecked by cspell
+
+actional
+adipisicing
+affordances
+aliqua
+aliquip
+Alita
+allowtransparency
+alluvialsankey
+Amaya
+amet
+Amit
+Arar
+areastack
+Artboard
+artboard
+artboards
+Artem
+asynciterable
+autogenerating
+autoplaying
+Autowidth
+axislabel
+Axure
+Babich
+barfloating
+bargrouped
+Bitstream
+Bluetalks
+bootcamp
+Boxplot
+boxplot
+Boxster
+Budiu
+buildpack
+buildpacks
+Callouts
+callouts
+Camello
+carbondesign
+carbondesignsystem
+carbonforsalesforce
+Cartograms
+cartograms
+ccac
+cfignore
+cfpp
+Chatbots
+chatbots
+cheatsheet
+checkmarks
+Choropleth
+choropleth
+CICS
+circlepack
+clickability
+Closkey
+codemod
+codemods
+codepen
+codesandbox
+codesnippet
+Colasante
+collapsable
+colorgrades
+combobutton
+commodo
+componentname
+conjuntion
+consequat
+containedlist
+contentswitcher
+Criss
+criss
+Danielson
+datatable
+dataviz
+datepicker
+Declutter
+Dendrogram
+dendrograms
+destructures
+Dismissable
+dismissable
+doctoc
+dolore
+Dont
+dont
+Dont's
+Dorling
+dorling
+Eaker
+eiusmod
+elit
+elkjs
+Encalada
+enim
+Enzo
+ethnicities
+Fessenden
+fileuploader
+Firstname
+fixfe
+Flaherty
+flexibity
+fluidcombobox
+fluiddatepicker
+fluiddropdown
+fluidform
+fluidmultiselect
+fluidnumberinput
+fluidsearch
+fluidselect
+fluidtextinput
+formattings
+fullpage
+Gantt
+gantt
+Geospatial
+geospatial
+Goktürk
+Guildford
+Gustafson
+gutterless
+GXQK
+Hagan
+Hassel
+hostbind
+illo
+imhvd
+imlz
+incididunt
+incontext
+influencers
+infotip
+initialisms
+inlineloading
+instace
+interactable
+interactives
+Invision
+invision
+irrudv
+Jakob
+Janssen
+jumpstart
+Kalbach
+Kaley
+Kevins
+keyschanges
+Knabe
+Kylee
+labore
+laboris
+Labuheimer
+Lastname
+Laubheimer
+Lazyness
+leadspace
+leadspaces
+leftpanel
+Lewandowski
+lightbox
+Loranger
+Mancilla
+MAPBOX
+Mapbox
+mapbox
+Marcin
+Marieke
+Maureens
+megamenu
+Mehmet
+Mels
+menubutton
+Micosoft
+microcontent
+Microinteractions
+microinteractions
+midtones
+Miklos
+misalign
+modeless
+multicolumn
+Multiproduct
+multiproduct
+Multiselected
+Multiselection
+multiselects
+Multistep
+multistep
+Munroe
+mybluemix
+newimage
+Nielson
+nodelink
+nostrud
+notavailable
+Notifiation
+nottested
+numberinput
+Oliveira
+orderedlist
+outcommented
+outler
+overflowmenu
+overlayed
+paginationnav
+Paslaru
+pathing
+Patternfly
+Pernice
+picto’s
+Pigmentosa
+Poulter
+preapre
+precompiler
+Preibusch
+progressindicator
+quickstart
+quis
+Raluca
+Rangel
+refernce
+reskinned
+respository
+Rollnick
+Ronjas
+Rosno
+Ruleset
+Saleforce
+Sankey
+sankey
+scannability
+scatterplot
+Screenreader
+screenreader
+screenreaders
+seperated
+sfdx
+Sidenav
+sidenav
+Sidepanel
+sidepanel
+signifiers
+Singleline
+singleline
+slotfilling
+snfo
+spacebar
+Stackblitz
+stackblitz
+Staticfile
+staticfile
+Stephane
+Strubberg
+structuredlist
+stumbleupon
+subcomponent
+subcomponents
+Subgrids
+subgrids
+sublist
+subpages
+Syzonenko
+tabgroup
+tablists
+Tearsheet
+tearsheet
+tearsheets
+tempor
+textinput
+tickmark
+Tidwell
+timeframe
+timeseries
+Toggletip
+toggletip
+toggletip's
+Toggletips
+toggletips
+toggletip’s
+treediagram
+Treemap
+treemap
+Treemaps
+Triaging
+Tuturial
+typeaheads
+ullamco
+unorder
+unorderedlist
+unsynchronized
+uploaders
+veniam
+Venkatachalam
+Vikki
+Villar
+wayfinding
+WCAG
+WDSL
+webcomponents
+webm
+Weinschenk
+Whitenton
+wireframe
+wireframes
+Wordcloud
+wordcloud
+Wroblewski
+ybee
+yourlearning
+YOURUSERNAMEHERE
+Yuxuan
+Zhou

cspell.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "language": "en",
+  "dictionaryDefinitions": [
+    {
+      "name": "cspell-allowed-words",
+      "path": "./cspell-allowed-words.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["cspell-allowed-words"],
+  "ignorePaths": ["node_modules", "/cspell-allowed-words.txt"],
+  "useGitignore": true
+}

package.json

@@ -18,6 +18,7 @@
     "build:analyze": "yarn install --force && yarn clean && ANALYZE=true yarn build",
     "serve": "gatsby serve",
     "lint:js": "NODE_ENV=test eslint . --fix",
+    "lint:spelling": "cspell src/**/*.mdx",
     "format": "prettier --write 'src/**/*.{css,scss,json,html,yaml,md,mdx}'",
     "format:check": "prettier --check 'src/**/*.{css,scss,json,html,yaml,md,mdx}'",
     "update-browserslist": "npx browserslist-ga"
@@ -78,6 +79,7 @@
     "babel-eslint": "^10.1.0",
     "babel-preset-carbon": "^0.0.14",
     "core-js": "^3.18.3",
+    "cspell": "^8.6.1",
     "d3": "7.0.0",
     "dotenv": "^8.2.0",
     "eslint": "^8.36.0",
@@ -112,6 +114,9 @@
     ],
     "*.{css,scss,json,html,yaml,md,mdx}": [
       "prettier --write"
+    ],
+    "*.{md,mdx}": [
+      "cspell"
     ]
   },
   "resolutions": {

src/pages/components/tooltip/usage.mdx

@@ -327,7 +327,7 @@ clicking outside the active container or UI element.
 
 #### Keyboard
 
-Users can trigger a tooltip by focusing on the element. Addtionally, a
+Users can trigger a tooltip by focusing on the element. Additionally, a
 definition tooltip can be triggered by using the `enter` key. A tooltip is
 dismissible by the use of the `escape` key. For tooltips that reveal containers
 on focus, the container dissapears when focus moves away.

src/pages/patterns/login-pattern/index.mdx

@@ -493,7 +493,7 @@ the page.
 - Lee Munroe, [Login vs Sign in](https://www.leemunroe.com/login-vs-signin/),
   (2010)
 - W3C,
-  [Using AIRA landmarks to identify regions of a page](https://www.w3.org/TR/WCAG20-TECHS/ARIA11.html)
+  [Using ARIA landmarks to identify regions of a page](https://www.w3.org/TR/WCAG20-TECHS/ARIA11.html)
 - Susan M. Weinschenk, Ph.D., 100 Things Every Designer Needs to Know about
   People (New Riders, 2011)