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

Update dependency remark-flexible-markers to v1.2.1 #6436

Merged
merged 1 commit into from Mar 23, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 22, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
remark-flexible-markers 1.0.4 -> 1.2.1 age adoption passing confidence

Release Notes

ipikuka/remark-flexible-markers (remark-flexible-markers)

v1.2.1

Compare Source

The changes made by @​talatkuyuk

  • updated the dependencies
  • added a badge for npm downloads in the README
  • corrected some typos in the README
  • made some refinements in types
  • fixed: the option markerProperties shouldn't have "className" key in the returned object, if there is, the plugin deletes the entry from returned object so as not to effect the <mark> attributes

v1.2.0

Compare Source

The changes made by @​talatkuyuk

  • missing keys are added for color classifications into the dictionary
  • the tsconfig.js is updated
  • the dependencies are updated and added new dependencies
  • the type of settings is improved and now, it is partially required on the type of options
  • a second visitor is added to find marker syntax if the content to be marked contains other phrasing contents, fixes https://github.com/ipikuka/remark-flexible-markers/issues/2
  • minor breaking change: the name of the option doubleEqualityCheck is changed with the equalityOperator
  • a third visitor and the option actionForEmptyContent option is added for empty content markers
  • the @types/mdast is extended with the Mark type
  • the regex for matching mark syntax is updated, and it is more strict now
  • a test util is added and the tests are updated
  • the new types TagNameFunction and ClassNameFunction are added into the exported type FlexibleMarkerOptions in order the options markerTagName and markerClassName can take a callback functions respectively
  • test coverage is added %100 and connected with codecov
  • type coverage is added %100
  • the badges are updated in README.md including coverages
  • package-lock.json file is added for fixing a github action
  • npm provenance is applied and an action for pull requests is added into github actions
  • the README.md is completely re-written
It is more powerful now

As of version ^1.2.0, the remark-flexible-markers can handle also the syntax containing other markdown phrases like strong, emphasis, link etc. See https://github.com/ipikuka/remark-flexible-markers?tab=readme-ov-file#it-is-more-powerfull

==**marked bold content**==
==_marked italic content_==
==[marked link](https://google.com)==
It is more strict now

The double equity signs must be adjacent to the content. Here is an example for bad usage, and cause to not work.

== text with unwanted space==
==text with unwanted space ==
It is more flexible now

The options markerTagName and markerClassName can take a callback function in addition to string, now.

type TagNameFunction = (color?: string) => string;
type ClassNameFunction = (color?: string) => string[];
{
  // ...
  markerTagName?: string | TagNameFunction;
  markerClassName?: string | ClassNameFunction;
  // ...
);

For more information see https://github.com/ipikuka/remark-flexible-markers?tab=readme-ov-file#markertagname and https://github.com/ipikuka/remark-flexible-markers?tab=readme-ov-file#markerclassname

In addition to that, a new option actionForEmptyContent?: "keep" | "remove" | "mark" is added to handle mark syntax with empty content. See https://github.com/ipikuka/remark-flexible-markers?tab=readme-ov-file#actionforemptycontent

Please pay attention to a minor breaking change that the name of the option doubleEqualityCheck is changed with the equalityOperator, the behavior is the same.


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.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added dependencies use for pull requests that update a dependency file filigran team use to identify PR from the Filigran team labels Mar 22, 2024
Copy link

codecov bot commented Mar 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.31%. Comparing base (27a0dfd) to head (ed0217f).
Report is 5 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6436   +/-   ##
=======================================
  Coverage   67.31%   67.31%           
=======================================
  Files         541      541           
  Lines       65192    65192           
  Branches     5415     5415           
=======================================
+ Hits        43882    43884    +2     
+ Misses      21310    21308    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SamuelHassine SamuelHassine merged commit e5b95b2 into master Mar 23, 2024
8 checks passed
@SamuelHassine SamuelHassine deleted the renovate/remark-flexible-markers-1.x branch March 23, 2024 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies use for pull requests that update a dependency file filigran team use to identify PR from the Filigran team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant