Skills

Migrate Goldmark Extension V1 To V2

Migrate goldmark extension from goldmark v1 to v2.

Install

npx skills add yuin/goldmark --skill migrate-goldmark-extension-v1-to-v2 -g -a claude-code -y
Repository
yuin/goldmark5.1k
Category
Engineering
Updated
4d ago
License
MIT
Context cost
Mediumabout 1,999 tokens
Runs scripts
No, instructions only

What it does

Migrate goldmark extension from goldmark v1 to v2.

migrate-goldmark-extension-v1-to-v2

Description

This skill helps you migrate a goldmark (https://github.com/yuin/goldmark) extension from version 1 to version 2. It provides guidance on the changes needed to update your project to be compatible with the new version of goldmark.

Knowledges

  • CommonMark key points : List of key points of CommonMark spec that you should be aware of when implementing a goldmark extension.
  • Breaking changes in v2 : List of breaking changes in goldmark v2 that you should be aware of when migrating your extension from v1 to v2.
  • How to create an extension : Guide on how to create a goldmark extension in v2, including the new extension pattern and how to implement parser and renderer extensions.

Migration steps

Overview of the migration process

  • Create a migration plan for the extension.
  • MUST ask human to confirm that the migration plan is acceptable before proceeding with the migration.
  • MUST ask human to how to test the extension after migration before proceeding with the migration.
    • e.g. : "How do you want to test the extension after migration? Do you have any test cases or examples that you want to use for testing?"
  • Execute the migration plan to update the extension code to be compatible with goldmark v2.
  • Update the test cases to ensure that the extension works as expected with goldmark v2.
  • Test the extension with goldmark v2 to ensure that it works as expected. If there are any issues, fix them and re-test until the extension works as expected.
  • Update the documentation to reflect any changes made during the migration process.

Create a migration plan

Task

Read the whole SKILL.md on GitHub

More in Engineering