-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update to remark 13.0.0 (micromark) (#29)
remark 13.0.0 [1] is a giant change for remark that replaced the 5+ year old internals with a new low-level parser called micromark [2]. It comes with 100% CommonMark (and GFM as an extension) compliance and is a good base for the future of remark and Markdown. >> Migration This projects uses remark through the remark-lint [3] plugin, which introduced support for remark `13.0.0` in its package version `8.0.0` [4], and the remark-cli][5 package, which comes with support for remark `13.0.0` in its package version `9.0.0` [6]. - Updated `remark-cli` - bumped minimum version from `5.0.0` to `9.0.0` [7] - Updated `remark-lint` - bumped minimum version from `6.0.1` to `8.0.0` [8] - Updated all `remark-lint-*` packages - the `@arcticicestudio/remark-preset-lint` [9] packages supports all `remark-lint-*` core rule packages whose minimum versions are now bumped to the major version that introduced support for remark `13.0.0`. - Added `remark-gfm` plugin [10] - the support for GitHub Flavored Markdown [11] has been moved into the `remark-gfm` plugin. - Added `remark-footnotes` plugin [12] - adds support for Pandoc [13] footnotes. - Validated the code base with new linter rules - Run checks with updated packages afterwards to fix and improve results found by linters. >> Features Because most package versions used before were not up-to-date, support for new features like core rules has also been added: - Support for `remark-lint-no-duplicate-defined-urls` [14] - the core rule warns when definitions define the same URL. - Support for `remark-lint-no-unneeded-full-reference-image` [15] - the core rule warns when full reference images are used that could be collapsed. - Support for `remark-lint-no-unneeded-full-reference-link` [16] - the core rule warns when full reference links are used that could be collapsed. [1]: https://github.com/remarkjs/remark/releases/tag/13.0.0 [2]: https://github.com/micromark/micromark [3]: https://github.com/remarkjs/remark-lint [4]: https://github.com/remarkjs/remark-lint/releases/tag/8.0.0 [5]: https://github.com/remarkjs/remark [6]: https://github.com/remarkjs/remark/releases/tag/remark-cli%409.0.0 [7]: https://github.com/remarkjs/remark/compare/[email protected]@9.0.0 [8]: remarkjs/remark-lint@6.0.0...8.0.0 [9]: https://github.com/arcticicestudio/styleguide-markdown/tree/main/packages/%40arcticicestudio/remark-preset-lint [10]: https://github.com/remarkjs/remark-gfm [11]: https://github.github.com/gfm [12]: https://github.com/remarkjs/remark-footnotes [13]: https://pandoc.org [14]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-duplicate-defined-urls [15]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-unneeded-full-reference-image [16]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-unneeded-full-reference-link Co-authored-by: Sven Greb <[email protected]> Closes GH-28
- Loading branch information
1 parent
c7946f2
commit 9ff968f
Showing
28 changed files
with
274 additions
and
190 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
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
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 |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ | |
|
|
||
| /** | ||
| * Arctic Ice Studio Markdown Style Guide rules as an extensible remark-lint rule preset. | ||
| * | ||
| * @version 0.3.0 | ||
| * @license MIT | ||
| * @author Arctic Ice Studio <[email protected]> | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -21,9 +21,7 @@ const noBlockquoteWithoutMarker = require("remark-lint-no-blockquote-without-mar | |
|
|
||
| /** | ||
| * Official remark-lint core rules for blockquote document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -35,9 +35,7 @@ const noShellDollars = require("remark-lint-no-shell-dollars"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for code document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -38,9 +38,7 @@ const strongMarker = require("remark-lint-strong-marker"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for emphasis document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -80,9 +80,7 @@ const noMultipleToplevelHeadings = require("remark-lint-no-multiple-toplevel-hea | |
|
|
||
| /** | ||
| * Official remark-lint core rules for heading document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -14,9 +14,7 @@ const ruleStyle = require("remark-lint-rule-style"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for horizontal rule document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -39,6 +39,13 @@ const noAutoLinkWithoutProtocol = require("remark-lint-no-auto-link-without-prot | |
| * @see https://arcticicestudio.github.io/styleguide-markdown/rules/links.html#unique-ids | ||
| */ | ||
| const noDuplicateDefinitions = require("remark-lint-no-duplicate-definitions"); | ||
| /** | ||
| * Warn when definitions define the same URL. | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-duplicate-defined-urls | ||
| * @see https://arcticicestudio.github.io/styleguide-markdown/rules/links.html#unique-ids | ||
| */ | ||
| const noDuplicateDefinedURLs = require("remark-lint-no-duplicate-defined-urls"); | ||
| /** | ||
| * Disallow empty link and image URLs. | ||
| * | ||
|
|
@@ -85,12 +92,26 @@ const noUndefinedReferences = require("remark-lint-no-undefined-references"); | |
| * @see https://arcticicestudio.github.io/styleguide-markdown/rules/links.html#no-unused | ||
| */ | ||
| const noUnusedDefinitions = require("remark-lint-no-unused-definitions"); | ||
| /** | ||
| * Warn when full reference images are used that could be collapsed. | ||
| * | ||
| * @since 0.4.0 | ||
| * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-unneeded-full-reference-image | ||
| * @see https://arcticicestudio.github.io/styleguide-markdown/rules/images.html#collapsed-reference-links | ||
| */ | ||
| const noUnneededFullReferenceImage = require("remark-lint-no-unneeded-full-reference-image"); | ||
| /** | ||
| * Warn when full reference links are used that could be collapsed. | ||
| * | ||
| * @since 0.4.0 | ||
| * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-unneeded-full-reference-link | ||
| * @see https://arcticicestudio.github.io/styleguide-markdown/rules/links.html#collapsed-references | ||
| */ | ||
| const noUnneededFullReferenceLink = require("remark-lint-no-unneeded-full-reference-link"); | ||
|
|
||
| /** | ||
| * Official remark-lint core rules for link document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
@@ -100,12 +121,15 @@ module.exports = { | |
| [finalDefinition, ["error"]], | ||
| [noAutoLinkWithoutProtocol, ["warn"]], | ||
| [noDuplicateDefinitions, ["error"]], | ||
| [noDuplicateDefinedURLs, ["warn"]], | ||
| [noEmptyUrl, ["error"]], | ||
| [noLiteralUrls, false], | ||
| [noReferenceLikeUrl, ["error"]], | ||
| [noShortcutReferenceImage, false], | ||
| [noShortcutReferenceLink, false], | ||
| [noUndefinedReferences, ["error"]], | ||
| [noUnusedDefinitions, ["warn"]], | ||
| [noUnneededFullReferenceImage, ["warn"]], | ||
| [noUnneededFullReferenceLink, ["warn"]], | ||
| ], | ||
| }; | ||
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 |
|---|---|---|
|
|
@@ -69,9 +69,7 @@ const unorderedListMarkerStyle = require("remark-lint-unordered-list-marker-styl | |
|
|
||
| /** | ||
| * Official remark-lint core rules for list document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -45,9 +45,7 @@ const noFileNameOuterDashes = require("remark-lint-no-file-name-outer-dashes"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for naming conventions. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -14,9 +14,7 @@ const noParagraphContentIndent = require("remark-lint-no-paragraph-content-inden | |
|
|
||
| /** | ||
| * Official remark-lint core rules for paragraph document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -13,9 +13,7 @@ const noHtml = require("remark-lint-no-html"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for raw HTML document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -14,9 +14,7 @@ const linkTitleStyle = require("remark-lint-link-title-style"); | |
|
|
||
| /** | ||
| * Official remark-lint core rules for string document nodes. | ||
| * @author Arctic Ice Studio <[email protected]> | ||
| * @author Sven Greb <[email protected]> | ||
| * @since 0.1.0 | ||
| * | ||
| * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules | ||
| */ | ||
| module.exports = { | ||
|
|
||
Oops, something went wrong.