-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Tim Smith <tsmith@chef.io>
- Loading branch information
Showing
6 changed files
with
137 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,6 @@ | |
|
||
# for tim's local testing | ||
/test.rb | ||
|
||
# spellcheck rake task | ||
chef_dictionary.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
// 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" | ||
], | ||
// 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/" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# | ||
# 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' |