From d581737f784d144a961d61248d42f59440159571 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Tue, 11 Jan 2022 11:17:12 +0200 Subject: [PATCH] Update cspell config (#35647) * specify the files to scan in the config * enable `useGitignore` option * remove a few unneeded suppressions --- .cspell.json | 18 +++++++----------- package.json | 2 +- site/content/docs/5.1/components/modal.md | 2 +- site/content/docs/5.1/customize/sass.md | 2 +- site/content/docs/5.1/getting-started/rtl.md | 2 +- site/content/docs/5.1/migration.md | 2 +- 6 files changed, 12 insertions(+), 16 deletions(-) diff --git a/.cspell.json b/.cspell.json index 5f65533d8d..35d0d293e1 100644 --- a/.cspell.json +++ b/.cspell.json @@ -19,7 +19,6 @@ "callouts", "clearfix", "Codesniffer", - "colorspace", "combinator", "Contentful", "Cpath", @@ -43,9 +42,7 @@ "fieldsets", "flexbox", "fullscreen", - "fusv", "getbootstrap", - "globby", "Grayscale", "Hoverable", "hreflang", @@ -86,12 +83,10 @@ "scrollbars", "scrollspy", "Segoe", - "sirv", "srcset", "stickied", "Stylelint", "subnav", - "svgo", "tabbable", "textareas", "toggleable", @@ -99,7 +94,6 @@ "touchend", "twbs", "unitless", - "Unported", "unstylable", "unstyled", "Uppercased", @@ -109,15 +103,17 @@ "vstack", "walkthroughs", "WCAG", - "webfont", - "Woohoo", "zindex", "بالعالم", "مرحبًا" ], - "language": "en,en-US", + "language": "en, en-US", + "files": [ + "site/**/*.md" + ], "ignorePaths": [ ".cspell.json", - ".min." - ] + "*.min.*" + ], + "useGitignore": true } diff --git a/package.json b/package.json index f4c5ca8e91..39d8137285 100644 --- a/package.json +++ b/package.json @@ -58,7 +58,7 @@ "docs-build": "hugo --cleanDestinationDir", "docs-compile": "npm run docs-build", "docs-linkinator": "linkinator _site --recurse --skip \"^(?!http://localhost)\" --verbosity error", - "docs-spellcheck": "cspell \"site/**/*.md\" --no-progress", + "docs-spellcheck": "cspell --no-progress", "docs-vnu": "node build/vnu-jar.js", "docs-lint": "npm-run-all --aggregate-output --parallel docs-vnu docs-linkinator docs-spellcheck", "docs-serve": "hugo server --port 9001 --disableFastRender", diff --git a/site/content/docs/5.1/components/modal.md b/site/content/docs/5.1/components/modal.md index 8255a73644..7f05deb5d2 100644 --- a/site/content/docs/5.1/components/modal.md +++ b/site/content/docs/5.1/components/modal.md @@ -90,7 +90,7 @@ Toggle a working modal demo by clicking the button below. It will slide down and
-

Woohoo, you're reading this text in a modal!

+

Woo-hoo, you're reading this text in a modal!

diff --git a/site/content/docs/5.1/customize/sass.md b/site/content/docs/5.1/customize/sass.md index 53562e1f99..0be56db9b4 100644 --- a/site/content/docs/5.1/customize/sass.md +++ b/site/content/docs/5.1/customize/sass.md @@ -217,7 +217,7 @@ In practice, you'd call the function and pass in the color and weight parameters In order to meet [WCAG 2.0 accessibility standards for color contrast](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html), authors **must** provide [a contrast ratio of at least 4.5:1](https://www.w3.org/WAI/WCAG20/quickref/20160105/Overview.php#visual-audio-contrast-contrast), with very few exceptions. -An additional function we include in Bootstrap is the color contrast function, `color-contrast`. It utilizes the [WCAG 2.0 algorithm](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests) for calculating contrast thresholds based on [relative luminance](https://www.w3.org/WAI/GL/wiki/Relative_luminance) in a `sRGB` colorspace to automatically return a light (`#fff`), dark (`#212529`) or black (`#000`) contrast color based on the specified base color. This function is especially useful for mixins or loops where you're generating multiple classes. +An additional function we include in Bootstrap is the color contrast function, `color-contrast`. It utilizes the [WCAG 2.0 algorithm](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests) for calculating contrast thresholds based on [relative luminance](https://www.w3.org/WAI/GL/wiki/Relative_luminance) in a `sRGB` color space to automatically return a light (`#fff`), dark (`#212529`) or black (`#000`) contrast color based on the specified base color. This function is especially useful for mixins or loops where you're generating multiple classes. For example, to generate color swatches from our `$theme-colors` map: diff --git a/site/content/docs/5.1/getting-started/rtl.md b/site/content/docs/5.1/getting-started/rtl.md index b1a0534cf6..19d9d4141c 100644 --- a/site/content/docs/5.1/getting-started/rtl.md +++ b/site/content/docs/5.1/getting-started/rtl.md @@ -111,7 +111,7 @@ dt { In the case you're using a custom font, be aware that not all fonts support the non-Latin alphabet. To switch from Pan-European to Arabic family, you may need to use `/*rtl:insert: {value}*/` in your font stack to modify the names of font families. -For example, to switch from `Helvetica Neue Webfont` for LTR to `Helvetica Neue Arabic` for RTL, your Sass code look like this: +For example, to switch from `Helvetica Neue` font for LTR to `Helvetica Neue Arabic` for RTL, your Sass code could look like this: ```scss $font-family-sans-serif: diff --git a/site/content/docs/5.1/migration.md b/site/content/docs/5.1/migration.md index defc02db95..7fe5182b5a 100644 --- a/site/content/docs/5.1/migration.md +++ b/site/content/docs/5.1/migration.md @@ -91,7 +91,7 @@ Your custom Bootstrap CSS builds should now look something like this with a sepa - We've ditched the default Sass map merges to make it easier to remove redundant values. Keep in mind you now have to define all values in the Sass maps like `$theme-colors`. Check out how to deal with [Sass maps]({{< docsref "/customize/sass#maps-and-loops" >}}). -- Breaking Renamed `color-yiq()` function and related variables to `color-contrast()` as it's no longer related to YIQ colorspace. [See #30168.](https://github.com/twbs/bootstrap/pull/30168/) +- Breaking Renamed `color-yiq()` function and related variables to `color-contrast()` as it's no longer related to YIQ color space. [See #30168.](https://github.com/twbs/bootstrap/pull/30168/) - `$yiq-contrasted-threshold` is renamed to `$min-contrast-ratio`. - `$yiq-text-dark` and `$yiq-text-light` are respectively renamed to `$color-contrast-dark` and `$color-contrast-light`.