Add a spelling check

Signed-off-by: Tim Smith <tsmith@chef.io>

.expeditor/verify.pipeline.yml

@@ -51,3 +51,12 @@ steps:
     executor:
       docker:
         host_os: windows
+
+- label: "Spellcheck"
+  commands:
+    - npm install -g cspell
+    - rake -f tasks/spellcheck.rake spellcheck
+  soft_fail: true
+  expeditor:
+    executor:
+      docker:

.gitignore

@@ -12,3 +12,6 @@
 
 # for tim's local testing
 /test.rb
+
+# spellcheck rake task
+chef_dictionary.txt

config/cookstyle.yml

@@ -843,7 +843,7 @@ Chef/Deprecations/DeprecatedYumRepositoryProperties:
     - '**/Berksfile'
 
 Chef/Deprecations/EOLAuditModeUsage:
-  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more informmation.
+  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
   StyleGuide: 'chef_deprecations_eolauditmodeusage'
   Enabled: true
   VersionAdded: '5.10.0'
@@ -905,7 +905,7 @@ Chef/Deprecations/PartialSearchClassUsage:
     - '**/metadata.rb'
 
 Chef/Deprecations/Cheffile:
-  Description: The Libarian-Chef depsolving project is no longer maintained and should not be used for cookbook depsolving. Consider using Policyfiles instead.
+  Description: The Librarian-Chef depsolving project is no longer maintained and should not be used for cookbook depsolving. Consider using Policyfiles instead.
   StyleGuide: 'chef_deprecations_cheffile'
   Enabled: true
   VersionAdded: '5.12.0'
@@ -2721,7 +2721,7 @@ Lint/BinaryOperatorWithIdenticalOperands:
 # Lint/TopLevelReturnWithArgument:
 #   Enabled: true
 
-# simplify hash acccess that doesn't actually need .dig
+# simplify hash access that doesn't actually need .dig
 Style/SingleArgumentDig:
   Enabled: true
 

cspell.json

@@ -0,0 +1,69 @@
+// cSpell Settings
+{
+  // Version of the setting file.  Always 0.1
+  "version": "0.1",
+  // language - current active spelling language
+  "language": "en",
+  "dictionaryDefinitions": [
+    {
+        "name": "chef",
+        "file": "./chef_dictionary.txt",
+        "description": "Custom Chef Dictionary"
+    }
+  ],
+  "dictionaries": ["chef"],
+  // words - list of words to be always considered correct
+  "words": [
+    "compat",
+    "servermanagercmd",
+    "zipfile",
+    "Autocorrect",
+    "Autocorrects",
+    "autocorrection",
+    "autocorrected",
+    "autocorrecting",
+    "backported",
+    "lvar",
+    "ivasgn",
+    "dstr",
+    "asgn",
+    "Vidmar",
+    "Whaaat",
+    "lstrip",
+    "performant",
+    "ipaddress",
+    "FCXXX",
+    "Multipackage",
+    "trueclass",
+    "falseclass",
+    "vals",
+    "cbase",
+    "Filebeat"
+  ],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": [
+    "hte"
+  ],
+  "ignorePaths": [
+    "CHANGELOG.md",
+    "**/*.gemspec",
+    "**/Gemfile.lock",
+    "**/Gemfile",
+    ".expeditor/**/*",
+    "spec/**",
+    "docs",
+    "config/disable_all.yml",
+    "config/upstream.yml",
+    "docs-chef-io/**/*",
+    "lib/rubocop/cop/chef/sharing/invalid_license_string.rb",
+    "lib/rubocop/chef/platform_helpers.rb"
+  ],
+  "ignoreRegExpList": [
+    // Ignore "'s" at the end of a word. If "Chef" is an accepted word, so is "Chef's".
+    "/'s\\b/",
+    // Ignore "'d" at the end of a word. If "dup" is an accepted word, so is "dup'd".
+    "/'d\\b/"
+  ]
+}

lib/rubocop/cop/chef/style/unnecessary_os_check.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Style
-        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `plaform_family`.
+        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `platform_family`.
         #
         # @example
         #

tasks/spellcheck.rake

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+namespace :spellcheck do
+  task run: :prereqs do
+    sh 'cspell lint --no-progress "**/*"'
+  end
+
+  task prereqs: %i(cspell_check config_check fetch_common)
+
+  task :fetch_common do
+    sh 'wget -q https://github.com/raw/chef/chef_dictionary/master/chef.txt -O chef_dictionary.txt'
+  end
+
+  task :config_check do
+    require 'json'
+
+    config_file = 'cspell.json'
+
+    unless File.readable?(config_file)
+      abort "Spellcheck config file '#{config_file}' not found, skipping spellcheck"
+    end
+
+    unless begin
+             JSON.parse(File.read(config_file))
+           rescue
+             false
+           end
+      abort "Failed to parse config file '#{config_file}', skipping spellcheck"
+    end
+  end
+
+  task :cspell_check do
+    cspell_version = begin
+                       `cspell --version`
+                     rescue
+                       nil
+                     end
+
+    cspell_version.is_a?(String) || abort(<<~INSTALL_CSPELL)
+      cspell is needed to run the spellcheck tasks. Run `npm install -g cspell` to install.
+      For more information: https://www.npmjs.com/package/cspell
+    INSTALL_CSPELL
+  end
+end
+
+desc 'Run spellcheck on the project.'
+task spellcheck: 'spellcheck:run'