8000 fix(docs): Wrong regular expression in documentation by jvxiao · Pull Request #1696 · vue-styleguidist/vue-styleguidist · GitHub
[go: up one dir, main page]

Skip to content

Conversation

jvxiao
Copy link
@jvxiao jvxiao commented Apr 17, 2025

File path: package/vue-doc-cli/README.md

Description: A part of the description of getDestFile is :

default: (file, config) => path.resolve(config.outDir, file).replace(/\.\w+/$/, '.md')

the express .replace(/\.\w+/$/, '.md') is supposed to realce the filename extension from .vue, .jsx ... to .md, but it was wrong spelled, the right one is in follow content:

default: (file, config) => path.resolve(config.outDir, file).replace(/\.\w+$/, '.md')

Copy link
changeset-bot bot commented Apr 17, 2025

🦋 Changeset detected

Latest commit: 9e64a6c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
vue-docgen-cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
what-the-diff bot commented Apr 17, 2025

PR Summary

  • Correction in Documentation Regex Pattern
    The pattern used in the documentation for explaining the function getDestFile had a little error due to an additional backslash. This update corrects it, which means the documentation will now guide users more accurately on how to use this function.

@elevatebart elevatebart enabled auto-merge (squash) April 17, 2025 13:22
@jvxiao
Copy link
Author
jvxiao commented Apr 17, 2025

Problem arised during the test task, causing by installing pnpm package manager. Could you help me to merge this PR? @elevatebart

image

Copy link
cypress bot commented Apr 22, 2025

vue-styleguidist    Run #753

Run Properties:  status check passed Passed #753  •  git commit 9e64a6c559: Merge branch 'dev' into dev
Project vue-styleguidist
Branch Review pull/1696
Run status status check passed Passed #753
Run duration 03m 13s
Commit git commit 9e64a6c559: Merge branch 'dev' into dev
Committer Barthélémy Ledoux
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 8
View all changes introduced in this branch ↗︎

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.

2 participants
0