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

Add remark-code-title to list of plugins #1076

Merged
merged 1 commit into from
Dec 26, 2022
Merged

Add remark-code-title to list of plugins #1076

merged 1 commit into from
Dec 26, 2022

Conversation

kevinzunigacuellar
Copy link
Contributor

@kevinzunigacuellar kevinzunigacuellar commented Nov 25, 2022

Signed-off-by: Kevin Zuniga Cuellar 46791833+kevinzunigacuellar@users.noreply.github.com

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Add remark-code-title plugin to list of plugins

Signed-off-by: Kevin Zuniga Cuellar <46791833+kevinzunigacuellar@users.noreply.github.com>
@github-actions github-actions bot added the 👋 phase/new Post is being triaged automatically label Nov 25, 2022
@github-actions

This comment has been minimized.

@github-actions github-actions bot added 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Nov 25, 2022
@kevinzunigacuellar kevinzunigacuellar changed the title Update plugins.md Added a plugin to list of plugins Nov 25, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #1076 (6ea9a1b) into main (c7e8171) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main     #1076   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          901       907    +6     
=========================================
+ Hits           901       907    +6     
Impacted Files Coverage Δ
packages/remark-parse/lib/index.js 100.00% <100.00%> (ø)
packages/remark-stringify/lib/index.js 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 134ece2...6ea9a1b. Read the comment docs.

@wooorm
Copy link
Member

wooorm commented Nov 25, 2022

Hey! Congrats on making your plugin :)

I think it can be better though: you should not inject strings of HTML into the AST.
There is an AST for HTML already. hast. You can create a rehype plugin to work on the HTML AST. I’d recommend that.
If you really need to work on markdown, you should use the embedded HTML AST: https://github.com/syntax-tree/mdast-util-to-hast#fields-on-nodes.

The return value of visit is a) not needed, b) incorrect. If you specify it, it should I believe be index + 1 instead.

@kevinzunigacuellar
Copy link
Contributor Author

Hello @wooorm, thanks a lot for taking the time to give some feedback. I agree, injecting strings feels a bit hacky. I will update this using the mdast-hast util.

I will also explore the rehype plugin route but since the package is already published I will start that in a fresh repo. Again thanks a lot for the constructive feedback 🙌

@kevinzunigacuellar
Copy link
Contributor Author

kevinzunigacuellar commented Nov 26, 2022

hello @wooorm sorry to bother you again. I applied the requested changes except for the return index + 1. When I changed this I ran into an infinite loop. I am not exactly sure what the reason behind this is, but I just wanted to let you know.

Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Nice! Thanks for sharing.

An aside, for TypeScript + ESM, you may need "type": "module" in package.json, see https://2ality.com/2021/06/typescript-esm-nodejs.html for a guide on publishing ESM packages with TS.

@kevinzunigacuellar
Copy link
Contributor Author

Nice! Thanks for sharing.

An aside, for TypeScript + ESM, you may need "type": "module" in package.json, see https://2ality.com/2021/06/typescript-esm-nodejs.html for a guide on publishing ESM packages with TS.

Thanks, I completely missed that

@kevinzunigacuellar
Copy link
Contributor Author

Nice! Thanks for sharing.

An aside, for TypeScript + ESM, you may need "type": "module" in package.json, see https://2ality.com/2021/06/typescript-esm-nodejs.html for a guide on publishing ESM packages with TS.

fixed in version 0.2.2

Thanks again for the feedback. I am very new to publishing npm packages.

@wooorm wooorm changed the title Added a plugin to list of plugins Add remark-code-title to list of plugins Dec 26, 2022
@wooorm wooorm merged commit 9af1a87 into remarkjs:main Dec 26, 2022
@wooorm
Copy link
Member

wooorm commented Dec 26, 2022

Thanks! :)

@github-actions

This comment has been minimized.

@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Dec 26, 2022
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Dec 26, 2022
tylersmalley referenced this pull request in tailscale-dev/tailscale-dev Jun 5, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [remark](https://remark.js.org)
([source](https://togithub.com/remarkjs/remark)) | [`^14.0.2` ->
`^14.0.3`](https://renovatebot.com/diffs/npm/remark/14.0.2/14.0.3) |
[![age](https://badges.renovateapi.com/packages/npm/remark/14.0.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/remark/14.0.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/remark/14.0.3/compatibility-slim/14.0.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/remark/14.0.3/confidence-slim/14.0.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remarkjs/remark</summary>

###
[`v14.0.3`](https://togithub.com/remarkjs/remark/releases/tag/14.0.3)

[Compare
Source](https://togithub.com/remarkjs/remark/compare/14.0.2...14.0.3)

##### Misc

-   Rerelease types for changes in TypeScript

[https://github.com/remarkjs/remark/issues/1162](https://togithub.com/remarkjs/remark/issues/1162)1162
- [`f6bd64e`](https://togithub.com/remarkjs/remark/commit/f6bd64e6)
Refactor `tsconfig`s for perf and strictness
- [`bb4c814`](https://togithub.com/remarkjs/remark/commit/bb4c8143) Add
improved docs on what this project is
by [@&#8203;BeLi4L](https://togithub.com/BeLi4L) in
[https://github.com/remarkjs/remark/pull/1147](https://togithub.com/remarkjs/remark/pull/1147)
- [`bec44aa`](https://togithub.com/remarkjs/remark/commit/bec44aa0)
Update `tsconfig.json` to use node16 module resolution
by [@&#8203;ChristianMurphy](https://togithub.com/ChristianMurphy) in
[https://github.com/remarkjs/remark/pull/1106](https://togithub.com/remarkjs/remark/pull/1106)
- [`f07f413`](https://togithub.com/remarkjs/remark/commit/f07f413f) Add
`ignore-scripts` to `.npmrc`
by [@&#8203;ChristianMurphy](https://togithub.com/ChristianMurphy) in
[https://github.com/remarkjs/remark/pull/1103](https://togithub.com/remarkjs/remark/pull/1103)
- [`134ece2`](https://togithub.com/remarkjs/remark/commit/134ece2b)
Update Actions
by [@&#8203;ChristianMurphy](https://togithub.com/ChristianMurphy) in
[https://github.com/remarkjs/remark/pull/1070](https://togithub.com/remarkjs/remark/pull/1070)
- [`974f893`](https://togithub.com/remarkjs/remark/commit/974f8936) Fix
internal types for TS 4.9

##### Plugins

- [`1e488d0`](https://togithub.com/remarkjs/remark/commit/1e488d0b) Add
`remark-ins` to list of plugins
by [@&#8203;talatkuyuk](https://togithub.com/talatkuyuk) in
[https://github.com/remarkjs/remark/pull/1129](https://togithub.com/remarkjs/remark/pull/1129)
- [`e456dc5`](https://togithub.com/remarkjs/remark/commit/e456dc5b) Add
`remark-flexible-markers` to list of plugins
by [@&#8203;talatkuyuk](https://togithub.com/talatkuyuk) in
[https://github.com/remarkjs/remark/pull/1126](https://togithub.com/remarkjs/remark/pull/1126)
- [`42114fc`](https://togithub.com/remarkjs/remark/commit/42114fc6) Add
`remark-flexible-paragraphs` to list of plugins
by [@&#8203;talatkuyuk](https://togithub.com/talatkuyuk) in
[https://github.com/remarkjs/remark/pull/1120](https://togithub.com/remarkjs/remark/pull/1120)
- [`6aa638a`](https://togithub.com/remarkjs/remark/commit/6aa638ab) Add
`remark-flexible-containers` to list of plugins
by [@&#8203;talatkuyuk](https://togithub.com/talatkuyuk) in
[https://github.com/remarkjs/remark/pull/1112](https://togithub.com/remarkjs/remark/pull/1112)
- [`20e7543`](https://togithub.com/remarkjs/remark/commit/20e75435) Add
`remark-flexible-code-titles` to list of plugins
by [@&#8203;talatkuyuk](https://togithub.com/talatkuyuk) in
[https://github.com/remarkjs/remark/pull/1108](https://togithub.com/remarkjs/remark/pull/1108)
- [`32d6948`](https://togithub.com/remarkjs/remark/commit/32d69488) Add
`remark-cloudinary-docusaurus` to list of plugins
by [@&#8203;johnnyreilly](https://togithub.com/johnnyreilly) in
[https://github.com/remarkjs/remark/pull/1090](https://togithub.com/remarkjs/remark/pull/1090)
- [`28aa8b9`](https://togithub.com/remarkjs/remark/commit/28aa8b9a)
update tests for changes in `mdast-util-to-markdown`
- [`9af1a87`](https://togithub.com/remarkjs/remark/commit/9af1a876) Add
`remark-code-title` to list of plugins
by [@&#8203;kevinzunigacuellar](https://togithub.com/kevinzunigacuellar)
in
[https://github.com/remarkjs/remark/pull/1076](https://togithub.com/remarkjs/remark/pull/1076)
- [`0d1eb09`](https://togithub.com/remarkjs/remark/commit/0d1eb09a) Add
7 plugins to list of plugins
by [@&#8203;Xunnamius](https://togithub.com/Xunnamius) in
[https://github.com/remarkjs/remark/pull/1064](https://togithub.com/remarkjs/remark/pull/1064)
- [`c7e8171`](https://togithub.com/remarkjs/remark/commit/c7e81713)
Remove deprecated `remark-jargon`
by [@&#8203;LunaticMuch](https://togithub.com/LunaticMuch) in
[https://github.com/remarkjs/remark/pull/1059](https://togithub.com/remarkjs/remark/pull/1059)

**Full Changelog**:
remarkjs/remark@14.0.2...14.0.3

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/tailscale-dev/tailscale-dev).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS44Ny4xIiwidXBkYXRlZEluVmVyIjoiMzUuODcuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

5 participants