feat: plugin public files (close: #1491)

[shigma]

Summary

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.

Motivation

See #1491

Usage

default usage

module.exports = {
  plugins: [
    // includes all files in `sourceDir`
    // ignore dotfiles and markdown
    '@vuepress/public-files',
  ],
}

an array of patterns

Based on #1493

module.exports = {
  plugins: [
    ['@vuepress/public-files', [
      '.vuepress/another-public',
      '.vuepress/one-more-public',
    ]]
  ],
}

object style of pattern

See: https://github.com/webpack-contrib/copy-webpack-plugin#patterns

module.exports = {
  plugins: [
    ['@vuepress/public-files', {
      from: '_assets', // i.e. docs/_assets
      to: 'assets', // i.e. dist/assets
      ignore: [/* globs */],
    }],
  ],
}

use multiple times

module.exports = {
  plugins: [
    ['@vuepress/public-files', [
      '.vuepress/another-public',
      '.vuepress/one-more-public',
    ]],
    ['@vuepress/public-files', {
      from: '_assets',
      to: 'assets',
      ignore: [/* globs */],
    }],
  ],
}

TODO

• Implementation
• Update docs
• Update tests

[shigma]

@ulivz Do you think this can be an official plugin? It is similar to @vuepress/plugin-register-components to a large extent.

[timaschew]

@shigma awesome 🎉 it works 🙏🏼
I'm using this setup BTW:

module.exports = {
  plugins: [
    ['@vuepress/public-files', ['.']]
  ]
}

[shigma]

@timaschew Also, the default option is equivalent to ['.'].

module.exports = {
  plugins: [
    '@vuepress/public-files'
    // equivalent to ['@vuepress/public-files', ['.']]
  ]
}

[timaschew]

@shigma why you're not using git rebase?
All these merge commits from master are very noisy.

[shigma]

Pending for #1515

[timaschew]

Pending for #1515

So this can be continued now?
I could do it (adding tests and docs) if you need help.

Do you plant to have this plugin enabled by default?
If not just keep in mind that migrations from GitBook and other tools would not be possible out of the box.

[shigma]

@timaschew tests have been added in another branch. There still exists some problems with our shared-utils.

[shigma]

@ulivz Ready for review now 😆

[timaschew]

Any updates for this?
I think this will really help people to migrate from other tools without moving their files.

[flozero]

Hello all it's been a while since the pr was introduced i will make a review of the pr soon.

The problem is should it be add in the core or just in some libs of vuepress plugin you can add after.

[calin-darie-evo-sapio]

What happened to the pull request? Is there an alternative now?