Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update to remark 13.0.0 (micromark) #28

Closed
arcticicestudio opened this issue Apr 5, 2021 · 0 comments · Fixed by #29
Closed

Update to remark 13.0.0 (micromark) #28

arcticicestudio opened this issue Apr 5, 2021 · 0 comments · Fixed by #29

Comments

@arcticicestudio
Copy link
Contributor

arcticicestudio commented Apr 5, 2021

remark 13.0.0 is a giant change for remark that replaced the 5+ year old internals with a new low-level parser called micromark. 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 plugin, which introduced support for remark 13.0.0 in its package version 8.0.0, and the remark-cli package, which comes with support for remark 13.0.0 in its package version 9.0.0.

  • Update remark-cli — bump minimum version from 5.0.0 to 9.0.0
  • Update remark-lint — bump minimum version from 6.0.1 to 8.0.0
  • Update all remark-lint-* packages — the @arcticicestudio/remark-preset-lint packages supports all remark-lint-* core rule packages whose minimum versions must bumped to the major version that introduced support for remark 13.0.0.
  • Add remark-gfm plugin — the support for GitHub Flavored Markdown has been moved into the remark-gfm plugin.
  • Add remark-footnotes plugin — adds support for Pandoc footnotes.
  • Validate 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 that are currently used were not up-to-date before, support for new features like core rules will also be added:

@arcticicestudio arcticicestudio added this to the 0.4.0 milestone Apr 5, 2021
arcticicestudio added a commit that referenced this issue Apr 5, 2021
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/remark-cli@5.0.0...remark-cli@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 <development@svengreb.de>

GH-28
arcticicestudio added a commit that referenced this issue Apr 5, 2021
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/remark-cli@5.0.0...remark-cli@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 <development@svengreb.de>

Closes GH-28
arcticicestudio added a commit to svengreb/styleguide-javascript that referenced this issue Apr 6, 2021
The `remark-preset-lint-arcticicestudio` package has been deprecated
during the migration into a monorepo [1] and replaced by the new
`@arcticicestudio/remark-preset-lint` package [2]. This package also
introduces support for remark `13.0.0` [3] which comes with some new
features and great improvements.

To migrate to the new package the `remark-preset-lint-arcticicestudio`
preset has been replaced by the new
`@arcticicestudio/remark-preset-lint` preset in the `.remarkrc.js` file.

[1]: svengreb/styleguide-markdown#10
[2]: https://github.com/arcticicestudio/styleguide-markdown/tree/main/packages/%40arcticicestudio/remark-preset-lint
[3]: svengreb/styleguide-markdown#28

Co-authored-by: Sven Greb <development@svengreb.de>

GH-47
arcticicestudio added a commit to svengreb/styleguide-javascript that referenced this issue Apr 6, 2021
The `remark-preset-lint-arcticicestudio` package has been deprecated
during the migration into a monorepo [1] and replaced by the new
`@arcticicestudio/remark-preset-lint` package [2]. This package also
introduces support for remark `13.0.0` [3] which comes with some new
features and great improvements.

To migrate to the new package the `remark-preset-lint-arcticicestudio`
preset has been replaced by the new
`@arcticicestudio/remark-preset-lint` preset in the `.remarkrc.js` file.

Afterwards all checks have been run to fix and/or improve the findings
with the new preset.

[1]: svengreb/styleguide-markdown#10
[2]: https://github.com/arcticicestudio/styleguide-markdown/tree/main/packages/%40arcticicestudio/remark-preset-lint
[3]: svengreb/styleguide-markdown#28

Co-authored-by: Sven Greb <development@svengreb.de>

GH-47
arcticicestudio added a commit to svengreb/styleguide-javascript that referenced this issue Apr 6, 2021
The `remark-preset-lint-arcticicestudio` package has been deprecated
during the migration into a monorepo [1] and replaced by the new
`@arcticicestudio/remark-preset-lint` package [2]. This package also
introduces support for remark `13.0.0` [3] which comes with some new
features and great improvements.

To migrate to the new package the `remark-preset-lint-arcticicestudio`
preset has been replaced by the new
`@arcticicestudio/remark-preset-lint` preset in the `.remarkrc.js` file.

Afterwards all checks have been run to fix and/or improve the findings
with the new preset.

[1]: svengreb/styleguide-markdown#10
[2]: https://github.com/arcticicestudio/styleguide-markdown/tree/main/packages/%40arcticicestudio/remark-preset-lint
[3]: svengreb/styleguide-markdown#28

Co-authored-by: Sven Greb <development@svengreb.de>

Closes GH-47
svengreb added a commit to svengreb/tmpl that referenced this issue Apr 27, 2021
This project adheres to the "Arctic Ice Studio Markdown style guide" [1]
which recently published version `0.4.0` [2] that introduces some larger
changes:

- The repository was converted into a monorepo [3] and the currently
  used `remark-preset-lint-arcticicestudio` [4] npm package was
  deprecated and moved into the new, scoped
  `@arcticicestudio/remark-preset-lint` [5] package.
- Support for the shiny new remark version `13.0.0` [7] was introduced
  which is now the minimum required version for the rule preset packages.
- Several other great improvements and migrations like the adaption of
  this template repository [8] as well as the usage of the
  GitHub Flow [9] branching model and new `main` branch concept [10].

[1]: https://github.com/arcticicestudio/styleguide-markdown
[2]: https://github.com/arcticicestudio/styleguide-markdown/releases/tag/v0.4.0
[3]: svengreb/styleguide-markdown#10
[4]: https://www.npmjs.com/package/remark-preset-lint-arcticicestudio
[5]: https://www.npmjs.com/package/@arcticicestudio/remark-preset-lint
[6]: svengreb/styleguide-markdown#28
[7]: svengreb/styleguide-markdown#28
[8]: svengreb/styleguide-markdown#11
[9]: svengreb/styleguide-markdown#19
[10]: svengreb/styleguide-markdown#21

GH-76
svengreb added a commit to svengreb/tmpl that referenced this issue Apr 27, 2021
This project adheres to the "Arctic Ice Studio Markdown style guide" [1]
which recently published version `0.4.0` [2] that introduces some larger
changes:

- The repository was converted into a monorepo [3] and the currently
  used `remark-preset-lint-arcticicestudio` [4] npm package was
  deprecated and moved into the new, scoped
  `@arcticicestudio/remark-preset-lint` [5] package.
- Support for the shiny new remark version `13.0.0` [7] was introduced
  which is now the minimum required version for the rule preset packages.
- Several other great improvements and migrations like the adaption of
  this template repository [8] as well as the usage of the
  GitHub Flow [9] branching model and new `main` branch concept [10].

[1]: https://github.com/arcticicestudio/styleguide-markdown
[2]: https://github.com/arcticicestudio/styleguide-markdown/releases/tag/v0.4.0
[3]: svengreb/styleguide-markdown#10
[4]: https://www.npmjs.com/package/remark-preset-lint-arcticicestudio
[5]: https://www.npmjs.com/package/@arcticicestudio/remark-preset-lint
[6]: svengreb/styleguide-markdown#28
[7]: svengreb/styleguide-markdown#28
[8]: svengreb/styleguide-markdown#11
[9]: svengreb/styleguide-markdown#19
[10]: svengreb/styleguide-markdown#21

Closes GH-76
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants