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

Adds option for adding a prefix #15

Merged
merged 6 commits into from
Oct 31, 2022
Merged

Adds option for adding a prefix #15

merged 6 commits into from
Oct 31, 2022

Conversation

onyxcodes
Copy link
Contributor

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

Fixes #14

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Oct 27, 2022
@onyxcodes
Copy link
Contributor Author

@wooorm just a reminder: you should leave out the edits on pacakage.json (i just needed it for installing the module directly from gh)

@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2022

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (bb371d0) compared to base (22d2ab6).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #15   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           28        37    +9     
=========================================
+ Hits            28        37    +9     
Impacted Files Coverage Δ
index.js 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Thanks! Couple of improvements you can apply. Can you also run npm test to check everything and format everything?
Finally, this needs docs: you can take the text from the JSDoc, and here’s an example of how we document options: https://github.com/rehypejs/rehype-autolink-headings#unifieduserehypeautolinkheadings-options.

index.js Outdated Show resolved Hide resolved
index.js Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
'should match'
)
}
)
Copy link
Member

Choose a reason for hiding this comment

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

Some of your code doesn’t match our code style. Please run npm test

@onyxcodes
Copy link
Contributor Author

Should I also add to the documentation an example with prefixing?

readme.md Outdated Show resolved Hide resolved
@wooorm
Copy link
Member

wooorm commented Oct 29, 2022

Should I also add to the documentation an example with prefixing?

This project is so small that I don’t think it’s needed!

@wooorm wooorm merged commit 899b3b7 into rehypejs:main Oct 31, 2022
@wooorm wooorm added 🦋 type/enhancement This is great to have 🧒 semver/minor This is backwards-compatible change 💪 phase/solved Post is done labels Oct 31, 2022
@github-actions

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Oct 31, 2022
@wooorm
Copy link
Member

wooorm commented Oct 31, 2022

Thanks, released in 5.1!

fuxingloh referenced this pull request in fuxingloh/contented Oct 31, 2022
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [rehype-slug](https://togithub.com/rehypejs/rehype-slug) | [`^5.0.1`
-> `^5.1.0`](https://renovatebot.com/diffs/npm/rehype-slug/5.0.1/5.1.0)
|
[![age](https://badges.renovateapi.com/packages/npm/rehype-slug/5.1.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/rehype-slug/5.1.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/rehype-slug/5.1.0/compatibility-slim/5.0.1)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/rehype-slug/5.1.0/confidence-slim/5.0.1)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>rehypejs/rehype-slug</summary>

###
[`v5.1.0`](https://togithub.com/rehypejs/rehype-slug/releases/tag/5.1.0)

[Compare
Source](https://togithub.com/rehypejs/rehype-slug/compare/5.0.1...5.1.0)

- [`899b3b7`](https://togithub.com/rehypejs/rehype-slug/commit/899b3b7)
Add `options.prefix`
by [@&#8203;onyxcodes](https://togithub.com/onyxcodes) in
[https://github.com/rehypejs/rehype-slug/pull/15](https://togithub.com/rehypejs/rehype-slug/pull/15)

**Full Changelog**:
rehypejs/rehype-slug@5.0.1...5.1.0

</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/BirthdayResearch/contented).

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

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
💪 phase/solved Post is done 🧒 semver/minor This is backwards-compatible change 🦋 type/enhancement This is great to have
Development

Successfully merging this pull request may close these issues.

Add option for adding a prefix
3 participants