Merge pull request #1 from vaniyokk/dev

vaniyokk · web-flow · commit adb52a5ed4c4 · 2018-12-15T21:26:50.000+02:00
First release
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+    "extends": "standard"
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+__tests__
+__mocks__
+.temp
diff --git a/README.md b/README.md
@@ -1,2 +1,42 @@
 # vuepress-plugin-alias
 Vuepress plugin that generates alias pages for proper redirect handling
+
+## Install
+
+* Yarn
+
+  ```sh
+  yarn add vuepress-plugin-alias
+  ```
+* NPM
+
+  ```sh
+  npm install vuepress-plugin-sitemap
+  ```
+
+## Usage
+
+### Vuepress v1.x
+
+```js
+// .vuepress/config.js
+module.exports = {
+  plugins: [ 'alias' ]
+}
+```
+
+and in your front-matter add alias to redirect from
+
+```md
+---
+alias: old-link.html
+---
+```
+or a list of aliases
+```md
+---
+aliases: 
+ - old-link1.html
+ - old-link2.html
+---
+```
diff --git a/index.js b/index.js
@@ -0,0 +1,37 @@
+const fs = require('fs-extra')
+const path = require('path')
+
+function getTemplate (path) {
+  const result = '<!DOCTYPE html>' +
+    '<html>' +
+    '<head>' +
+      '<meta charset="utf-8">' +
+      '<title>Redirecting...</title>' +
+      '<link rel="canonical" href="' + path + '">' +
+      '<meta http-equiv="refresh" content="0; url=' + path + '">' +
+    '</head>' +
+    '</html>'
+
+  return result
+}
+
+module.exports = (options, ctx) => ({
+  async generated (pagePaths) {
+    const { pages, outDir } = ctx
+
+    pages.filter(({ frontmatter }) => {
+      return frontmatter.alias || frontmatter.aliases
+    }).forEach(page => {
+      let aliases = page.frontmatter.alias || page.frontmatter.aliases
+      if (!Array.isArray(aliases)) aliases = [aliases]
+      if (!aliases.length) return
+
+      const content = getTemplate(page.path)
+
+      aliases.forEach(async alias => {
+        const aliasPagePath = path.resolve(outDir, alias)
+        await fs.outputFile(aliasPagePath, content)
+      })
+    })
+  }
+})
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vuepress-plugin-alias",
-  "version": "1.0.0",
+  "version": "1.0.0-alpha.1",
   "description": "Vuepress plugin that generates alias pages for proper redirect handling",
   "main": "index.js",
   "publishConfig": {
@@ -22,5 +22,16 @@
   "bugs": {
     "url": "https://github.com/vaniyokk/vuepress-plugin-alias/issues"
   },
-  "homepage": "https://github.com/vaniyokk/vuepress-plugin-alias#readme"
+  "homepage": "https://github.com/vaniyokk/vuepress-plugin-alias#readme",
+  "dependencies": {
+    "fs-extra": "^7.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^5.10.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-node": "^8.0.0",
+    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-standard": "^4.0.0"
+  }
 }
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,29 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+fs-extra@^7.0.1:
+  version "7.0.1"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-7.0.1.tgz#4f189c44aa123b895f722804f55ea23eadc348e9"
+  integrity sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^4.0.0"
+    universalify "^0.1.0"
+
+graceful-fs@^4.1.2, graceful-fs@^4.1.6:
+  version "4.1.15"
+  resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.15.tgz#ffb703e1066e8a0eeaa4c8b80ba9253eeefbfb00"
+  integrity sha512-6uHUhOPEBgQ24HM+r6b/QwWfZq+yiFcipKFrOFiBEnWdy5sdzYoi+pJeQaPI5qOLRFqWmAXUPQNsielzdLoecA==
+
+jsonfile@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
+  integrity sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=
+  optionalDependencies:
+    graceful-fs "^4.1.6"
+
+universalify@^0.1.0:
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66"
+  integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ "extends": "standard"`
	`3`	`+};`