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

fix: #2466 load site config from config.cjs if available #2933

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

soletan
Copy link

@soletan soletan commented Oct 3, 2021

Summary

In context of packages declared as type module in package.json, using config.js does not work due to expecting ES modules syntax in that file and vuepress still trying to use require() for loading. In such a context, Node.js supports extension .cjs to individually mark a file as CommonJS style. However, VuePress didn't recognize those files due to lack of explicitly looking for them. And that's what this PR is for.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@soletan soletan changed the title fix #2466: load site config from config.cjs if available fix 2466: load site config from config.cjs if available Oct 3, 2021
@soletan soletan changed the title fix 2466: load site config from config.cjs if available fix #2466: load site config from config.cjs if available Oct 3, 2021
@soletan soletan changed the title fix #2466: load site config from config.cjs if available fix: #2466 load site config from config.cjs if available Oct 3, 2021
@plh97
Copy link

plh97 commented Jul 2, 2022

when will you merge 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