mdl 0.6.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md +22 -0
- data/.github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md +40 -0
- data/.github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST.md +20 -0
- data/.github/ISSUE_TEMPLATE/RULE_REQUEST.md +20 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +23 -0
- data/.travis.yml +3 -3
- data/CHANGELOG.md +10 -0
- data/CONTRIBUTING.md +75 -6
- data/docs/configuration.md +4 -4
- data/docs/creating_rules.md +1 -1
- data/docs/creating_styles.md +8 -8
- data/docs/rolling_a_release.md +4 -2
- data/lib/mdl/rules.rb +1 -0
- data/lib/mdl/version.rb +1 -1
- data/mdl.gemspec +5 -4
- data/test/fixtures/front_matter/jekyll_post_2.md +17 -0
- data/test/test_cli.rb +3 -2
- metadata +40 -19
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e49f45b2f8946b1167b69fb81fd618e33aac84c8dd0c190ba014df81f7cecabc
|
4
|
+
data.tar.gz: 3da27003069846edb3b752ccbb695e34e0cbb3bc1d5ca0f90281cd68723d87cd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1ee7ff81e5e59e13d386083eb40ad5638a755698733953896d5482dc0992f9e756f88419d7643f0a07ddfea5c52cd027ad6fa6cd574c2e7fa97dfc8212dfc0f9
|
7
|
+
data.tar.gz: 64983b8c0868d50b7004fe9b962567181eaa506cc6e37f3897a9c581b30baaa55c24a29a1aafe5a19cfa966e79ffe41ed80a8a1545eb5cb76eb51828b8de42ab
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
name: 🐛 Bug Report
|
3
|
+
about: If something isn't working as expected 🤔.
|
4
|
+
labels: "bug"
|
5
|
+
---
|
6
|
+
## Description
|
7
|
+
<!--- Briefly describe the issue -->
|
8
|
+
|
9
|
+
### Environment
|
10
|
+
<!--- Tell us any details about the environment where you're running mdl. -->
|
11
|
+
**MDL Version**
|
12
|
+
<!--- Tell us which version of mdl you are using. -->
|
13
|
+
|
14
|
+
### Expected Behavior
|
15
|
+
<!-- Tell us what should happen -->
|
16
|
+
|
17
|
+
### Actual Behavior
|
18
|
+
<!-- Tell us what happens instead; including any error messages, stacktraces, or a link to a gist with it. -->
|
19
|
+
|
20
|
+
## Replication Case
|
21
|
+
<!--- Tell us what steps to take to replicate your problem, don't just say what you did, but explain how you did it. See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve)
|
22
|
+
for information on how to create a good replication case -->
|
@@ -0,0 +1,40 @@
|
|
1
|
+
---
|
2
|
+
name: Design Proposal
|
3
|
+
about: I have a significant change I would like to propose and discuss before starting
|
4
|
+
labels: "design proposal"
|
5
|
+
---
|
6
|
+
|
7
|
+
### When a Change Needs a Design Proposal
|
8
|
+
|
9
|
+
A design proposal should be opened any time a change meets one of the following qualifications:
|
10
|
+
|
11
|
+
- Significantly changes the user experience of a project in a way that impacts users.
|
12
|
+
- Significantly changes the underlying architecture of the project in a way that impacts other developers.
|
13
|
+
- Changes the development or testing process of the project such as a change of CI systems or test frameworks.
|
14
|
+
|
15
|
+
### Why We Use This Process
|
16
|
+
|
17
|
+
- Allows all interested parties (including any community member) to discuss large impact changes to a project.
|
18
|
+
- Serves as a durable paper trail for discussions regarding project architecture.
|
19
|
+
- Forces design discussions to occur before PRs are created.
|
20
|
+
- Reduces PR refactoring and rejected PRs.
|
21
|
+
|
22
|
+
---
|
23
|
+
|
24
|
+
<!--- Proposal description and rationale. -->
|
25
|
+
|
26
|
+
## Motivation
|
27
|
+
|
28
|
+
<!---
|
29
|
+
As a <<user_profile>>,
|
30
|
+
I want to <<functionality>>,
|
31
|
+
so that <<benefit>>.
|
32
|
+
-->
|
33
|
+
|
34
|
+
## Specification
|
35
|
+
|
36
|
+
<!--- A detailed description of the planned implementation. -->
|
37
|
+
|
38
|
+
## Downstream Impact
|
39
|
+
|
40
|
+
<!--- Which other tools will be impacted by this work? -->
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
name: 🚀 Enhancement Request
|
3
|
+
about: I have a suggestion (and may want to implement it 🙂)!
|
4
|
+
labels: "enhancement"
|
5
|
+
---
|
6
|
+
|
7
|
+
## Describe the Enhancement:
|
8
|
+
<!--- What you are trying to achieve that you can't? -->
|
9
|
+
|
10
|
+
### Impacted Rules:
|
11
|
+
<!-- List any existing rules that would be impacted or changed by this enhancement -->
|
12
|
+
|
13
|
+
## Describe the Need:
|
14
|
+
<!--- What kind of user do you believe would utilize this enhancement, and how many users might want this functionality -->
|
15
|
+
|
16
|
+
## Current Alternative
|
17
|
+
<!--- Is there a current alternative that you can utilize to workaround the lack of this enhancement -->
|
18
|
+
|
19
|
+
## Can We Help You Implement This?:
|
20
|
+
<!--- The best way to ensure your enhancement is built is to help implement the enhancement yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
name: 💪 Rule Request
|
3
|
+
about: I have a suggestion for a new rule for markdownlint (and may want to implement it 🙌)!
|
4
|
+
labels: "new rule"
|
5
|
+
---
|
6
|
+
|
7
|
+
## New Rule Checklist
|
8
|
+
|
9
|
+
Before suggesting a rule for inclusion please make sure your suggestion meets these criteria for rule built into markdownlint:
|
10
|
+
- [ ] allows a user to lint for a specific syntax divergence across the multiple flavors and styles of markdown
|
11
|
+
- [ ] does not dictate any one specific style, but enables an end user to enable, disable, or configure the specific style of enforcement desired
|
12
|
+
|
13
|
+
## Describe The Rule:
|
14
|
+
<!--- Tell us about the rule -->
|
15
|
+
|
16
|
+
## Why Should This Be Included In Markdownlint?:
|
17
|
+
<!--- Tell us why you believe this rule should be added, considering any possible side-effects, negative impact, or changes to the behavior of existing rules -->
|
18
|
+
|
19
|
+
## Can We Help You Implement This?:
|
20
|
+
<!--- The best way to move a rule into markdownlint is to create it yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->
|
@@ -0,0 +1,23 @@
|
|
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/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
# Change Log
|
2
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
|
+
|
3
12
|
## [v0.6.0] (2019-10-19)
|
4
13
|
|
5
14
|
### Added
|
@@ -197,6 +206,7 @@
|
|
197
206
|
* MD030 - Spaces after list markers
|
198
207
|
|
199
208
|
[Unreleased]: https://github.com/markdownlint/markdownlint/tree/master
|
209
|
+
[v0.7.0]: https://github.com/markdownlint/markdownlint/tree/v0.7.0
|
200
210
|
[v0.6.0]: https://github.com/markdownlint/markdownlint/tree/v0.6.0
|
201
211
|
[v0.5.0]: https://github.com/markdownlint/markdownlint/tree/v0.5.0
|
202
212
|
[v0.4.0]: https://github.com/markdownlint/markdownlint/tree/v0.4.0
|
data/CONTRIBUTING.md
CHANGED
@@ -1,7 +1,76 @@
|
|
1
|
-
# Contributing
|
1
|
+
# Contributing to Markdownlint
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
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/docs/configuration.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Mdl configuration
|
2
2
|
|
3
3
|
Markdownlint has several options you can configure both on the command line,
|
4
|
-
or in markdownlint's configuration file: `.mdlrc`, first looked for
|
4
|
+
or in markdownlint's configuration file: `.mdlrc`, first looked for in the
|
5
5
|
working directory, then in your home directory.
|
6
6
|
While markdownlint will work perfectly well out of the box, this page
|
7
7
|
documents some of the options you can change to suit your needs.
|
@@ -39,7 +39,7 @@ instead, and ignore any files git doesn't know about.
|
|
39
39
|
* Config file: `git_recurse true`
|
40
40
|
* Default: false
|
41
41
|
|
42
|
-
Ignore YAML front matter -
|
42
|
+
Ignore YAML front matter - If this option is enabled markdownlint will ignore
|
43
43
|
content within valid
|
44
44
|
[YAML front matter](https://jekyllrb.com/docs/frontmatter/). Reported line
|
45
45
|
numbers will still match the file contents but markdownlint will consider the
|
@@ -66,7 +66,7 @@ Rules - Limit the rules mdl enables to those provided in this option.
|
|
66
66
|
If a rule or tag ID is preceded by a tilde (`~`), then it _disables_ the
|
67
67
|
matching rules instead of enabling them, starting with all rules being enabled.
|
68
68
|
|
69
|
-
Note:
|
69
|
+
Note: If both `--rules` and `--tags` are provided, then a given rule has to
|
70
70
|
both be in the list of enabled rules, as well as be tagged with one of the
|
71
71
|
tags provided with the `--tags` option. Use the `-l/--list-rules` option to
|
72
72
|
test this behavior.
|
@@ -81,7 +81,7 @@ might choose 72 characters, and another might have no line length limit at all
|
|
81
81
|
* Config file: `style "style_name"`
|
82
82
|
* Default: Use the style called 'default'
|
83
83
|
|
84
|
-
Note:
|
84
|
+
Note: The value for `style_name` must either end with `.rb` or have `/` in it
|
85
85
|
in order to tell `mdl` to look for a custom style, and not a built-in style.
|
86
86
|
|
87
87
|
Rulesets - Load a custom ruleset file. This option allows you to load custom
|
data/docs/creating_rules.md
CHANGED
@@ -46,7 +46,7 @@ for your check.
|
|
46
46
|
|
47
47
|
## Document objects
|
48
48
|
|
49
|
-
The check takes a single parameter `
|
49
|
+
The check takes a single parameter `doc`, which is an object containing a
|
50
50
|
representation of the markdown document along with several helper functions
|
51
51
|
used for making rules. The [doc.rb](../lib/mdl/doc.rb) file is documented
|
52
52
|
using rdoc, and you will want to take a look there to see all the methods you
|
data/docs/creating_styles.md
CHANGED
@@ -6,28 +6,28 @@ parameters different than the defaults.
|
|
6
6
|
|
7
7
|
The various options you can use in a style file are:
|
8
8
|
|
9
|
-
* all - include all rules
|
10
|
-
* rule - include a specific rule.
|
9
|
+
* `all` - include all rules
|
10
|
+
* `rule` - include a specific rule.
|
11
11
|
|
12
12
|
rule 'MD001'
|
13
13
|
|
14
|
-
* exclude_rule - exclude a previously included rule. Used if you want to
|
14
|
+
* `exclude_rule` - exclude a previously included rule. Used if you want to
|
15
15
|
include all except for a few rules.
|
16
16
|
|
17
17
|
exclude_rule 'MD000'
|
18
18
|
|
19
|
-
* tag - include all rules that are tagged with a specific value
|
19
|
+
* `tag` - include all rules that are tagged with a specific value
|
20
20
|
|
21
21
|
tag :whitespace
|
22
22
|
|
23
|
-
* exclude_tag - exclude all rules tagged with the specified tag
|
23
|
+
* `exclude_tag` - exclude all rules tagged with the specified tag
|
24
24
|
|
25
25
|
exclude_tag :line_length
|
26
26
|
|
27
27
|
Note that tags are specified as symbols, and rule names as strings, just as
|
28
28
|
in the rule definitions themselves.
|
29
29
|
|
30
|
-
The last matching option wins, so you should always put `
|
30
|
+
The last matching option wins, so you should always put `all` at the top of
|
31
31
|
the file (if you want to include all rules), then tags (and tag excludes),
|
32
32
|
then specific rules. In other words, go from least to most specific.
|
33
33
|
|
@@ -42,6 +42,6 @@ those parameters:
|
|
42
42
|
|
43
43
|
rule 'MD030', :ol_multi => 2, :ul_multi => 3
|
44
44
|
|
45
|
-
Even if a rule is included already by a tag specification (or
|
46
|
-
not a problem to add a specific
|
45
|
+
Even if a rule is included already by a tag specification (or `all`), it is
|
46
|
+
not a problem to add a specific `rule` entry in order to set custom
|
47
47
|
parameters, and is in fact necessary to do so.
|
data/docs/rolling_a_release.md
CHANGED
@@ -4,7 +4,7 @@ Bump the version. Markdownlint uses semantic versioning. From
|
|
4
4
|
<http://semver.org/>:
|
5
5
|
|
6
6
|
* Major version for backwards-incompatible changes
|
7
|
-
* Minor version functionality added in a backwards-compatible manner
|
7
|
+
* Minor version for functionality added in a backwards-compatible manner
|
8
8
|
* Patch version for backwards-compatible bug fixes
|
9
9
|
* Exception: Versions < 1.0 may introduce backwards-incompatible changes in a
|
10
10
|
minor version.
|
@@ -43,7 +43,9 @@ Update the changelog:
|
|
43
43
|
|
44
44
|
Next, run `rake release`. This will:
|
45
45
|
|
46
|
-
* Tag vX.Y.Z in git
|
46
|
+
* Tag vX.Y.Z in git
|
47
47
|
* Upload the new gem to rubygems.org
|
48
48
|
|
49
|
+
Then `git push --tags upstream` to push the tag.
|
50
|
+
|
49
51
|
Finally, add a new 'Unreleased' section to the changelog for the next release.
|
data/lib/mdl/rules.rb
CHANGED
@@ -516,6 +516,7 @@ rule "MD032", "Lists should be surrounded by blank lines" do
|
|
516
516
|
fence = nil
|
517
517
|
prev_line = ""
|
518
518
|
doc.lines.each_with_index do |line, linenum|
|
519
|
+
next if line.strip == '{:toc}'
|
519
520
|
if not in_code
|
520
521
|
list_marker = line.strip.match(/^([\*\+\-]|(\d+\.))\s/)
|
521
522
|
if list_marker and not in_list and not prev_line.match(/^($|\s)/)
|
data/lib/mdl/version.rb
CHANGED
data/mdl.gemspec
CHANGED
@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
|
|
18
18
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
19
|
spec.require_paths = ["lib"]
|
20
20
|
|
21
|
-
spec.required_ruby_version = '>=
|
21
|
+
spec.required_ruby_version = '>= 2.4'
|
22
22
|
|
23
|
-
spec.add_dependency 'kramdown', '~>
|
24
|
-
spec.add_dependency '
|
23
|
+
spec.add_dependency 'kramdown', '~> 2.0'
|
24
|
+
spec.add_dependency 'kramdown-parser-gfm', '~> 1.0'
|
25
|
+
spec.add_dependency 'mixlib-config', '>= 2.2.1', '< 4'
|
25
26
|
spec.add_dependency 'mixlib-cli', '~> 2.1', '>= 2.1.1'
|
26
27
|
|
27
28
|
spec.add_development_dependency 'bundler', '>= 1.12', '< 3'
|
28
|
-
spec.add_development_dependency 'rake', '
|
29
|
+
spec.add_development_dependency 'rake', '>= 11.2', '< 14'
|
29
30
|
spec.add_development_dependency 'minitest', '~> 5.9'
|
30
31
|
spec.add_development_dependency 'pry', '~> 0.10'
|
31
32
|
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
title: Hello World!
|
4
|
+
category: Meta
|
5
|
+
tags:
|
6
|
+
- tag
|
7
|
+
- another tag
|
8
|
+
- one more tag
|
9
|
+
url: http://example.com
|
10
|
+
excerpt: Hello World! Vestibulum imperdiet adipiscing arcu, quis aliquam dolor condimentum dapibus. Aliquam fermentum leo aliquet quam volutpat et molestie mauris mattis. Suspendisse semper consequat velit in suscipit.
|
11
|
+
---
|
12
|
+
|
13
|
+
# header1
|
14
|
+
|
15
|
+
This is just a sample post.
|
16
|
+
|
17
|
+
### offending header3
|
data/test/test_cli.rb
CHANGED
@@ -194,8 +194,9 @@ class TestCli < Minitest::Test
|
|
194
194
|
result = run_cli("-i -r MD001,MD041,MD034 #{path}")
|
195
195
|
|
196
196
|
expected = \
|
197
|
-
"#{path}/jekyll_post.md:16: MD001 Header levels should only increment by one level at a time"\
|
198
|
-
"
|
197
|
+
"#{path}/jekyll_post.md:16: MD001 Header levels should only increment by one level at a time\n"\
|
198
|
+
"#{path}/jekyll_post_2.md:16: MD001 Header levels should only increment by one level at a time\n"\
|
199
|
+
"\nA detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md\n"
|
199
200
|
|
200
201
|
assert_equal(result[:stdout], expected)
|
201
202
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mdl
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mark Harrison
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-10-
|
11
|
+
date: 2019-10-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: kramdown
|
@@ -16,40 +16,48 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '
|
20
|
-
- - ">="
|
21
|
-
- !ruby/object:Gem::Version
|
22
|
-
version: 1.12.0
|
19
|
+
version: '2.0'
|
23
20
|
type: :runtime
|
24
21
|
prerelease: false
|
25
22
|
version_requirements: !ruby/object:Gem::Requirement
|
26
23
|
requirements:
|
27
24
|
- - "~>"
|
28
25
|
- !ruby/object:Gem::Version
|
29
|
-
version: '
|
30
|
-
- - ">="
|
31
|
-
- !ruby/object:Gem::Version
|
32
|
-
version: 1.12.0
|
26
|
+
version: '2.0'
|
33
27
|
- !ruby/object:Gem::Dependency
|
34
|
-
name:
|
28
|
+
name: kramdown-parser-gfm
|
35
29
|
requirement: !ruby/object:Gem::Requirement
|
36
30
|
requirements:
|
37
31
|
- - "~>"
|
38
32
|
- !ruby/object:Gem::Version
|
39
|
-
version: '
|
33
|
+
version: '1.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: mixlib-config
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
40
45
|
- - ">="
|
41
46
|
- !ruby/object:Gem::Version
|
42
47
|
version: 2.2.1
|
48
|
+
- - "<"
|
49
|
+
- !ruby/object:Gem::Version
|
50
|
+
version: '4'
|
43
51
|
type: :runtime
|
44
52
|
prerelease: false
|
45
53
|
version_requirements: !ruby/object:Gem::Requirement
|
46
54
|
requirements:
|
47
|
-
- - "~>"
|
48
|
-
- !ruby/object:Gem::Version
|
49
|
-
version: '2.2'
|
50
55
|
- - ">="
|
51
56
|
- !ruby/object:Gem::Version
|
52
57
|
version: 2.2.1
|
58
|
+
- - "<"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '4'
|
53
61
|
- !ruby/object:Gem::Dependency
|
54
62
|
name: mixlib-cli
|
55
63
|
requirement: !ruby/object:Gem::Requirement
|
@@ -94,16 +102,22 @@ dependencies:
|
|
94
102
|
name: rake
|
95
103
|
requirement: !ruby/object:Gem::Requirement
|
96
104
|
requirements:
|
97
|
-
- - "
|
105
|
+
- - ">="
|
98
106
|
- !ruby/object:Gem::Version
|
99
107
|
version: '11.2'
|
108
|
+
- - "<"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '14'
|
100
111
|
type: :development
|
101
112
|
prerelease: false
|
102
113
|
version_requirements: !ruby/object:Gem::Requirement
|
103
114
|
requirements:
|
104
|
-
- - "
|
115
|
+
- - ">="
|
105
116
|
- !ruby/object:Gem::Version
|
106
117
|
version: '11.2'
|
118
|
+
- - "<"
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '14'
|
107
121
|
- !ruby/object:Gem::Dependency
|
108
122
|
name: minitest
|
109
123
|
requirement: !ruby/object:Gem::Requirement
|
@@ -140,6 +154,11 @@ executables:
|
|
140
154
|
extensions: []
|
141
155
|
extra_rdoc_files: []
|
142
156
|
files:
|
157
|
+
- ".github/ISSUE_TEMPLATE/BUG_TEMPLATE.md"
|
158
|
+
- ".github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md"
|
159
|
+
- ".github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST.md"
|
160
|
+
- ".github/ISSUE_TEMPLATE/RULE_REQUEST.md"
|
161
|
+
- ".github/PULL_REQUEST_TEMPLATE.md"
|
143
162
|
- ".gitignore"
|
144
163
|
- ".pre-commit-hooks.yaml"
|
145
164
|
- ".travis.yml"
|
@@ -175,6 +194,7 @@ files:
|
|
175
194
|
- test/fixtures/dir_with_md_and_markdown/bar.markdown
|
176
195
|
- test/fixtures/dir_with_md_and_markdown/foo.md
|
177
196
|
- test/fixtures/front_matter/jekyll_post.md
|
197
|
+
- test/fixtures/front_matter/jekyll_post_2.md
|
178
198
|
- test/fixtures/mdlrc_disable_rules
|
179
199
|
- test/fixtures/mdlrc_disable_tags
|
180
200
|
- test/fixtures/mdlrc_enable_rules
|
@@ -306,7 +326,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
306
326
|
requirements:
|
307
327
|
- - ">="
|
308
328
|
- !ruby/object:Gem::Version
|
309
|
-
version:
|
329
|
+
version: '2.4'
|
310
330
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
311
331
|
requirements:
|
312
332
|
- - ">="
|
@@ -314,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
314
334
|
version: '0'
|
315
335
|
requirements: []
|
316
336
|
rubyforge_project:
|
317
|
-
rubygems_version: 2.7.
|
337
|
+
rubygems_version: 2.7.6
|
318
338
|
signing_key:
|
319
339
|
specification_version: 4
|
320
340
|
summary: Markdown lint tool
|
@@ -323,6 +343,7 @@ test_files:
|
|
323
343
|
- test/fixtures/dir_with_md_and_markdown/bar.markdown
|
324
344
|
- test/fixtures/dir_with_md_and_markdown/foo.md
|
325
345
|
- test/fixtures/front_matter/jekyll_post.md
|
346
|
+
- test/fixtures/front_matter/jekyll_post_2.md
|
326
347
|
- test/fixtures/mdlrc_disable_rules
|
327
348
|
- test/fixtures/mdlrc_disable_tags
|
328
349
|
- test/fixtures/mdlrc_enable_rules
|