chore: compile vuepress with babel to allow es-modules

- this allows code sharing between vuepress plugins and
  vuejs-components
- replace module.exports by "export" and "require" by "import"
- move code without nodejs specific requirements into
  a shared lib-directory

Author: nknapp

.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        }
+      }
+    ]
+  ]
+}

package-lock.json

@@ -26,6 +26,8 @@
   },
   "homepage": "https://github.com/handlebars-lang/docs#readme",
   "devDependencies": {
+    "@babel/core": "^7.5.5",
+    "@babel/register": "^7.5.5",
     "@vue/eslint-config-prettier": "^5.0.0",
     "@vuepress/plugin-pwa": "^1.0.3",
     "axios": "^0.19.0",

package.json

@@ -3,6 +3,9 @@
 
 const basePath = process.env.VUEPRESS_BASE || "/";
 
+// allow es-modules in nodejs libs
+require("@babel/register");
+
 console.log(`basePath: ${basePath}`);
 module.exports = {
   base: basePath,

src/.vuepress/config.js

@@ -1,9 +1,8 @@
-const { prettifyJson } = require("./prettify-json");
-const Handlebars = require("handlebars");
+import { prettifyJson } from "./prettify-json";
+import Handlebars from "handlebars";
 
-class ExampleParser {
-  constructor(originalExample, filePath) {
-    this.filePath = filePath;
+export class ExampleParser {
+  constructor(originalExample) {
     this.originalExample = originalExample;
     this.normalizedExample = null;
     this.parseError = null;
@@ -79,7 +78,3 @@ class ExampleParser {
     });
   }
 }
-
-module.exports = {
-  ExampleParser
-};

src/.vuepress/plugins/lib/example-parser.js src/.vuepress/lib/example-parser.js

@@ -1,7 +1,7 @@
-const axios = require("axios");
-const semver = require("semver");
+import axios from 'axios'
+import semver from 'semver'
 
-async function retrieveVersions() {
+export async function retrieveHandlebarsVersions() {
   const npmMetadata = await retrieveHandlebarsMetadataFromNpmjs();
 
   const allVersions = Object.keys(npmMetadata.versions).filter(version => semver.gte(version, "3.0.0"));
@@ -16,8 +16,4 @@ async function retrieveVersions() {
 async function retrieveHandlebarsMetadataFromNpmjs() {
   const response = await axios.get("https://registry.npmjs.org/handlebars/");
   return response.data;
-}
-
-module.exports = {
-  retrieveVersions
-};
+}

src/.vuepress/plugins/lib/handlebars-versions.js src/.vuepress/lib/handlebars-versions.js

@@ -0,0 +1,8 @@
+import prettier from "prettier";
+
+export function prettifyJson(object, options = { width: 40 }) {
+  return prettier.format(JSON.stringify(object), {
+    parser: "json5",
+    printWidth: options.width
+  });
+}

src/.vuepress/lib/prettify-json.js

@@ -1,13 +1,10 @@
 /* eslint-disable no-console */
+/* eslint-env node */
 
-const { ExampleParser } = require("./lib/example-parser");
-const { ErrorCollector } = require("./lib/error-collector");
+import { ExampleParser } from "../lib/example-parser";
+import { ErrorCollector } from "./lib/error-collector";
 
-module.exports = {
-  addParsedExampleToPage
-};
-
-function addParsedExampleToPage() {
+export function addParsedExampleToPage() {
   const errorCollector = new ErrorCollector();
 
   return {
@@ -19,7 +16,7 @@ function addParsedExampleToPage() {
         return;
       }
 
-      const exampleParser = new ExampleParser(frontmatter.example, _filePath);
+      const exampleParser = new ExampleParser(frontmatter.example);
       frontmatter.parsedExample = exampleParser.parse();
       frontmatter.errorWhileParsingExample = exampleParser.parseError;
 

src/.vuepress/plugins/add-parsed-examples-to-page.js

@@ -1,8 +1,6 @@
-module.exports = {
-  buttonLink
-};
+/* eslint-env node */
 
-function buttonLink() {
+export function buttonLink() {
   return {
     name: "button link",
     extendMarkdown(md) {

src/.vuepress/plugins/button-link.js

@@ -1,11 +1,9 @@
-const fs = require("fs-extra");
-const path = require("path");
+/* eslint-env node */
 
-module.exports = {
-  ensureGhPagesCustomDomain
-};
+import fs from "fs-extra";
+import path from "path";
 
-function ensureGhPagesCustomDomain(options, ctx) {
+export function ensureGhPagesCustomDomain(options, ctx) {
   return {
     name: "copy CNAME to ensure custom domain settings on Github-pages",
     async generated() {

src/.vuepress/plugins/ensure-gh-pages-custom-domain.js

@@ -1,16 +1,13 @@
 /* eslint-disable no-console */
+/* eslint-env node */
 
-const handlebarsVersions = require("./lib/handlebars-versions");
+import { retrieveHandlebarsVersions } from "../lib/handlebars-versions";
 
-module.exports = {
-  storeHandlebarsVersionAtVuePrototype
-};
-
-function storeHandlebarsVersionAtVuePrototype() {
+export function storeHandlebarsVersionAtVuePrototype() {
   return {
     name: "storeHandlebarsVersionAtVuePrototype",
     async enhanceAppFiles() {
-      const versions = await handlebarsVersions.retrieveVersions();
+      const versions = await retrieveHandlebarsVersions();
       console.log("Injecting handlebars versions" + JSON.stringify(versions));
       return {
         name: "storeHandlebarsVersionAtVuePrototype",

src/.vuepress/plugins/inject-handlebars-versions.js

@@ -1,10 +1,11 @@
 /* eslint-disable no-console */
 
-const path = require("path");
+import path from "path";
 
-class ErrorCollector {
-  constructor() {
+export class ErrorCollector {
+  constructor(workingDir) {
     this.filesAndErrors = [];
+    this.workingDir = workingDir;
   }
 
   collectErrorIfNotNull(filePath, error) {
@@ -27,7 +28,3 @@ class ErrorCollector {
     console.log("done");
   }
 }
-
-module.exports = {
-  ErrorCollector
-};