mdl 0.7.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mdl/doc.rb +1 -1
- data/lib/mdl/version.rb +1 -1
- data/mdl.gemspec +3 -3
- metadata +4 -266
- data/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md +0 -22
- data/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md +0 -40
- data/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST.md +0 -20
- data/.github/ISSUE_TEMPLATE/RULE_REQUEST.md +0 -20
- data/.github/PULL_REQUEST_TEMPLATE.md +0 -23
- data/.gitignore +0 -13
- data/.pre-commit-hooks.yaml +0 -6
- data/.travis.yml +0 -12
- data/CHANGELOG.md +0 -218
- data/CONTRIBUTING.md +0 -76
- data/MAINTAINERS.md +0 -21
- data/README.md +0 -87
- data/Rakefile +0 -8
- data/docs/RULES.md +0 -1089
- data/docs/configuration.md +0 -99
- data/docs/creating_rules.md +0 -90
- data/docs/creating_styles.md +0 -47
- data/docs/rolling_a_release.md +0 -51
- data/example/markdown_spec.md +0 -897
- data/test/fixtures/default_mdlrc +0 -1
- data/test/fixtures/dir_with_md_and_markdown/bar.markdown +0 -1
- data/test/fixtures/dir_with_md_and_markdown/foo.md +0 -1
- data/test/fixtures/front_matter/jekyll_post.md +0 -16
- data/test/fixtures/front_matter/jekyll_post_2.md +0 -17
- data/test/fixtures/mdlrc_disable_rules +0 -1
- data/test/fixtures/mdlrc_disable_tags +0 -1
- data/test/fixtures/mdlrc_enable_rules +0 -1
- data/test/fixtures/mdlrc_enable_tags +0 -1
- data/test/fixtures/my_ruleset.rb +0 -6
- data/test/rule_tests/alternate_top_level_header.md +0 -3
- data/test/rule_tests/alternate_top_level_header_style.rb +0 -4
- data/test/rule_tests/atx_closed_header_spacing.md +0 -17
- data/test/rule_tests/atx_header_spacing.md +0 -5
- data/test/rule_tests/blockquote_blank_lines.md +0 -31
- data/test/rule_tests/blockquote_spaces.md +0 -23
- data/test/rule_tests/bulleted_list_2_space_indent.md +0 -6
- data/test/rule_tests/bulleted_list_2_space_indent_style.rb +0 -3
- data/test/rule_tests/bulleted_list_4_space_indent.md +0 -3
- data/test/rule_tests/bulleted_list_not_at_beginning_of_line.md +0 -14
- data/test/rule_tests/code_block_consistency.md +0 -11
- data/test/rule_tests/code_block_consistency_style.rb +0 -1
- data/test/rule_tests/code_block_dollar.md +0 -33
- data/test/rule_tests/code_block_dollar_fence.md +0 -29
- data/test/rule_tests/code_block_fenced.md +0 -17
- data/test/rule_tests/code_block_fenced_style.rb +0 -1
- data/test/rule_tests/code_block_indented.md +0 -17
- data/test/rule_tests/code_block_indented_style.rb +0 -1
- data/test/rule_tests/consecutive_blank_lines.md +0 -11
- data/test/rule_tests/consistent_bullet_styles_asterisk.md +0 -3
- data/test/rule_tests/consistent_bullet_styles_dash.md +0 -3
- data/test/rule_tests/consistent_bullet_styles_plus.md +0 -3
- data/test/rule_tests/default_test_style.rb +0 -5
- data/test/rule_tests/emphasis_instead_of_headers.md +0 -42
- data/test/rule_tests/empty_doc.md +0 -0
- data/test/rule_tests/fenced_code_blocks.md +0 -27
- data/test/rule_tests/fenced_code_with_nesting.md +0 -73
- data/test/rule_tests/fenced_code_without_blank_lines.md +0 -42
- data/test/rule_tests/fenced_code_without_blank_lines_style.rb +0 -3
- data/test/rule_tests/first_header_bad_atx.md +0 -1
- data/test/rule_tests/first_header_bad_setext.md +0 -2
- data/test/rule_tests/first_header_good_atx.md +0 -1
- data/test/rule_tests/first_header_good_setext.md +0 -2
- data/test/rule_tests/first_line_top_level_header_atx.md +0 -3
- data/test/rule_tests/first_line_top_level_header_atx_style.rb +0 -2
- data/test/rule_tests/first_line_top_level_header_setext.md +0 -4
- data/test/rule_tests/first_line_top_level_header_setext_style.rb +0 -2
- data/test/rule_tests/fix_102_extra_nodes_in_link_text.md +0 -8
- data/test/rule_tests/header_duplicate_content.md +0 -11
- data/test/rule_tests/header_duplicate_content_different_nesting.md +0 -11
- data/test/rule_tests/header_duplicate_content_different_nesting_style.rb +0 -1
- data/test/rule_tests/header_duplicate_content_no_different_nesting.md +0 -13
- data/test/rule_tests/header_multiple_toplevel.md +0 -3
- data/test/rule_tests/header_mutliple_h1_no_toplevel.md +0 -5
- data/test/rule_tests/header_trailing_punctuation.md +0 -11
- data/test/rule_tests/header_trailing_punctuation_customized.md +0 -14
- data/test/rule_tests/header_trailing_punctuation_customized_style.rb +0 -2
- data/test/rule_tests/headers_bad.md +0 -7
- data/test/rule_tests/headers_good.md +0 -5
- data/test/rule_tests/headers_good_setext_with_atx.md +0 -7
- data/test/rule_tests/headers_good_setext_with_atx_style.rb +0 -2
- data/test/rule_tests/headers_good_with_issue_numbers.md +0 -12
- data/test/rule_tests/headers_surrounding_space_atx.md +0 -12
- data/test/rule_tests/headers_surrounding_space_setext.md +0 -15
- data/test/rule_tests/headers_with_spaces_at_the_beginning.md +0 -20
- data/test/rule_tests/hr_style_dashes.md +0 -22
- data/test/rule_tests/hr_style_dashes_style.rb +0 -3
- data/test/rule_tests/hr_style_inconsistent.md +0 -22
- data/test/rule_tests/hr_style_long.md +0 -22
- data/test/rule_tests/hr_style_long_style.rb +0 -3
- data/test/rule_tests/hr_style_stars.md +0 -22
- data/test/rule_tests/hr_style_stars_style.rb +0 -3
- data/test/rule_tests/inconsistent_bullet_indent_same_level.md +0 -4
- data/test/rule_tests/inconsistent_bullet_styles_asterisk.md +0 -3
- data/test/rule_tests/inconsistent_bullet_styles_dash.md +0 -3
- data/test/rule_tests/inconsistent_bullet_styles_plus.md +0 -3
- data/test/rule_tests/incorrect_bullet_style_asterisk.md +0 -3
- data/test/rule_tests/incorrect_bullet_style_asterisk_style.rb +0 -3
- data/test/rule_tests/incorrect_bullet_style_dash.md +0 -3
- data/test/rule_tests/incorrect_bullet_style_dash_style.rb +0 -3
- data/test/rule_tests/incorrect_bullet_style_plus.md +0 -3
- data/test/rule_tests/incorrect_bullet_style_plus_style.rb +0 -3
- data/test/rule_tests/incorrect_header_atx.md +0 -6
- data/test/rule_tests/incorrect_header_atx_closed.md +0 -6
- data/test/rule_tests/incorrect_header_atx_closed_style.rb +0 -2
- data/test/rule_tests/incorrect_header_atx_style.rb +0 -2
- data/test/rule_tests/incorrect_header_setext.md +0 -6
- data/test/rule_tests/incorrect_header_setext_style.rb +0 -2
- data/test/rule_tests/inline_html.md +0 -13
- data/test/rule_tests/links.md +0 -9
- data/test/rule_tests/lists_without_blank_lines.md +0 -75
- data/test/rule_tests/long_lines.md +0 -3
- data/test/rule_tests/long_lines_100.md +0 -7
- data/test/rule_tests/long_lines_100_style.rb +0 -3
- data/test/rule_tests/long_lines_code.md +0 -45
- data/test/rule_tests/long_lines_code_style.rb +0 -3
- data/test/rule_tests/mixed_header_types_atx.md +0 -6
- data/test/rule_tests/mixed_header_types_atx_closed.md +0 -6
- data/test/rule_tests/mixed_header_types_setext.md +0 -6
- data/test/rule_tests/no_first_line_header.md +0 -1
- data/test/rule_tests/no_first_line_header_style.rb +0 -1
- data/test/rule_tests/no_first_line_top_level_header.md +0 -1
- data/test/rule_tests/no_first_line_top_level_header_style.rb +0 -1
- data/test/rule_tests/ordered_list_item_prefix.md +0 -13
- data/test/rule_tests/ordered_list_item_prefix_ordered.md +0 -13
- data/test/rule_tests/ordered_list_item_prefix_ordered_style.rb +0 -3
- data/test/rule_tests/reversed_link.md +0 -7
- data/test/rule_tests/spaces_after_list_marker.md +0 -74
- data/test/rule_tests/spaces_after_list_marker_style.rb +0 -5
- data/test/rule_tests/spaces_inside_codespan_elements.md +0 -7
- data/test/rule_tests/spaces_inside_emphasis_markers.md +0 -35
- data/test/rule_tests/spaces_inside_link_text.md +0 -28
- data/test/rule_tests/trailing_spaces_br.md +0 -4
- data/test/rule_tests/trailing_spaces_br_style.rb +0 -3
- data/test/rule_tests/whitespace_issues.md +0 -3
- data/test/setup_tests.rb +0 -5
- data/test/test_cli.rb +0 -301
- data/test/test_ruledocs.rb +0 -52
- data/test/test_rules.rb +0 -58
- data/tools/README.md +0 -3
- data/tools/docker/Dockerfile +0 -13
- data/tools/docker/README.md +0 -19
- data/tools/test_location.rb +0 -20
- data/tools/view_markdown.rb +0 -11
@@ -1,23 +0,0 @@
|
|
1
|
-
## Description
|
2
|
-
<!--- Describe your changes in detail, what problems does it solve? See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) for tips on writing a good commit message -->
|
3
|
-
|
4
|
-
## Related Issues
|
5
|
-
<!--- If you are suggesting a new feature or change, please create an issue first -->
|
6
|
-
<!--- Add a link to all corresponding Github issues here, using any [appropriate keywords](https://help.github.com/en/articles/closing-issues-using-keywords) as appropriate -->
|
7
|
-
|
8
|
-
## Types of changes
|
9
|
-
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
10
|
-
- [ ] Bug fix (non-breaking change which fixes an issue)
|
11
|
-
- [ ] New feature (non-breaking change which adds functionality)
|
12
|
-
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
13
|
-
- [ ] Documentation (non-breaking change that does not add functionality but updates documentation)
|
14
|
-
- [ ] Chore (non-breaking change that does not add functionality or fix an issue)
|
15
|
-
|
16
|
-
## Checklist:
|
17
|
-
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
18
|
-
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
19
|
-
- [ ] I have read the [**CONTRIBUTING**](https://github.com/markdownlint/markdownlint/blob/master/CONTRIBUTING.md) document.
|
20
|
-
- [ ] Wrote [good commit messages](https://chris.beams.io/posts/git-commit/)
|
21
|
-
- [ ] Feature branch is up-to-date with `master`, if not - rebase it
|
22
|
-
- [ ] Added tests for all new/changed functionality, including tests for positive and negative scenarios
|
23
|
-
- [ ] The PR relates to *only* one subject with a clear title and description in grammatically correct, complete sentences
|
data/.gitignore
DELETED
data/.pre-commit-hooks.yaml
DELETED
data/.travis.yml
DELETED
data/CHANGELOG.md
DELETED
@@ -1,218 +0,0 @@
|
|
1
|
-
# Change Log
|
2
|
-
|
3
|
-
## [v0.7.0] (2019-10-24)
|
4
|
-
|
5
|
-
### Added
|
6
|
-
|
7
|
-
* Pull request and issue templates for users and contributors
|
8
|
-
* Move to kramdown 2
|
9
|
-
* Handle Kramdown TOC
|
10
|
-
* Loosen various dependencies and move minimum ruby version to 2.4
|
11
|
-
|
12
|
-
## [v0.6.0] (2019-10-19)
|
13
|
-
|
14
|
-
### Added
|
15
|
-
|
16
|
-
* There are now CONTRIBUTING.md and MAINTAINERS.md docs
|
17
|
-
* There is now a `.pre-commit-hooks.yaml` for those who want to use pre-commit.com
|
18
|
-
|
19
|
-
### Changed
|
20
|
-
|
21
|
-
* PR #248: Ignore blank line after front matter
|
22
|
-
* PR #231: Only import JSON when necessary (#223)
|
23
|
-
* PR #265: Use newere mixlib-cli
|
24
|
-
* PR #246: Nicer error message when activating nonexistent rule
|
25
|
-
* PR #241: Fix documentation on `ignore_front_matter`
|
26
|
-
* PR #245: Update docs to use "MY" prefix for custom rule example
|
27
|
-
* PR #256: Fix crash in MD039 when the link text is empty
|
28
|
-
* PR #229: Reference Node.js markdownlint
|
29
|
-
* PR #232: Added table of contents to RULES.md for easier navigation
|
30
|
-
* PR #219: Fix typos in MD046 docs
|
31
|
-
* PR #222: Fixed MD036 crash
|
32
|
-
|
33
|
-
### Removed
|
34
|
-
|
35
|
-
## [v0.5.0] (2018-07-01)
|
36
|
-
|
37
|
-
### Added
|
38
|
-
|
39
|
-
* Add md042 to enforce code block style
|
40
|
-
* JSON formatter/output
|
41
|
-
|
42
|
-
### Changed
|
43
|
-
|
44
|
-
* PR #200: allow different nesting on headers duplication check
|
45
|
-
* MD036 - Ignore multi-line emphasized paragraphs, and emphasized paragraphs
|
46
|
-
that end in punctuation (#140)
|
47
|
-
|
48
|
-
### Fixed
|
49
|
-
|
50
|
-
* PR #168: fix issue numbers false positives
|
51
|
-
* Fix issue #102: lint MD039 checking for nodes inside link text
|
52
|
-
|
53
|
-
## [v0.4.0] (2016-08-22)
|
54
|
-
|
55
|
-
### Added
|
56
|
-
|
57
|
-
* Ignore yaml front matter option (#130, #143)
|
58
|
-
|
59
|
-
### Changed
|
60
|
-
|
61
|
-
* Allow top level header rules (MD002, MD025, MD041) to be configurable (#142)
|
62
|
-
|
63
|
-
### Fixed
|
64
|
-
|
65
|
-
* Read UTF-8 files correctly even if locale is set to C (#135, #146, #147,
|
66
|
-
#148)
|
67
|
-
* Fix issues loading .mdlrc file (#126, #129, #133, #148)
|
68
|
-
* Fix erroneous triggering of MD022/MD023 in some cases (#144)
|
69
|
-
* Detect codeblock lines correctly when ignoring them (#141)
|
70
|
-
|
71
|
-
## [v0.3.1] (2016-03-20)
|
72
|
-
|
73
|
-
### Fixed
|
74
|
-
|
75
|
-
* Fix error on starting mdl
|
76
|
-
|
77
|
-
## [v0.3.0] (2016-03-19)
|
78
|
-
|
79
|
-
### Rules added
|
80
|
-
|
81
|
-
* MD041 - First line in file should be a top level header
|
82
|
-
|
83
|
-
### Added
|
84
|
-
|
85
|
-
* You can now load your own custom rules with the `-u` option. See
|
86
|
-
[rules.rb](https://github.com/markdownlint/markdownlint/blob/master/lib/mdl/rules.rb)
|
87
|
-
for an example of what a rules file looks like. Use the `-d` option if you
|
88
|
-
don't want to load markdownlint's default ruleset.
|
89
|
-
* You can now refer to rules by human-readable/writable aliases, such as
|
90
|
-
'ul-style' instead of 'MD004'. See RULES.md for a list of the rule aliases.
|
91
|
-
You can pass the `-a` option to display rule aliases instead of MDxxx rule
|
92
|
-
IDs.
|
93
|
-
|
94
|
-
### Changed
|
95
|
-
|
96
|
-
* MD003 - An additional header style, setext_with_atx, was added to require
|
97
|
-
setext style headers for levels 1 and 2, but allow atx style headers for
|
98
|
-
levels 3 and above (i.e. header levels that can't be expressed with setext
|
99
|
-
style headers)
|
100
|
-
* MD013 - You now have the option to exclude code blocks and tables from the
|
101
|
-
line length limit check.
|
102
|
-
|
103
|
-
### Fixed
|
104
|
-
|
105
|
-
* Crash with MD034 and pipe character (#93, #97)
|
106
|
-
* MD031 failed on nested code blocks (#100, #109)
|
107
|
-
* MD037 crashes on <li> with underscores (#83)
|
108
|
-
* Regression introduced in v0.2.1 - ignoring rules/tags on the command line
|
109
|
-
caused a crash (#108)
|
110
|
-
* MD027 false positive when line starts with a backtick (#105)
|
111
|
-
|
112
|
-
### Merged pull requests
|
113
|
-
|
114
|
-
* [Add support for nested code fences to MD031/MD032 - David
|
115
|
-
Anson](https://github.com/markdownlint/markdownlint/pull/109)
|
116
|
-
* [Add missing word to description of MD035 in RULES.md - David
|
117
|
-
Anson](https://github.com/markdownlint/markdownlint/pull/86)
|
118
|
-
* [Probe for .mdlrc in current and parent directories - Loic
|
119
|
-
Nageleisen](https://github.com/markdownlint/markdownlint/pull/111)
|
120
|
-
* [MD013: allow excluding code blocks and tables - Loic
|
121
|
-
Nageleisen](https://github.com/markdownlint/markdownlint/pull/112)
|
122
|
-
|
123
|
-
## [v0.2.1] (2015-04-13)
|
124
|
-
|
125
|
-
### Fixed
|
126
|
-
|
127
|
-
* Incorrect parsing of rules/tags specification in .mdlrc (#81)
|
128
|
-
* Exception on image links with MD039 (#82)
|
129
|
-
* MD037 flags on two words beginning with underscores on the same line. (#83)
|
130
|
-
|
131
|
-
### Known issues
|
132
|
-
|
133
|
-
* Exception on some lines with raw html list items in them (#83)
|
134
|
-
|
135
|
-
## [v0.2.0] (2015-04-13)
|
136
|
-
|
137
|
-
### Rules added
|
138
|
-
|
139
|
-
* MD033 - Inline HTML
|
140
|
-
* MD034 - Bare URL used
|
141
|
-
* MD035 - Horizontal rule style
|
142
|
-
* MD036 - Emphasis used instead of a header
|
143
|
-
* MD037 - Spaces inside emphasis markers
|
144
|
-
* MD038 - Spaces inside code span elements
|
145
|
-
* MD039 - Spaces inside link text
|
146
|
-
* MD040 - Fenced code blocks should have a language specified
|
147
|
-
|
148
|
-
## Added
|
149
|
-
|
150
|
-
* Trailing spaces rule should allow an excemption for deliberate <br/\>
|
151
|
-
insertion.
|
152
|
-
* Rules can be excluded in .mdlrc and on the command line by specifying a rule
|
153
|
-
as ~MD000.
|
154
|
-
|
155
|
-
### Merged pull requests
|
156
|
-
|
157
|
-
* [Add parameter (value and default) information to rule documentation. - David Anson](https://github.com/markdownlint/markdownlint/pull/76)
|
158
|
-
|
159
|
-
## [v0.1.0] (2015-02-22)
|
160
|
-
|
161
|
-
### Rules added
|
162
|
-
|
163
|
-
* MD031 - Fenced code blocks should be surrounded by blank lines
|
164
|
-
* MD032 - Lists should be surrounded by blank lines
|
165
|
-
|
166
|
-
### Fixed
|
167
|
-
|
168
|
-
* MD014 triggers when it shouldn't
|
169
|
-
|
170
|
-
### Merged pull requests
|
171
|
-
|
172
|
-
* [MD032 - Lists should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/70)
|
173
|
-
* [MD031 - Fenced code blocks should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/68)
|
174
|
-
* [Clarify how to specify your own style - mjankowski](https://github.com/markdownlint/markdownlint/pull/65)
|
175
|
-
* [Use single quotes to prevent early escaping - highb](https://github.com/markdownlint/markdownlint/pull/64)
|
176
|
-
|
177
|
-
## [v0.0.1] (2014-09-07)
|
178
|
-
|
179
|
-
### Rules added
|
180
|
-
|
181
|
-
* MD001 - Header levels should only increment by one level at a time
|
182
|
-
* MD002 - First header should be a h1 header
|
183
|
-
* MD003 - Header style
|
184
|
-
* MD004 - Unordered list style
|
185
|
-
* MD005 - Inconsistent indentation for list items at the same level
|
186
|
-
* MD006 - Consider starting bulleted lists at the beginning of the line
|
187
|
-
* MD007 - Unordered list indentation
|
188
|
-
* MD009 - Trailing spaces
|
189
|
-
* MD010 - Hard tabs
|
190
|
-
* MD011 - Reversed link syntax
|
191
|
-
* MD012 - Multiple consecutive blank lines
|
192
|
-
* MD013 - Line length
|
193
|
-
* MD014 - Dollar signs used before commands without showing output
|
194
|
-
* MD018 - No space after hash on atx style header
|
195
|
-
* MD019 - Multiple spaces after hash on atx style header
|
196
|
-
* MD020 - No space inside hashes on closed atx style header
|
197
|
-
* MD021 - Multiple spaces inside hashes on closed atx style header
|
198
|
-
* MD022 - Headers should be surrounded by blank lines
|
199
|
-
* MD023 - Headers must start at the beginning of the line
|
200
|
-
* MD024 - Multiple headers with the same content
|
201
|
-
* MD025 - Multiple top level headers in the same document
|
202
|
-
* MD026 - Trailing punctuation in header
|
203
|
-
* MD027 - Multiple spaces after blockquote symbol
|
204
|
-
* MD028 - Blank line inside blockquote
|
205
|
-
* MD029 - Ordered list item prefix
|
206
|
-
* MD030 - Spaces after list markers
|
207
|
-
|
208
|
-
[Unreleased]: https://github.com/markdownlint/markdownlint/tree/master
|
209
|
-
[v0.7.0]: https://github.com/markdownlint/markdownlint/tree/v0.7.0
|
210
|
-
[v0.6.0]: https://github.com/markdownlint/markdownlint/tree/v0.6.0
|
211
|
-
[v0.5.0]: https://github.com/markdownlint/markdownlint/tree/v0.5.0
|
212
|
-
[v0.4.0]: https://github.com/markdownlint/markdownlint/tree/v0.4.0
|
213
|
-
[v0.3.1]: https://github.com/markdownlint/markdownlint/tree/v0.3.1
|
214
|
-
[v0.3.0]: https://github.com/markdownlint/markdownlint/tree/v0.3.0
|
215
|
-
[v0.2.1]: https://github.com/markdownlint/markdownlint/tree/v0.2.1
|
216
|
-
[v0.2.0]: https://github.com/markdownlint/markdownlint/tree/v0.2.0
|
217
|
-
[v0.1.0]: https://github.com/markdownlint/markdownlint/tree/v0.1.0
|
218
|
-
[v0.0.1]: https://github.com/markdownlint/markdownlint/tree/v0.0.1
|
data/CONTRIBUTING.md
DELETED
@@ -1,76 +0,0 @@
|
|
1
|
-
# Contributing to Markdownlint
|
2
|
-
|
3
|
-
We're glad you want to contribute markdownlint! This document will help answer common questions you may have during your first contribution. Please, try to follow these guidelines when you do so.
|
4
|
-
|
5
|
-
## Issue Reporting
|
6
|
-
|
7
|
-
Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. We use GitHub to track all project issues. If you discover bugs, have ideas for improvements or new features, please start by [opening an issue](https://github.com/markdownlint/markdownlint/issues) on this repository. We use issues to centralize the discussion and agree on a plan of action before spending time and effort writing code that might not get used.
|
8
|
-
|
9
|
-
### Submitting An Issue
|
10
|
-
|
11
|
-
* Check that the issue has not already been reported
|
12
|
-
* Check that the issue has not already been fixed in the latest code (a.k.a. `master`)
|
13
|
-
* Select the appropriate issue type and open an issue with a descriptive title
|
14
|
-
* Be clear, concise, and precise using grammatically correct, complete sentences in your summary of the problem
|
15
|
-
* Include the output of `mdl -V` or `mdl --version`
|
16
|
-
* Include any relevant code in the issue
|
17
|
-
|
18
|
-
## Code Contributions
|
19
|
-
|
20
|
-
Markdownlint follows a [forking workflow](https://guides.github.com/activities/forking/), and we have a simple process for contributions:
|
21
|
-
|
22
|
-
1. Open an issue on the [project repository](https://github.com/markdownlint/markdownlint/issues), if appropriate
|
23
|
-
1. If you're adding or making changes to rules, read the [Development docs](#local-development)
|
24
|
-
1. Follow the [forking workflow](https://guides.github.com/activities/forking/) steps:
|
25
|
-
1. Fork the project ( <http://github.com/markdownlint/markdownlint/fork> )
|
26
|
-
1. Create your feature branch (`git checkout -b my-new-feature`)
|
27
|
-
1. Commit your changes (`git commit -am 'Add some feature'`)
|
28
|
-
1. Push to the branch (`git push origin my-new-feature`)
|
29
|
-
1. Create a [GitHub Pull Request](https://help.github.com/articles/about-pull-requests/) for your change, following all [pull request requirements](#pull-request-requirements) and any instructions in the pull request template
|
30
|
-
1. Participate in a [Code Review](#code-review-process) with the project maintainers on the pull request
|
31
|
-
|
32
|
-
### Your First Code Contribution
|
33
|
-
|
34
|
-
Unsure where to begin contributing to Markdownlint? You can start by looking through these beginner and help-wanted issues:
|
35
|
-
|
36
|
-
[Beginner issues](https://github.com/markdownlint/markdownlint/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+sort%3Acomments-desc) - issues which should only require a few lines of code, and a test or two.
|
37
|
-
[Help wanted issues](https://github.com/markdownlint/markdownlint/issues?q=is%3aissue+is%3aopen+label%3a%22help+wanted%22+sort%3Acomments-desc) - issues which should be a bit more involved than beginner issues.
|
38
|
-
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
|
39
|
-
|
40
|
-
### Local Development
|
41
|
-
|
42
|
-
**Under Development (Oct 2019)**
|
43
|
-
<!--
|
44
|
-
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
|
45
|
-
* [ ] Run `bundle exec rake default`. It executes all tests and Markdownlint for itself, and generates the documentation
|
46
|
-
-->
|
47
|
-
|
48
|
-
### Pull Request Requirements
|
49
|
-
|
50
|
-
Markdownlint strives to ensure high quality for the project. In order to promote this, we require that all pull requests to meet these specifications:
|
51
|
-
|
52
|
-
* **Tests:** To ensure high quality code and protect against future regressions, we require tests for all new/changed functionality in Markdownlint. Test positive and negative scenarios, try to break the new code now.
|
53
|
-
* **Green CI Tests:** We use [Travis CI](https://travis-ci.org/markdownlint/markdownlint) to test all pull requests. We require these test runs to succeed on every pull request before being merged.
|
54
|
-
|
55
|
-
### Code Review Process
|
56
|
-
|
57
|
-
Code review takes place in GitHub pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with GitHub Pull Requests.
|
58
|
-
|
59
|
-
Once you open a pull request, project maintainers will review your code and respond to your pull request with any feedback they might have. The process at this point is as follows:
|
60
|
-
|
61
|
-
1. A review is required from at least one of the project maintainers. See the master maintainers document for Markdownlint project at <https://github.com/markdownlint/markdownlint/blob/master/MAINTAINERS.md>.
|
62
|
-
1. Your change will be merged into the project's `master` branch, and all [commits will be squashed](https://help.github.com/en/articles/about-pull-request-merges#squash-and-merge-your-pull-request-commits) during the merge.
|
63
|
-
|
64
|
-
If you would like to learn about when your code will be available in a release of Markdownlint, read more about [Markdownlint Release Cycles](#release-cycles).
|
65
|
-
|
66
|
-
# Releases
|
67
|
-
|
68
|
-
We release Markdownlint as a gem to [Rubygems](https://rubygems.org/gems/mdl) and maintain a [Dockerfile](https://hub.docker.com/r/mivok/markdownlint)
|
69
|
-
|
70
|
-
Markdownlint follows the [Semantic Versioning](http://semver.org/) standard. Our standard version numbers look like `X.Y.Z` and translates to:
|
71
|
-
|
72
|
-
* `X` is a major release: has changes that may be incompatible with prior major releases
|
73
|
-
* `Y` is a minor release: adds new functionality and bug fixes in a backwards compatible manner
|
74
|
-
* `Z` is a patch release: adds backwards compatible bug fixes
|
75
|
-
|
76
|
-
*Exception: Versions < 1.0 may introduce backwards-incompatible changes in a minor version*
|
data/MAINTAINERS.md
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
# Markdownlint
|
2
|
-
|
3
|
-
We aim to make sure this project has longevity, and to that end we want to make
|
4
|
-
adding new maintainers a simple process.
|
5
|
-
|
6
|
-
If you would like to be a maintainer, you need to demonstrate some ongoing
|
7
|
-
contributions - either reviews of PRs or PR contributions. They need not be large.
|
8
|
-
Then send a PR to add yourself to this list. The existing maintainers will
|
9
|
-
have a discussion, and assuming there are no objections, you'll be added.
|
10
|
-
|
11
|
-
## Current Maintainers
|
12
|
-
|
13
|
-
* [Phil Dibowitz](https://github.com/jaymzh)
|
14
|
-
* [Naomi Reeves](https://github.com/NaomiReeves)
|
15
|
-
* [Bryan Wann](https://github.com/bwann)
|
16
|
-
* [David Anson](https://github.com/DavidAnson)
|
17
|
-
|
18
|
-
## Past Maintainers
|
19
|
-
|
20
|
-
* [psyomn](https://github.com/psyomn)
|
21
|
-
* [Mark Harrison](https://github.com/mivok)
|
data/README.md
DELETED
@@ -1,87 +0,0 @@
|
|
1
|
-
[![Travis build status](http://api.travis-ci.org/markdownlint/markdownlint.svg)](https://travis-ci.org/markdownlint/markdownlint)
|
2
|
-
[![Gem Version](https://badge.fury.io/rb/mdl.svg)](http://badge.fury.io/rb/mdl)
|
3
|
-
|
4
|
-
# Markdown lint tool
|
5
|
-
|
6
|
-
A tool to check markdown files and flag style issues.
|
7
|
-
|
8
|
-
## Installation
|
9
|
-
|
10
|
-
Markdownlint is written in ruby and is distributed as a rubygem. As long as
|
11
|
-
you have a relatively up to date ruby on your system, markdownlint will be
|
12
|
-
simple to install and use. You have 2 options to install it:
|
13
|
-
|
14
|
-
To install from rubygems, run:
|
15
|
-
|
16
|
-
gem install mdl
|
17
|
-
|
18
|
-
To install the latest development version from github:
|
19
|
-
|
20
|
-
git clone https://github.com/markdownlint/markdownlint
|
21
|
-
cd markdownlint
|
22
|
-
rake install
|
23
|
-
|
24
|
-
|
25
|
-
Note that you will need [rake](https://github.com/ruby/rake)
|
26
|
-
(`gem install rake`) and [bundler](https://github.com/bundler/bundler)
|
27
|
-
(`gem install bundler`) in order to build from source.
|
28
|
-
|
29
|
-
## Usage
|
30
|
-
|
31
|
-
To have markdownlint check your markdown files, simply run `mdl` with the
|
32
|
-
filenames as a parameter:
|
33
|
-
|
34
|
-
mdl README.md
|
35
|
-
|
36
|
-
Markdownlint can also take a directory, and it will scan all markdown files
|
37
|
-
within the directory (and nested directories):
|
38
|
-
|
39
|
-
mdl docs/
|
40
|
-
|
41
|
-
If you don't specify a filename, markdownlint will use stdin:
|
42
|
-
|
43
|
-
cat foo.md | mdl
|
44
|
-
|
45
|
-
Markdownlint will output a list of issues it finds, and the line number where
|
46
|
-
the issue is. See [RULES.md](docs/RULES.md) for information on each issue, as
|
47
|
-
well as how to correct it:
|
48
|
-
|
49
|
-
README.md:1: MD013 Line length
|
50
|
-
README.md:70: MD029 Ordered list item prefix
|
51
|
-
README.md:71: MD029 Ordered list item prefix
|
52
|
-
README.md:72: MD029 Ordered list item prefix
|
53
|
-
README.md:73: MD029 Ordered list item prefix
|
54
|
-
|
55
|
-
Markdownlint has many more options you can pass on the command line, run
|
56
|
-
`mdl --help` to see what they are, or see the documentation on
|
57
|
-
[configuring markdownlint](docs/configuration.md).
|
58
|
-
|
59
|
-
### Styles
|
60
|
-
|
61
|
-
Not everyone writes markdown in the same way, and there are multiple flavors
|
62
|
-
and styles, each of which are valid. While markdownlint's default settings
|
63
|
-
will result in markdown files that reflect the author's preferred markdown
|
64
|
-
authoring preferences, your project may have different guidelines.
|
65
|
-
|
66
|
-
It's not markdownlint's intention to dictate any one specific style, and in
|
67
|
-
order to support these differing styles and/or preferences, markdownlint
|
68
|
-
supports what are called 'style files'. A style file is a file describing
|
69
|
-
which rules markdownlint should enable, and also what settings to apply to
|
70
|
-
individual rules. For example, rule [MD013](docs/RULES.md#md013---line-length)
|
71
|
-
checks for long lines, and by default will report an issue for any line longer
|
72
|
-
than 80 characters. If your project has a different maximum line length limit,
|
73
|
-
or if you don't want to enforce a line limit at all, then this can be
|
74
|
-
configured in a style file.
|
75
|
-
|
76
|
-
For more information on creating style files, see the
|
77
|
-
[creating styles](docs/creating_styles.md) document.
|
78
|
-
|
79
|
-
## Related projects
|
80
|
-
|
81
|
-
- [markdownlint](https://github.com/DavidAnson/markdownlint) and
|
82
|
-
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) for
|
83
|
-
Node.js
|
84
|
-
|
85
|
-
## Contributing
|
86
|
-
|
87
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
|