Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Bump up remark dependencies and support only ESM #6

Merged
merged 6 commits into from Aug 15, 2021

Conversation

ybiquitous
Copy link
Member

Which issue, if any, is this issue related to?

None.

Is there anything in the PR that needs further explanation?

remark@14 has been supported only ESM. So, this package needs to become ESM to bump up remark dependencies.

Here are the installation commands:

npm install \
  remark-cli@latest \
  remark-frontmatter@latest \
  remark-preset-lint-recommended@latest \
  remark-preset-prettier@latest \
  remark-validate-links@latest

npm install 'github:stylelint/eslint-config-stylelint#esm'

Note that this change needs the ESLint configuration for ESM. See stylelint/eslint-config-stylelint#133

[`remark@14`](https://github.com/remarkjs/remark/releases/tag/14.0.0) has been supported only ESM.
So, this package needs to become ESM to bump up `remark` dependencies.

Here are the installation commands:

```shell
npm install \
  remark-cli@latest \
  remark-frontmatter@latest \
  remark-preset-lint-recommended@latest \
  remark-preset-prettier@latest \
  remark-validate-links@latest

npm install 'github:stylelint/eslint-config-stylelint#esm'
```

Note that this change needs the ESLint configuration for ESM.
See <stylelint/eslint-config-stylelint#133>
@ybiquitous ybiquitous added the pr: dependencies relates to dependencies label Aug 14, 2021
@ybiquitous
Copy link
Member Author

The CI failure is due to the remark failures below:

CHANGELOG.md
  5:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent  remark-lint
  9:3  warning  Incorrect list-item indent: add 2 spaces  list-item-indent  remark-lint

https://github.com/stylelint/remark-preset/pull/6/checks?check_run_id=3327452284#step:6:24

It seems that the problem is caused by remark-preset-prettier (not disabling the list-item-indent rule?):
un-ts/remark-preset-prettier#61

@ybiquitous ybiquitous marked this pull request as ready for review August 14, 2021 03:48
Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's bump the prettier preset to the just-released 1.0.0, then I think we're good.

(Thanks for raising an issue upstream and getting that compatible version out.)

@ybiquitous
Copy link
Member Author

@jeddy3 Thank you for the review! I've pushed the change of the new version remark-preset-prettier@1.0.0 via e12b955.

The next version of @stylelint/remark-preset will be 3.0.0.

Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Feel free to merge and release.

.remarkrc.js Outdated Show resolved Hide resolved
@ybiquitous ybiquitous mentioned this pull request Aug 15, 2021
4 tasks
@@ -9,9 +9,11 @@
"repository": "stylelint/remark-preset",
"license": "MIT",
"author": "stylelint",
"main": "index.js",
"type": "module",
"exports": "./index.js",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[note] main is replaced with exports via 1ebb623. See the guide "Pure ESM package".

@ybiquitous ybiquitous merged commit 49d85aa into master Aug 15, 2021
@ybiquitous ybiquitous deleted the bump-remark-packages branch August 15, 2021 12:56
ybiquitous added a commit that referenced this pull request Aug 15, 2021
@ybiquitous
Copy link
Member Author

Changelog updated: (cb68a84)

Bump up remark dependencies to v14 and support only ESM (#6)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: dependencies relates to dependencies
Development

Successfully merging this pull request may close these issues.

None yet

3 participants