danger-htmllint 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.dependabot/config.yml +18 -0
- data/.github/workflows/ci.yml +26 -0
- data/.gitignore +4 -0
- data/.rubocop.yml +158 -0
- data/.travis.yml +12 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +137 -0
- data/Guardfile +19 -0
- data/LICENSE.txt +22 -0
- data/README.md +33 -0
- data/Rakefile +23 -0
- data/danger-htmllint.gemspec +49 -0
- data/lib/danger_htmllint.rb +1 -0
- data/lib/danger_plugin.rb +1 -0
- data/lib/htmllint/gem_version.rb +3 -0
- data/lib/htmllint/plugin.rb +87 -0
- data/spec/htmllint_spec.rb +102 -0
- data/spec/spec_helper.rb +65 -0
- metadata +204 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 498c7ae52de27678bd30845a7ddc5d010274f521
|
4
|
+
data.tar.gz: 71e34242c04e6073dc6bf1d7b4b215d1df481376
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b786bc362d77dc8bc971d1d8607a786228695999463d0941caa98f6e4c514c7ae92fc7a68744dba9daff39dafc2119fb7ab2826f44bec3195d3a8d150008d37c
|
7
|
+
data.tar.gz: c641b3a8d75df2af349a62200413ab0b0981cfc78ea64a11cd817e152e65d29703558abf1bd252843002309c38594c576cc4138925069ff6494438cdb2171049
|
@@ -0,0 +1,18 @@
|
|
1
|
+
version: 1
|
2
|
+
|
3
|
+
update_configs:
|
4
|
+
- package_manager: "ruby:bundler"
|
5
|
+
directory: "/"
|
6
|
+
update_schedule: "monthly"
|
7
|
+
|
8
|
+
allowed_updates:
|
9
|
+
- match:
|
10
|
+
update_type: "security"
|
11
|
+
automerged_updates:
|
12
|
+
- match:
|
13
|
+
dependency_type: "all"
|
14
|
+
update_type: "security:patch"
|
15
|
+
- match:
|
16
|
+
dependency_type: "development"
|
17
|
+
update_type: "semver:minor"
|
18
|
+
version_requirement_updates: "off"
|
@@ -0,0 +1,26 @@
|
|
1
|
+
name: CI
|
2
|
+
on: [push]
|
3
|
+
|
4
|
+
jobs:
|
5
|
+
test:
|
6
|
+
name: Test
|
7
|
+
runs-on: ubuntu-latest
|
8
|
+
strategy:
|
9
|
+
matrix:
|
10
|
+
ruby: [ '2.4.x', '2.5.x', '2.6.x' ]
|
11
|
+
|
12
|
+
steps:
|
13
|
+
- uses: actions/checkout@master
|
14
|
+
- name: Set up Ruby version
|
15
|
+
uses: actions/setup-ruby@master
|
16
|
+
with:
|
17
|
+
version: ${{ matrix.ruby }}
|
18
|
+
|
19
|
+
- name: Set up bundler
|
20
|
+
run: gem install bundler
|
21
|
+
|
22
|
+
- name: bundle install
|
23
|
+
run: bundle install --jobs 4 --retry 3
|
24
|
+
|
25
|
+
- name: test
|
26
|
+
run: bundle exec rake spec
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,158 @@
|
|
1
|
+
# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
|
2
|
+
|
3
|
+
# If you don't like these settings, just delete this file :)
|
4
|
+
|
5
|
+
AllCops:
|
6
|
+
TargetRubyVersion: 2.4
|
7
|
+
|
8
|
+
Style/StringLiterals:
|
9
|
+
EnforcedStyle: double_quotes
|
10
|
+
Enabled: true
|
11
|
+
|
12
|
+
# kind_of? is a good way to check a type
|
13
|
+
Style/ClassCheck:
|
14
|
+
EnforcedStyle: kind_of?
|
15
|
+
|
16
|
+
# It's better to be more explicit about the type
|
17
|
+
Style/BracesAroundHashParameters:
|
18
|
+
Enabled: false
|
19
|
+
|
20
|
+
# specs sometimes have useless assignments, which is fine
|
21
|
+
Lint/UselessAssignment:
|
22
|
+
Exclude:
|
23
|
+
- '**/spec/**/*'
|
24
|
+
|
25
|
+
# We could potentially enable the 2 below:
|
26
|
+
Layout/IndentFirstHashElement:
|
27
|
+
Enabled: false
|
28
|
+
|
29
|
+
Layout/AlignHash:
|
30
|
+
Enabled: false
|
31
|
+
|
32
|
+
# HoundCI doesn't like this rule
|
33
|
+
Layout/DotPosition:
|
34
|
+
Enabled: false
|
35
|
+
|
36
|
+
# We allow !! as it's an easy way to convert ot boolean
|
37
|
+
Style/DoubleNegation:
|
38
|
+
Enabled: false
|
39
|
+
|
40
|
+
# Cop supports --auto-correct.
|
41
|
+
Lint/UnusedBlockArgument:
|
42
|
+
Enabled: false
|
43
|
+
|
44
|
+
# We want to allow class Fastlane::Class
|
45
|
+
Style/ClassAndModuleChildren:
|
46
|
+
Enabled: false
|
47
|
+
|
48
|
+
Metrics/AbcSize:
|
49
|
+
Max: 60
|
50
|
+
|
51
|
+
# The %w might be confusing for new users
|
52
|
+
Style/WordArray:
|
53
|
+
MinSize: 19
|
54
|
+
|
55
|
+
# raise and fail are both okay
|
56
|
+
Style/SignalException:
|
57
|
+
Enabled: false
|
58
|
+
|
59
|
+
# Better too much 'return' than one missing
|
60
|
+
Style/RedundantReturn:
|
61
|
+
Enabled: false
|
62
|
+
|
63
|
+
# Having if in the same line might not always be good
|
64
|
+
Style/IfUnlessModifier:
|
65
|
+
Enabled: false
|
66
|
+
|
67
|
+
# and and or is okay
|
68
|
+
Style/AndOr:
|
69
|
+
Enabled: false
|
70
|
+
|
71
|
+
# Configuration parameters: CountComments.
|
72
|
+
Metrics/ClassLength:
|
73
|
+
Max: 350
|
74
|
+
|
75
|
+
Metrics/CyclomaticComplexity:
|
76
|
+
Max: 17
|
77
|
+
|
78
|
+
# Configuration parameters: AllowURI, URISchemes.
|
79
|
+
Metrics/LineLength:
|
80
|
+
Max: 370
|
81
|
+
|
82
|
+
# Configuration parameters: CountKeywordArgs.
|
83
|
+
Metrics/ParameterLists:
|
84
|
+
Max: 10
|
85
|
+
|
86
|
+
Metrics/PerceivedComplexity:
|
87
|
+
Max: 18
|
88
|
+
|
89
|
+
# Sometimes it's easier to read without guards
|
90
|
+
Style/GuardClause:
|
91
|
+
Enabled: false
|
92
|
+
|
93
|
+
# something = if something_else
|
94
|
+
# that's confusing
|
95
|
+
Style/ConditionalAssignment:
|
96
|
+
Enabled: false
|
97
|
+
|
98
|
+
# Better to have too much self than missing a self
|
99
|
+
Style/RedundantSelf:
|
100
|
+
Enabled: false
|
101
|
+
|
102
|
+
Metrics/MethodLength:
|
103
|
+
Max: 60
|
104
|
+
|
105
|
+
# We're not there yet
|
106
|
+
Style/Documentation:
|
107
|
+
Enabled: false
|
108
|
+
|
109
|
+
# Adds complexity
|
110
|
+
Style/IfInsideElse:
|
111
|
+
Enabled: false
|
112
|
+
|
113
|
+
# danger specific
|
114
|
+
|
115
|
+
Style/BlockComments:
|
116
|
+
Enabled: false
|
117
|
+
|
118
|
+
Layout/MultilineMethodCallIndentation:
|
119
|
+
EnforcedStyle: indented
|
120
|
+
|
121
|
+
# FIXME: 25
|
122
|
+
Metrics/BlockLength:
|
123
|
+
Max: 345
|
124
|
+
Exclude:
|
125
|
+
- "**/*_spec.rb"
|
126
|
+
|
127
|
+
Style/MixinGrouping:
|
128
|
+
Enabled: false
|
129
|
+
|
130
|
+
Naming/FileName:
|
131
|
+
Enabled: false
|
132
|
+
|
133
|
+
Layout/IndentHeredoc:
|
134
|
+
Enabled: false
|
135
|
+
|
136
|
+
Style/SpecialGlobalVars:
|
137
|
+
Enabled: false
|
138
|
+
|
139
|
+
PercentLiteralDelimiters:
|
140
|
+
PreferredDelimiters:
|
141
|
+
"%": ()
|
142
|
+
"%i": ()
|
143
|
+
"%q": ()
|
144
|
+
"%Q": ()
|
145
|
+
"%r": "{}"
|
146
|
+
"%s": ()
|
147
|
+
"%w": ()
|
148
|
+
"%W": ()
|
149
|
+
"%x": ()
|
150
|
+
|
151
|
+
Security/YAMLLoad:
|
152
|
+
Enabled: false
|
153
|
+
|
154
|
+
Style/FrozenStringLiteralComment:
|
155
|
+
Enabled: false
|
156
|
+
|
157
|
+
Metrics/ModuleLength:
|
158
|
+
Enabled: false
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
danger-htmllint (0.1.0)
|
5
|
+
danger-plugin-api (~> 1.0)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
addressable (2.7.0)
|
11
|
+
public_suffix (>= 2.0.2, < 5.0)
|
12
|
+
ast (2.4.0)
|
13
|
+
claide (1.0.3)
|
14
|
+
claide-plugins (0.9.2)
|
15
|
+
cork
|
16
|
+
nap
|
17
|
+
open4 (~> 1.3)
|
18
|
+
coderay (1.1.2)
|
19
|
+
colored2 (3.1.2)
|
20
|
+
cork (0.3.0)
|
21
|
+
colored2 (~> 3.1)
|
22
|
+
danger (6.0.9)
|
23
|
+
claide (~> 1.0)
|
24
|
+
claide-plugins (>= 0.9.2)
|
25
|
+
colored2 (~> 3.1)
|
26
|
+
cork (~> 0.1)
|
27
|
+
faraday (~> 0.9)
|
28
|
+
faraday-http-cache (~> 2.0)
|
29
|
+
git (~> 1.5)
|
30
|
+
kramdown (~> 2.0)
|
31
|
+
kramdown-parser-gfm (~> 1.0)
|
32
|
+
no_proxy_fix
|
33
|
+
octokit (~> 4.7)
|
34
|
+
terminal-table (~> 1)
|
35
|
+
danger-plugin-api (1.0.0)
|
36
|
+
danger (> 2.0)
|
37
|
+
diff-lcs (1.3)
|
38
|
+
faraday (0.15.4)
|
39
|
+
multipart-post (>= 1.2, < 3)
|
40
|
+
faraday-http-cache (2.0.0)
|
41
|
+
faraday (~> 0.8)
|
42
|
+
ffi (1.11.1)
|
43
|
+
formatador (0.2.5)
|
44
|
+
git (1.5.0)
|
45
|
+
guard (2.15.1)
|
46
|
+
formatador (>= 0.2.4)
|
47
|
+
listen (>= 2.7, < 4.0)
|
48
|
+
lumberjack (>= 1.0.12, < 2.0)
|
49
|
+
nenv (~> 0.1)
|
50
|
+
notiffany (~> 0.0)
|
51
|
+
pry (>= 0.9.12)
|
52
|
+
shellany (~> 0.0)
|
53
|
+
thor (>= 0.18.1)
|
54
|
+
guard-compat (1.2.1)
|
55
|
+
guard-rspec (4.7.3)
|
56
|
+
guard (~> 2.1)
|
57
|
+
guard-compat (~> 1.1)
|
58
|
+
rspec (>= 2.99.0, < 4.0)
|
59
|
+
jaro_winkler (1.5.3)
|
60
|
+
kramdown (2.1.0)
|
61
|
+
kramdown-parser-gfm (1.1.0)
|
62
|
+
kramdown (~> 2.0)
|
63
|
+
listen (3.0.7)
|
64
|
+
rb-fsevent (>= 0.9.3)
|
65
|
+
rb-inotify (>= 0.9.7)
|
66
|
+
lumberjack (1.0.13)
|
67
|
+
method_source (0.9.2)
|
68
|
+
multipart-post (2.1.1)
|
69
|
+
nap (1.1.0)
|
70
|
+
nenv (0.3.0)
|
71
|
+
no_proxy_fix (0.1.2)
|
72
|
+
notiffany (0.1.3)
|
73
|
+
nenv (~> 0.1)
|
74
|
+
shellany (~> 0.0)
|
75
|
+
octokit (4.14.0)
|
76
|
+
sawyer (~> 0.8.0, >= 0.5.3)
|
77
|
+
open4 (1.3.4)
|
78
|
+
parallel (1.17.0)
|
79
|
+
parser (2.6.4.1)
|
80
|
+
ast (~> 2.4.0)
|
81
|
+
pry (0.12.2)
|
82
|
+
coderay (~> 1.1.0)
|
83
|
+
method_source (~> 0.9.0)
|
84
|
+
public_suffix (4.0.1)
|
85
|
+
rainbow (3.0.0)
|
86
|
+
rake (10.5.0)
|
87
|
+
rb-fsevent (0.10.3)
|
88
|
+
rb-inotify (0.10.0)
|
89
|
+
ffi (~> 1.0)
|
90
|
+
rspec (3.8.0)
|
91
|
+
rspec-core (~> 3.8.0)
|
92
|
+
rspec-expectations (~> 3.8.0)
|
93
|
+
rspec-mocks (~> 3.8.0)
|
94
|
+
rspec-core (3.8.2)
|
95
|
+
rspec-support (~> 3.8.0)
|
96
|
+
rspec-expectations (3.8.4)
|
97
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
98
|
+
rspec-support (~> 3.8.0)
|
99
|
+
rspec-mocks (3.8.1)
|
100
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
101
|
+
rspec-support (~> 3.8.0)
|
102
|
+
rspec-support (3.8.2)
|
103
|
+
rubocop (0.74.0)
|
104
|
+
jaro_winkler (~> 1.5.1)
|
105
|
+
parallel (~> 1.10)
|
106
|
+
parser (>= 2.6)
|
107
|
+
rainbow (>= 2.2.2, < 4.0)
|
108
|
+
ruby-progressbar (~> 1.7)
|
109
|
+
unicode-display_width (>= 1.4.0, < 1.7)
|
110
|
+
ruby-progressbar (1.10.1)
|
111
|
+
sawyer (0.8.2)
|
112
|
+
addressable (>= 2.3.5)
|
113
|
+
faraday (> 0.8, < 2.0)
|
114
|
+
shellany (0.0.1)
|
115
|
+
terminal-table (1.8.0)
|
116
|
+
unicode-display_width (~> 1.1, >= 1.1.1)
|
117
|
+
thor (0.20.3)
|
118
|
+
unicode-display_width (1.6.0)
|
119
|
+
yard (0.9.20)
|
120
|
+
|
121
|
+
PLATFORMS
|
122
|
+
ruby
|
123
|
+
|
124
|
+
DEPENDENCIES
|
125
|
+
bundler (~> 2.0)
|
126
|
+
danger-htmllint!
|
127
|
+
guard (~> 2.14)
|
128
|
+
guard-rspec (~> 4.7)
|
129
|
+
listen (= 3.0.7)
|
130
|
+
pry
|
131
|
+
rake (~> 10.0)
|
132
|
+
rspec (~> 3.4)
|
133
|
+
rubocop
|
134
|
+
yard
|
135
|
+
|
136
|
+
BUNDLED WITH
|
137
|
+
2.0.2
|
data/Guardfile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# A guardfile for making Danger Plugins
|
2
|
+
# For more info see https://github.com/guard/guard#readme
|
3
|
+
|
4
|
+
# To run, use `bundle exec guard`.
|
5
|
+
|
6
|
+
guard :rspec, cmd: 'bundle exec rspec' do
|
7
|
+
require 'guard/rspec/dsl'
|
8
|
+
dsl = Guard::RSpec::Dsl.new(self)
|
9
|
+
|
10
|
+
# RSpec files
|
11
|
+
rspec = dsl.rspec
|
12
|
+
watch(rspec.spec_helper) { rspec.spec_dir }
|
13
|
+
watch(rspec.spec_support) { rspec.spec_dir }
|
14
|
+
watch(rspec.spec_files)
|
15
|
+
|
16
|
+
# Ruby files
|
17
|
+
ruby = dsl.ruby
|
18
|
+
dsl.watch_spec_files_for(ruby.lib_files)
|
19
|
+
end
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2019 konifar <yahpeycoy0403@gmail.com>
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# danger-htmllint
|
2
|
+
[![](https://github.com/konifar/danger-htmllint/workflows/CI/badge.svg)](https://github.com/konifar/danger-htmllint/actions)
|
3
|
+
|
4
|
+
[Danger](http://danger.systems/ruby/) plugin for [htmllint](http://htmllint.github.io/).
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
$ gem install danger-htmllint
|
9
|
+
|
10
|
+
`danger-htmllint` depends on [`htmllint-cli`]((https://github.com/htmllint/htmllint-cli)). You need to install it before running Danger.
|
11
|
+
|
12
|
+
## Usage
|
13
|
+
|
14
|
+
Set Dangerfile like this.
|
15
|
+
|
16
|
+
```
|
17
|
+
# Set .htmllintrc path (optional)
|
18
|
+
htmllint.rc_path = "/path/to/your/.htmllintrc"
|
19
|
+
|
20
|
+
# Set true if you want to fail CI when errors are detected (optional)
|
21
|
+
htmllint.fail_on_error = true
|
22
|
+
|
23
|
+
# Run htmllint to only added or modified files (required)
|
24
|
+
htmllint.lint
|
25
|
+
```
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
1. Clone this repo
|
30
|
+
2. Run `bundle install` to setup dependencies.
|
31
|
+
3. Run `bundle exec rake spec` to run the tests.
|
32
|
+
4. Use `bundle exec guard` to automatically have tests run as you make changes.
|
33
|
+
5. Make your changes.
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
2
|
+
require 'rspec/core/rake_task'
|
3
|
+
require 'rubocop/rake_task'
|
4
|
+
|
5
|
+
RSpec::Core::RakeTask.new(:specs)
|
6
|
+
|
7
|
+
task default: :specs
|
8
|
+
|
9
|
+
task :spec do
|
10
|
+
Rake::Task['specs'].invoke
|
11
|
+
Rake::Task['rubocop'].invoke
|
12
|
+
Rake::Task['spec_docs'].invoke
|
13
|
+
end
|
14
|
+
|
15
|
+
desc 'Run RuboCop on the lib/specs directory'
|
16
|
+
RuboCop::RakeTask.new(:rubocop) do |task|
|
17
|
+
task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
|
18
|
+
end
|
19
|
+
|
20
|
+
desc 'Ensure that the plugin passes `danger plugins lint`'
|
21
|
+
task :spec_docs do
|
22
|
+
sh 'bundle exec danger plugins lint'
|
23
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'htmllint/gem_version.rb'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'danger-htmllint'
|
8
|
+
spec.version = Htmllint::VERSION
|
9
|
+
spec.authors = ['konifar']
|
10
|
+
spec.email = ['yahpeycoy0403@gmail.com']
|
11
|
+
spec.description = %q{Danger plugin for htmllint. https://github.com/htmllint/htmllint/}
|
12
|
+
spec.summary = %q{Danger plugin for htmllint.}
|
13
|
+
spec.homepage = 'https://github.com/konifar/danger-htmllint'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
|
22
|
+
|
23
|
+
# General ruby development
|
24
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
25
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
26
|
+
|
27
|
+
# Testing support
|
28
|
+
spec.add_development_dependency 'rspec', '~> 3.4'
|
29
|
+
|
30
|
+
# Linting code and docs
|
31
|
+
spec.add_development_dependency "rubocop"
|
32
|
+
spec.add_development_dependency "yard"
|
33
|
+
|
34
|
+
# Makes testing easy via `bundle exec guard`
|
35
|
+
spec.add_development_dependency 'guard', '~> 2.14'
|
36
|
+
spec.add_development_dependency 'guard-rspec', '~> 4.7'
|
37
|
+
|
38
|
+
# If you want to work on older builds of ruby
|
39
|
+
spec.add_development_dependency 'listen', '3.0.7'
|
40
|
+
|
41
|
+
# This gives you the chance to run a REPL inside your tests
|
42
|
+
# via:
|
43
|
+
#
|
44
|
+
# require 'pry'
|
45
|
+
# binding.pry
|
46
|
+
#
|
47
|
+
# This will stop test execution and let you inspect the results
|
48
|
+
spec.add_development_dependency 'pry'
|
49
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require "htmllint/gem_version"
|
@@ -0,0 +1 @@
|
|
1
|
+
require "htmllint/plugin"
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# require "mkmf"
|
2
|
+
require "json"
|
3
|
+
|
4
|
+
module Danger
|
5
|
+
# [Danger](http://danger.systems/ruby/) plugin depends on [htmllint-cli](https://github.com/htmllint/htmllint-cli/).
|
6
|
+
#
|
7
|
+
# @example Run htmllint and send violations as inline comment.
|
8
|
+
#
|
9
|
+
# # Lint added and modified files only
|
10
|
+
# htmllint.lint
|
11
|
+
#
|
12
|
+
# @see konifar/danger-htmllint
|
13
|
+
# @tags lint, htmllint
|
14
|
+
#
|
15
|
+
class DangerHtmllint < Plugin
|
16
|
+
# .htmllintrc path
|
17
|
+
# @return [String]
|
18
|
+
attr_accessor :rc_path
|
19
|
+
|
20
|
+
# Set danger fail when errors are detected
|
21
|
+
# @return [Bool]
|
22
|
+
attr_accessor :fail_on_error
|
23
|
+
|
24
|
+
# Execute htmllint and send comment
|
25
|
+
# @return [void]
|
26
|
+
def lint
|
27
|
+
return if target_files.empty?
|
28
|
+
|
29
|
+
result = run_htmllint(htmllint_bin_path, target_files)
|
30
|
+
send_comment(parse(result))
|
31
|
+
end
|
32
|
+
|
33
|
+
private
|
34
|
+
|
35
|
+
def htmllint_bin_path
|
36
|
+
local = "./node_modules/.bin/htmllint"
|
37
|
+
raise "htmlslint not found in ./node_modules/.bin/htmllint" unless File.exist?(local)
|
38
|
+
|
39
|
+
local
|
40
|
+
end
|
41
|
+
|
42
|
+
def htmllint_command(bin, target_files)
|
43
|
+
command = "#{bin} #{target_files.join(' ')}"
|
44
|
+
command << " --rc #{rc_path}" if rc_path
|
45
|
+
command
|
46
|
+
end
|
47
|
+
|
48
|
+
def run_htmllint(bin, target_files)
|
49
|
+
`#{htmllint_command(bin, target_files)}`
|
50
|
+
end
|
51
|
+
|
52
|
+
def target_files
|
53
|
+
((git.modified_files - git.deleted_files) + git.added_files)
|
54
|
+
end
|
55
|
+
|
56
|
+
def parse(result)
|
57
|
+
result.split("\n").flat_map do |item|
|
58
|
+
path_and_err = item.split(":")
|
59
|
+
break if path_and_err.empty?
|
60
|
+
|
61
|
+
file_path = path_and_err.first
|
62
|
+
|
63
|
+
line_col_err_msg = path_and_err.last.split(", ")
|
64
|
+
line = line_col_err_msg[0].sub("line ", "").to_i
|
65
|
+
col = line_col_err_msg[1].sub("col ", "")
|
66
|
+
err_msg = line_col_err_msg[2]
|
67
|
+
|
68
|
+
{
|
69
|
+
file_path: file_path,
|
70
|
+
line: line,
|
71
|
+
severity: severity_level(fail_on_error),
|
72
|
+
message: "#{err_msg} (col:#{col})"
|
73
|
+
}
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
def severity_level(fail_on_error)
|
78
|
+
fail_on_error ? "fail" : "warn"
|
79
|
+
end
|
80
|
+
|
81
|
+
def send_comment(errors)
|
82
|
+
errors.each do |error|
|
83
|
+
send(error[:severity], error[:message], file: error[:file_path], line: error[:line])
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
require File.expand_path("spec_helper", __dir__)
|
2
|
+
|
3
|
+
module Danger
|
4
|
+
describe "with Dangerfile" do
|
5
|
+
before do
|
6
|
+
@dangerfile = testing_dangerfile
|
7
|
+
@htmllint = @dangerfile.htmllint
|
8
|
+
|
9
|
+
# stub
|
10
|
+
allow(@htmllint).to receive(:htmllint_bin_path).and_return("./node_modules/.bin/htmllint")
|
11
|
+
allow(@htmllint.git).to receive(:added_files).and_return([])
|
12
|
+
allow(@htmllint.git).to receive(:modified_files).and_return([])
|
13
|
+
allow(@htmllint.git).to receive(:deleted_files).and_return([])
|
14
|
+
end
|
15
|
+
|
16
|
+
describe ".parse" do
|
17
|
+
subject(:errors) do
|
18
|
+
@htmllint.send(:parse, fixture)
|
19
|
+
end
|
20
|
+
|
21
|
+
context "when result has 2 errors" do
|
22
|
+
let(:fixture) do
|
23
|
+
"app/index.html: line 1, col 1, tag names must be lowercase\nindex.html: line 592, col 1, indenting spaces must be used in groups of 2\n"
|
24
|
+
end
|
25
|
+
|
26
|
+
it "has 2 errors" do
|
27
|
+
expect(errors.size).to eq(2)
|
28
|
+
end
|
29
|
+
|
30
|
+
it "is mapped to be valid hash on first item" do
|
31
|
+
expected = {
|
32
|
+
file_path: "app/index.html",
|
33
|
+
line: 1,
|
34
|
+
severity: "warn",
|
35
|
+
message: "tag names must be lowercase (col:1)"
|
36
|
+
}
|
37
|
+
expect(errors[0]).to eq(expected)
|
38
|
+
end
|
39
|
+
|
40
|
+
context "with fail_on_error = true" do
|
41
|
+
before do
|
42
|
+
@htmllint.fail_on_error = true
|
43
|
+
end
|
44
|
+
|
45
|
+
it "is mapped to be fail severity" do
|
46
|
+
expect(errors.all? { |error| error[:severity] == "fail" }).to be true
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
context "when result has no error" do
|
52
|
+
let(:fixture) do
|
53
|
+
""
|
54
|
+
end
|
55
|
+
|
56
|
+
it "has 0 error" do
|
57
|
+
expect(errors.size).to eq(0)
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
describe ".htmllint_command" do
|
63
|
+
subject(:command) do
|
64
|
+
@htmllint.send(:htmllint_command, "./node_modules/.bin/htmllint", target_files)
|
65
|
+
end
|
66
|
+
|
67
|
+
context "when target_files has 2 items" do
|
68
|
+
let(:target_files) do
|
69
|
+
%w(app/index.html index.html)
|
70
|
+
end
|
71
|
+
|
72
|
+
it "is correct command" do
|
73
|
+
expect(command).to eq("./node_modules/.bin/htmllint app/index.html index.html")
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
context "when target_files has nothing" do
|
78
|
+
let(:target_files) do
|
79
|
+
[]
|
80
|
+
end
|
81
|
+
|
82
|
+
it "is correct command" do
|
83
|
+
expect(command).to eq("./node_modules/.bin/htmllint ")
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
context "when rc_path = .textlintrc" do
|
88
|
+
before do
|
89
|
+
@htmllint.rc_path = ".textlintrc"
|
90
|
+
end
|
91
|
+
|
92
|
+
let(:target_files) do
|
93
|
+
%w(index.html)
|
94
|
+
end
|
95
|
+
|
96
|
+
it "is correct command" do
|
97
|
+
expect(command).to eq("./node_modules/.bin/htmllint index.html --rc .textlintrc")
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
require "pathname"
|
2
|
+
ROOT = Pathname.new(File.expand_path(__dir__))
|
3
|
+
$:.unshift((ROOT + "lib").to_s)
|
4
|
+
$:.unshift((ROOT + "spec").to_s)
|
5
|
+
|
6
|
+
require "bundler/setup"
|
7
|
+
require "pry"
|
8
|
+
|
9
|
+
require "rspec"
|
10
|
+
require "danger"
|
11
|
+
|
12
|
+
if `git remote -v` == ""
|
13
|
+
puts "You cannot run tests without setting a local git remote on this repo"
|
14
|
+
puts "It's a weird side-effect of Danger's internals."
|
15
|
+
exit(0)
|
16
|
+
end
|
17
|
+
|
18
|
+
# Use coloured output, it's the best.
|
19
|
+
RSpec.configure do |config|
|
20
|
+
config.filter_gems_from_backtrace "bundler"
|
21
|
+
config.color = true
|
22
|
+
config.tty = true
|
23
|
+
end
|
24
|
+
|
25
|
+
require "danger_plugin"
|
26
|
+
|
27
|
+
# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
|
28
|
+
# If you are expanding these files, see if it's already been done ^.
|
29
|
+
|
30
|
+
# A silent version of the user interface,
|
31
|
+
# it comes with an extra function `.string` which will
|
32
|
+
# strip all ANSI colours from the string.
|
33
|
+
|
34
|
+
# rubocop:disable Lint/NestedMethodDefinition
|
35
|
+
def testing_ui
|
36
|
+
@output = StringIO.new
|
37
|
+
def @output.winsize
|
38
|
+
[20, 9999]
|
39
|
+
end
|
40
|
+
|
41
|
+
cork = Cork::Board.new(out: @output)
|
42
|
+
def cork.string
|
43
|
+
out.string.gsub(/\e\[([;\d]+)?m/, "")
|
44
|
+
end
|
45
|
+
cork
|
46
|
+
end
|
47
|
+
# rubocop:enable Lint/NestedMethodDefinition
|
48
|
+
|
49
|
+
# Example environment (ENV) that would come from
|
50
|
+
# running a PR on TravisCI
|
51
|
+
def testing_env
|
52
|
+
{
|
53
|
+
"HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
|
54
|
+
"TRAVIS_PULL_REQUEST" => "800",
|
55
|
+
"TRAVIS_REPO_SLUG" => "artsy/eigen",
|
56
|
+
"TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
|
57
|
+
"DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
|
58
|
+
}
|
59
|
+
end
|
60
|
+
|
61
|
+
# A stubbed out Dangerfile for use in tests
|
62
|
+
def testing_dangerfile
|
63
|
+
env = Danger::EnvironmentManager.new(testing_env)
|
64
|
+
Danger::Dangerfile.new(env, testing_ui)
|
65
|
+
end
|
metadata
ADDED
@@ -0,0 +1,204 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: danger-htmllint
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- konifar
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-09-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: danger-plugin-api
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.4'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.4'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rubocop
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: yard
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: guard
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '2.14'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '2.14'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: guard-rspec
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '4.7'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '4.7'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: listen
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - '='
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 3.0.7
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - '='
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 3.0.7
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: pry
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
type: :development
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - ">="
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: '0'
|
153
|
+
description: Danger plugin for htmllint. https://github.com/htmllint/htmllint/
|
154
|
+
email:
|
155
|
+
- yahpeycoy0403@gmail.com
|
156
|
+
executables: []
|
157
|
+
extensions: []
|
158
|
+
extra_rdoc_files: []
|
159
|
+
files:
|
160
|
+
- ".dependabot/config.yml"
|
161
|
+
- ".github/workflows/ci.yml"
|
162
|
+
- ".gitignore"
|
163
|
+
- ".rubocop.yml"
|
164
|
+
- ".travis.yml"
|
165
|
+
- Gemfile
|
166
|
+
- Gemfile.lock
|
167
|
+
- Guardfile
|
168
|
+
- LICENSE.txt
|
169
|
+
- README.md
|
170
|
+
- Rakefile
|
171
|
+
- danger-htmllint.gemspec
|
172
|
+
- lib/danger_htmllint.rb
|
173
|
+
- lib/danger_plugin.rb
|
174
|
+
- lib/htmllint/gem_version.rb
|
175
|
+
- lib/htmllint/plugin.rb
|
176
|
+
- spec/htmllint_spec.rb
|
177
|
+
- spec/spec_helper.rb
|
178
|
+
homepage: https://github.com/konifar/danger-htmllint
|
179
|
+
licenses:
|
180
|
+
- MIT
|
181
|
+
metadata: {}
|
182
|
+
post_install_message:
|
183
|
+
rdoc_options: []
|
184
|
+
require_paths:
|
185
|
+
- lib
|
186
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
187
|
+
requirements:
|
188
|
+
- - ">="
|
189
|
+
- !ruby/object:Gem::Version
|
190
|
+
version: '0'
|
191
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
192
|
+
requirements:
|
193
|
+
- - ">="
|
194
|
+
- !ruby/object:Gem::Version
|
195
|
+
version: '0'
|
196
|
+
requirements: []
|
197
|
+
rubyforge_project:
|
198
|
+
rubygems_version: 2.6.8
|
199
|
+
signing_key:
|
200
|
+
specification_version: 4
|
201
|
+
summary: Danger plugin for htmllint.
|
202
|
+
test_files:
|
203
|
+
- spec/htmllint_spec.rb
|
204
|
+
- spec/spec_helper.rb
|