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

refactor(markdown): remove codePlugin and add vPrePlugin (close #1550) #1556

Merged
merged 13 commits into from
May 27, 2024

Conversation

pengzhanbo
Copy link
Member

@pengzhanbo pengzhanbo commented May 17, 2024

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Provide a description in this PR that addresses what the PR is solving. If this PR is going to solve an existing issue, please reference the issue (e.g. close #123).

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Documentation update
  • Other

Description

See #1550 .

Related PRs:

@coveralls
Copy link

coveralls commented May 17, 2024

Pull Request Test Coverage Report for Build 9185430779

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 18 of 19 (94.74%) changed or added relevant lines in 2 files are covered.
  • 30 unchanged lines in 4 files lost coverage.
  • Overall coverage decreased (-2.7%) to 38.53%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/markdown/src/markdown.ts 3 4 75.0%
Files with Coverage Reduction New Missed Lines %
packages/bundler-webpack/src/config/handleDevtool.ts 1 0.0%
packages/bundler-webpack/src/config/handleOtherOptions.ts 4 0.0%
packages/bundler-webpack/src/build/ssr/createClientPlugin.ts 10 0.0%
packages/bundler-webpack/src/build/createClientConfig.ts 15 0.0%
Totals Coverage Status
Change from base Build 9168161159: -2.7%
Covered Lines: 624
Relevant Lines: 1646

💛 - Coveralls

packages/markdown/src/types.ts Outdated Show resolved Hide resolved
pengzhanbo and others added 2 commits May 17, 2024 08:55
Co-authored-by: 张怀文 <mister-hope@outlook.com>
@Mister-Hope
Copy link
Member

I think you can remove code Plugin entirely in this PR.

@Mister-Hope Mister-Hope changed the title feat: deprecated markdown.code, migrate to the ecosystem feat(markdown): remove codePlugin and migrate fence related features to vuepress/ecosystem May 17, 2024
Mister-Hope
Mister-Hope previously approved these changes May 19, 2024
@Mister-Hope
Copy link
Member

@meteorlxy Test is added, this should be ready.

@Mister-Hope Mister-Hope changed the title feat(markdown): remove codePlugin and migrate fence related features to vuepress/ecosystem feat(markdown): remove codePlugin and migrate fence related features to vuepress/ecosystem, close #1550 May 21, 2024
if (code !== false) {
md.use<CodePluginOptions>(codePlugin, code)
if (code) {
logger.warn(
Copy link
Member

Choose a reason for hiding this comment

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

Have we updated the docs? Or maybe we need to link to plugin docs?

Copy link
Member

Choose a reason for hiding this comment

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

No, I will open a pr for this, note a route related pr is open a few days ago not not being merged.

@meteorlxy meteorlxy merged commit f5fc807 into vuepress:main May 27, 2024
30 checks passed
meteorlxy added a commit that referenced this pull request May 27, 2024
#1556)

BREAKING CHANGE: `markdown.code` option is remove. Please use `@vuepress/plugin-shiki` and `@vuepress/plugin-prismjs` instead.

--------------

Co-authored-by: 张怀文 <mister-hope@outlook.com>
Co-authored-by: meteorlxy <meteor.lxy@foxmail.com>
@meteorlxy meteorlxy changed the title feat(markdown): remove codePlugin and migrate fence related features to vuepress/ecosystem, close #1550 refactor(markdown): remove codePlugin and add vPrePlugin (close #1550) May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature request] Removing fence related plugin in @vuepress/markdown
4 participants