blob: 0eb8924a81127c78367c358c4e65bd26917779c1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
#
# 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://raw.githubusercontent.com/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 (JSON.parse(File.read(config_file)) rescue false)
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"
|
