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.

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

Typo Fixes #466

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Typo Fixes #466

merged 1 commit into from
Apr 24, 2024

Conversation

coliff
Copy link
Contributor

@coliff coliff commented Apr 24, 2024

Fix typos found via cSpell VS Code extension and CLI.

Fix typos found via cSpell VS Code extension and CLI
@coliff
Copy link
Contributor Author

coliff commented Apr 24, 2024

Could consider adding spellcheck GitHub Action workflow, but would recommend only checking files changed in new PRs (with incremental_files_only: true option) rather than every single post going back to 2012 as there are lots of false-positives and it's just a waste of time/energy checking them every time.

Example:

name: cspell

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch:

env:
  FORCE_COLOR: 2

permissions:
  contents: read

jobs:
  cspell:
    permissions:
      # allow streetsidesoftware/cspell-action to fetch files for commits and PRs
      contents: read
      pull-requests: read
    runs-on: ubuntu-latest

    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false

      - name: Run cspell
        uses: streetsidesoftware/cspell-action@v6
        with:
          config: ".cspell.json"
          files: "**/*.md"
          inline: error
          incremental_files_only: true

For reference the cSpell config I used to test was this but I didn't whitelist all the false-positives:

{
  "version": "0.2",
  "words": [
    "alpadev",
    "anchorjs",
    "backface",
    "backported",
    "Backports",
    "bardiharborow",
    "Behance",
    "bootlint",
    "Bootstrappers",
    "borderless",
    "browserconfig",
    "browserslistrc",
    "bugreport",
    "callout",
    "callouts",
    "caniuse",
    "cheatsheet",
    "clearfix",
    "codebases",
    "codepoints",
    "colgroups",
    "coliff",
    "crossfade",
    "csscomb",
    "cssgrid",
    "csslintrc",
    "Customizer",
    "cvrebert",
    "CZJWT",
    "Delivr",
    "deramond",
    "Dribbble",
    "dropleft",
    "dropright",
    "dropstart",
    "dropup",
    "ffoodd",
    "flexbox",
    "focusin",
    "focusout",
    "focusring",
    "Freenode",
    "funcs",
    "geosot",
    "getbootstrap",
    "Glyphicon",
    "Glyphicons",
    "grayscale",
    "Gruntfile",
    "Halflings",
    "Hella",
    "hstack",
    "jumbotrons",
    "juthilo",
    "Libera",
    "LMVTFY",
    "martijncuppens",
    "Menlo",
    "migsq",
    "namespacing",
    "navbars",
    "nextwhenvisible",
    "Offcanvas",
    "offcanvases",
    "opencollective",
    "Packagist",
    "pageviews",
    "patrickhlauke",
    "Pinterest",
    "quickstart",
    "relref",
    "remy",
    "rgba",
    "RTLCSS",
    "Rubygems",
    "ruleset",
    "scrollbars",
    "Scrollspy",
    "shortcode",
    "shoutout",
    "Strava",
    "Stylelint",
    "subcomponents",
    "subnav",
    "textareas",
    "todos",
    "toolkits",
    "twbs",
    "typeahead",
    "viewports",
    "vstack",
    "WCAG",
    "Woohoo",
    "Xhkm",
    "xhmikosr",
    "Yoze",
    "ysds",
    "ywicff",
    "zindex",
    "zlatanvasovic"
  ],
  "language": "en-US",
  "files": [
    "**/*.md"
  ],
  "ignorePaths": [
    ".cspell.json",
    "dist/",
    "*.min.*",
    "**/*rtl*",
    "**/tests/**"
  ],
  "useGitignore": true
}

@XhmikosR XhmikosR merged commit a06381a into twbs:main Apr 24, 2024
8 checks passed
@coliff coliff deleted the dev/coliff/typo-fixes branch April 24, 2024 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants