feat: plugin public files (close: #1491)

.gitignore

@@ -5,3 +5,4 @@ node_modules
 TODOs.md
 packages/@vuepress/shared-utils/lib/
 types
+**/.vuepress/dist

packages/@vuepress/core/lib/node/App.js

@@ -163,6 +163,7 @@ module.exports = class App {
         after: '</div>'
       })
       .use('@vuepress/last-updated', !!shouldUseLastUpdated)
+      .use('@vuepress/public-files', ['.vuepress/public'])
       .use('@vuepress/register-components', {
         componentsDir: [
           path.resolve(this.sourceDir, '.vuepress/components'),

packages/@vuepress/core/lib/node/webpack/createServerConfig.js

@@ -5,14 +5,11 @@
  */
 
 module.exports = function createServerConfig (ctx) {
-  const fs = require('fs')
-  const { path, env } = require('@vuepress/shared-utils')
+  const { env } = require('@vuepress/shared-utils')
   const createBaseConfig = require('./createBaseConfig')
   const VueSSRServerPlugin = require('vue-server-renderer/server-plugin')
-  const CopyPlugin = require('copy-webpack-plugin')
 
   const config = createBaseConfig(ctx, true /* isServer */)
-  const { sourceDir, outDir } = ctx
 
   config
     .target('node')
@@ -36,15 +33,6 @@ module.exports = function createServerConfig (ctx) {
       filename: 'manifest/server.json'
     }])
 
-  const publicDir = path.resolve(sourceDir, '.vuepress/public')
-  if (fs.existsSync(publicDir)) {
-    config
-      .plugin('copy')
-      .use(CopyPlugin, [[
-        { from: publicDir, to: outDir }
-      ]])
-  }
-
   if (!env.isDebug) {
     const WebpackBar = require('webpackbar')
     config

packages/@vuepress/core/package.json

@@ -41,7 +41,6 @@
     "cache-loader": "^3.0.0",
     "chokidar": "^2.0.3",
     "connect-history-api-fallback": "^1.5.0",
-    "copy-webpack-plugin": "^5.0.2",
     "cross-spawn": "^6.0.5",
     "css-loader": "^2.1.1",
     "file-loader": "^3.0.1",

packages/@vuepress/plugin-public-files/README.md

@@ -0,0 +1,5 @@
+# @vuepress/plugin-public-files
+
+> plugin for register public files
+
+See [documentation](https://v1.vuepress.vuejs.org/plugin/official/plugin-public-files.html).

packages/@vuepress/plugin-public-files/__tests__/docs-1/.dotfile

@@ -0,0 +1 @@
+dotfile

packages/@vuepress/plugin-public-files/__tests__/docs-1/.dotfolder/foo.txt

@@ -0,0 +1 @@
+.dotfolder/foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  plugins: [
+    [require('../../..')]
+  ]
+}

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/public/.dotfile

@@ -0,0 +1 @@
+dotfile

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/public/.dotfolder/foo.txt

@@ -0,0 +1 @@
+.dotfolder/foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/public/bar/foo.txt

@@ -0,0 +1 @@
+bar/foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/public/foo.txt

@@ -0,0 +1 @@
+foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/.vuepress/theme/layouts/Layout.vue

@@ -0,0 +1,3 @@
+<template>
+  <Content />
+</template>

packages/@vuepress/plugin-public-files/__tests__/docs-1/bar/baz.txt

@@ -0,0 +1 @@
+bar/baz.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/bar/readme.md

@@ -0,0 +1 @@
+bar/readme

packages/@vuepress/plugin-public-files/__tests__/docs-1/baz.txt

@@ -0,0 +1 @@
+baz.txt

packages/@vuepress/plugin-public-files/__tests__/docs-1/readme.md

@@ -0,0 +1 @@
+readme

packages/@vuepress/plugin-public-files/__tests__/docs-2/.vuepress/config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  plugins: [
+    [require('../../..'), {
+      from: '_assets',
+      to: 'assets',
+      ignore: ['*.ignore'],
+    }]
+  ]
+}

packages/@vuepress/plugin-public-files/__tests__/docs-2/.vuepress/public/foo.txt

@@ -0,0 +1 @@
+foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-2/.vuepress/theme/layouts/Layout.vue

@@ -0,0 +1,3 @@
+<template>
+  <Content />
+</template>

packages/@vuepress/plugin-public-files/__tests__/docs-2/_assets/.dotfile

@@ -0,0 +1 @@
+dotfile

packages/@vuepress/plugin-public-files/__tests__/docs-2/_assets/.dotfolder/foo.txt

@@ -0,0 +1 @@
+.dotfolder/foo.txt

packages/@vuepress/plugin-public-files/__tests__/docs-2/_assets/baz.ignore

@@ -0,0 +1 @@
+baz

packages/@vuepress/plugin-public-files/__tests__/docs-2/readme.md

@@ -0,0 +1,3 @@
+readme
+
+![bar](/bar.png)

packages/@vuepress/plugin-public-files/__tests__/index.spec.js

@@ -0,0 +1,54 @@
+/**
+ * @jest-environment node
+ */
+
+const { createApp } = require('@vuepress/core')
+const { path: { resolve }, fs } = require('@vuepress/shared-utils')
+
+function testForExistence (app, name, existence = true) {
+  test(`${existence ? '' : 'in'}existence: ${name}`, () => {
+    expect(fs.existsSync(resolve(app.outDir, name))).toBe(existence)
+  })
+}
+
+describe('plugin-public-files: source folder', () => {
+  const app = createApp({
+    sourceDir: resolve(__dirname, 'docs-1')
+  })
+
+  beforeAll(async () => {
+    await app.process()
+    await app.build()
+  }, 60000)
+
+  testForExistence(app, 'foo.txt')
+  testForExistence(app, 'baz.txt')
+  testForExistence(app, 'bar/foo.txt')
+  testForExistence(app, 'bar/baz.txt')
+  testForExistence(app, 'index.html')
+  testForExistence(app, 'readme.md', false)
+  testForExistence(app, '.dotfile', false)
+  testForExistence(app, '.dotfolder', false)
+  testForExistence(app, 'bar/readme.md', false)
+})
+
+describe('plugin-public-files: assets folder', () => {
+  const app = createApp({
+    sourceDir: resolve(__dirname, 'docs-2')
+  })
+
+  beforeAll(async () => {
+    await app.process()
+    await app.build()
+  }, 60000)
+
+  testForExistence(app, 'foo.txt')
+  testForExistence(app, 'assets/bar.png')
+  testForExistence(app, 'assets/.dotfile')
+  testForExistence(app, 'assets/.dotfolder/foo.txt')
+  testForExistence(app, 'bar.png', false)
+  testForExistence(app, 'baz.ignore', false)
+  testForExistence(app, '.dotfile', false)
+  testForExistence(app, '.dotfolder', false)
+  testForExistence(app, 'assets/baz.ignore', false)
+})

packages/@vuepress/plugin-public-files/index.js

@@ -0,0 +1,34 @@
+const {
+  fs: { existsSync },
+  path: { resolve }
+} = require('@vuepress/shared-utils')
+const CopyPlugin = require('copy-webpack-plugin')
+const mergeable = require('vuepress-mergeable')
+
+module.exports = mergeable((patterns, context) => ({
+  name: `@vuepress/plugin-public-files`,
+
+  chainWebpack (config) {
+    if (!Array.isArray(patterns)) patterns = [patterns]
+
+    config
+      .plugin('copy')
+      .use(CopyPlugin, [patterns.map((pattern) => {
+        pattern = typeof pattern === 'string'
+          ? { from: pattern }
+          : { ...pattern }
+
+        // `from` will be resolved based on `sourceDir`
+        pattern.from = resolve(context.sourceDir, pattern.from || '')
+        if (!existsSync(pattern.from)) return
+
+        // `to` will be resolved based on `outDir`
+        pattern.to = resolve(context.outDir, pattern.to || '')
+
+        // ignore dotfiles and markdown by default
+        pattern.ignore = pattern.ignore || ['.*', '.*/**', '*.md']
+
+        return pattern
+      }).filter(p => p)])
+  }
+}), 'flat')

packages/@vuepress/plugin-public-files/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vuepress/plugin-public-files",
+  "version": "1.0.4",
+  "description": "register-public-files plugin for vuepress",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vuejs/vuepress.git",
+    "directory": "packages/@vuepress/plugin-public-files"
+  },
+  "scripts": {
+    "build": "vuepress build __tests__/docs-1",
+    "jest": "jest .*\\.spec\\.js$"
+  },
+  "keywords": [
+    "documentation",
+    "vue",
+    "vuepress",
+    "generator"
+  ],
+  "author": "Shigma <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vuejs/vuepress/issues"
+  },
+  "homepage": "https://github.com/vuejs/vuepress/packages/@vuepress/plugin-public-files#readme",
+  "dependencies": {
+    "@vuepress/core": "^1.0.4",
+    "@vuepress/shared-utils": "^1.0.4",
+    "copy-webpack-plugin": "^5.0.3",
+    "vuepress-mergeable": "^1.0.1"
+  }
+}

packages/docs/docs/plugin/official/plugin-public-files.md

@@ -0,0 +1,94 @@
+---
+title: public-files
+metaTitle: public files plugin | VuePress
+---
+
+# [@vuepress/plugin-public-files](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-public-files)
+
+> public files plugin
+
+## Installation
+
+```bash
+yarn add -D @vuepress/plugin-public-files
+# OR npm install -D @vuepress/plugin-public-files
+```
+
+## Usage
+
+### Default Usage
+
+```js
+module.exports = {
+  plugins: [
+    // includes all files in `sourceDir`
+    // ignore dotfiles and markdown
+    "@vuepress/public-files"
+  ]
+};
+```
+
+### An Array of Patterns
+
+```js
+module.exports = {
+  plugins: [
+    [
+      "@vuepress/public-files",
+      [
+        ".vuepress/another-public",
+        ".vuepress/one-more-public",
+        ".vuepress/public-file.txt"
+      ]
+    ]
+  ]
+};
+```
+
+### object style of pattern
+
+See: [https://github.com/webpack-contrib/copy-webpack-plugin#patterns](https://github.com/webpack-contrib/copy-webpack-plugin#patterns)
+
+```js
+module.exports = {
+  plugins: [
+    [
+      "@vuepress/public-files",
+      {
+        from: "_assets", // resolved based on sourceDir
+        to: "assets", // resolved based on outDir
+        ignore: [
+          /* glob patterns to be ignored */
+        ]
+      }
+    ]
+  ]
+};
+```
+
+::: tip
+In fact we support specifying a list of strings or objects.
+:::
+
+### Use Multiple Times
+
+```js
+module.exports = {
+  plugins: [
+    [
+      "@vuepress/public-files",
+      [".vuepress/another-public", ".vuepress/one-more-public"]
+    ],
+    [
+      "@vuepress/public-files",
+      {
+        from: "_assets",
+        to: "assets",
+        ignore: [
+          /* globs */
+        ]
+      }
+    ]
+  ]
+};
+```