refactor: Moved all dev/docker files to /tools folder

tools/Dockerfile

@@ -0,0 +1,12 @@
+FROM requarks/wiki:latest
+
+# Replace with your email address:
+ENV WIKI_ADMIN_EMAIL admin@example.com
+
+WORKDIR /var/wiki
+
+# Replace your-config.yml with the path to your config file:
+ADD your-config.yml config.yml
+
+EXPOSE 3000
+ENTRYPOINT [ "node", "server" ]

tools/docker-compose.yml

@@ -0,0 +1,19 @@
+version: '3'
+services:
+  wikidb:
+    image: mongo
+    expose:
+      - '27017'
+    command: '--smallfiles --logpath=/dev/null'
+    volumes:
+      - ./data/mongo:/data/db
+  wikijs:
+    image: 'requarks/wiki:latest'
+    links:
+      - wikidb
+    ports:
+      - '80:3000'
+    environment:
+      - WIKI_ADMIN_EMAIL: admin@example.com
+    volumes:
+      - ./config.yml:/var/wiki/config.yml

tools/fuse.js

@@ -0,0 +1,192 @@
+'use strict'
+
+/**
+ * FUSEBOX
+ *
+ * Client & Server compiler / bundler / watcher
+ */
+
+const colors = require('colors/safe')
+const fsbx = require('fuse-box')
+const nodemon = require('nodemon')
+const babel = require('babel-core')
+const uglify = require('uglify-es')
+const fs = require('fs-extra')
+
+// ======================================================
+// Parse cmd arguments
+// ======================================================
+
+const args = require('yargs')
+  .option('d', {
+    alias: 'dev',
+    describe: 'Start in Developer mode',
+    type: 'boolean'
+  })
+  .option('c', {
+    alias: 'dev-configure',
+    describe: 'Start in Configure Developer mode',
+    type: 'boolean'
+  })
+  .help('h')
+  .alias('h', 'help')
+  .argv
+
+let mode = 'build'
+const dev = args.d || args.c
+if (args.d) {
+  console.info(colors.bgWhite.black(' Starting Fuse in DEVELOPER mode... '))
+  mode = 'dev'
+} else if (args.c) {
+  console.info(colors.bgWhite.black(' Starting Fuse in CONFIGURE DEVELOPER mode... '))
+  mode = 'dev-configure'
+} else {
+  console.info(colors.bgWhite.black(' Starting Fuse in BUILD mode... '))
+}
+
+// ======================================================
+// BUILD VARS
+// ======================================================
+
+const ALIASES = {
+  'brace-ext-modelist': 'brace/ext/modelist.js',
+  'simplemde': 'simplemde/dist/simplemde.min.js',
+  'socket-io-client': 'socket.io-client/dist/socket.io.js',
+  'vue': (dev) ? 'vue/dist/vue.js' : 'vue/dist/vue.min.js',
+  'vue-lodash': 'vue-lodash/dist/vue-lodash.min.js',
+  'vue-resource': (dev) ? 'vue-resource/dist/vue-resource.js' : 'vue-resource/dist/vue-resource.es2015.js'
+}
+const SHIMS = {
+  jquery: {
+    source: '../node_modules/jquery/dist/jquery.js',
+    exports: '$'
+  },
+  diff2html: {
+    source: '../node_modules/diff2html/dist/diff2html.min.js',
+    exports: 'Diff2Html'
+  },
+  diff2htmlui: {
+    source: '../node_modules/diff2html/dist/diff2html-ui.min.js',
+    exports: 'Diff2HtmlUI'
+  }
+}
+
+// ======================================================
+// Global Tasks
+// ======================================================
+
+console.info(colors.white('└── ') + colors.green('Running global tasks...'))
+let globalTasks = require('./fuse_tasks')
+
+// ======================================================
+// Fuse Tasks
+// ======================================================
+
+globalTasks.then(() => {
+  let fuse = fsbx.FuseBox.init({
+    homeDir: '../client',
+    output: '../assets/js/$name.js',
+    alias: ALIASES,
+    target: 'browser',
+    tsConfig: './tsconfig.json',
+    plugins: [
+      fsbx.EnvPlugin({ NODE_ENV: (dev) ? 'development' : 'production' }),
+      fsbx.VuePlugin(),
+      ['.scss', fsbx.SassPlugin({ outputStyle: (dev) ? 'nested' : 'compressed' }), fsbx.CSSPlugin()],
+      fsbx.BabelPlugin({ comments: false, presets: ['es2015'] }),
+      fsbx.JSONPlugin()
+      /* !dev && fsbx.QuantumPlugin({
+        target: 'browser',
+        uglify: true,
+        api: (core) => {
+          core.solveComputed('default/js/components/editor-codeblock.vue', {
+            mapping: '/js/ace/ace.js',
+            fn: (statement, core) => {
+              statement.setExpression(`'/js/ace/ace.js'`)
+            }
+          })
+          core.solveComputed('default/js/components/editor.component.js', {
+            mapping: '/js/simplemde/simplemde.min.js',
+            fn: (statement, core) => {
+              statement.setExpression(`'/js/simplemde/simplemde.min.js'`)
+            }
+          })
+        }
+      }) */
+      // !dev && fsbx.UglifyESPlugin()
+    ],
+    debug: false,
+    log: true
+  })
+
+  const bundleVendor = fuse.bundle('vendor').shim(SHIMS).instructions('~ index.js') // eslint-disable-line no-unused-vars
+  const bundleApp = fuse.bundle('app').instructions('!> [index.js]')
+  // const bundleApp = fuse.bundle('app').shim(SHIMS).instructions('> index.js')
+  const bundleSetup = fuse.bundle('configure').instructions('> configure.js')
+
+  switch (mode) {
+    case 'dev':
+      bundleApp.watch()
+      break
+    case 'dev-configure':
+      bundleSetup.watch()
+      break
+  }
+
+  fuse.run().then(() => {
+    console.info(colors.green.bold('\nAssets compilation + bundling completed.'))
+
+    if (dev) {
+      nodemon({
+        exec: (args.d) ? 'node server' : 'node wiki configure',
+        ignore: ['assets/', 'client/', 'data/', 'repo/', 'tests/'],
+        ext: 'js json',
+        watch: (args.d) ? ['server'] : ['server/configure.js'],
+        env: { 'NODE_ENV': 'development' }
+      })
+    } else {
+      console.info(colors.yellow.bold('\nTranspiling vendor bundle...'))
+      let appCode = babel.transform(fs.readFileSync('./assets/js/app.js', 'utf8'), {
+        babelrc: false,
+        compact: false,
+        filename: 'app.js',
+        plugins: ['transform-object-assign']
+      }).code
+      let vendorCode = babel.transform(fs.readFileSync('./assets/js/vendor.js', 'utf8'), {
+        babelrc: false,
+        comments: false,
+        compact: false,
+        filename: 'vendor.js',
+        plugins: [
+          'transform-es2015-arrow-functions',
+          'transform-es2015-block-scoped-functions',
+          'transform-es2015-block-scoping',
+          'transform-es2015-classes',
+          'transform-es2015-computed-properties',
+          'transform-es2015-destructuring',
+          'transform-es2015-duplicate-keys',
+          'transform-es2015-for-of',
+          'transform-es2015-function-name',
+          'transform-es2015-literals',
+          'transform-es2015-object-super',
+          'transform-es2015-parameters',
+          'transform-es2015-shorthand-properties',
+          'transform-es2015-spread',
+          'transform-es2015-sticky-regex',
+          'transform-es2015-template-literals',
+          'transform-es2015-typeof-symbol',
+          'transform-es2015-unicode-regex'
+        ]
+      }).code
+      console.info(colors.yellow.bold('Minifing bundles...'))
+      fs.writeFileSync('./assets/js/vendor.js', uglify.minify(vendorCode).code, 'utf8')
+      fs.writeFileSync('./assets/js/app.js', uglify.minify(appCode).code, 'utf8')
+      fs.writeFileSync('./assets/js/configure.js', uglify.minify(fs.readFileSync('./assets/js/configure.js', 'utf8')).code, 'utf8')
+      console.info(colors.green.bold('\nBUILD SUCCEEDED.'))
+      return true
+    }
+  }).catch(err => {
+    console.error(colors.red(' X Bundle compilation failed! ' + err.message))
+    process.exit(1)
+  })
+})

tools/fuse_tasks.js

@@ -0,0 +1,96 @@
+'use strict'
+
+const _ = require('lodash')
+const Promise = require('bluebird')
+const colors = require('colors/safe')
+const fs = Promise.promisifyAll(require('fs-extra'))
+const path = require('path')
+const uglify = require('uglify-es')
+
+module.exports = Promise.mapSeries([
+  /**
+   * SimpleMDE
+   */
+  () => {
+    return fs.accessAsync('./assets/js/simplemde').then(() => {
+      console.info(colors.white('  └── ') + colors.magenta('SimpleMDE directory already exists. Task aborted.'))
+      return true
+    }).catch(err => {
+      if (err.code === 'ENOENT') {
+        console.info(colors.white('  └── ') + colors.green('Copy + Minify SimpleMDE to assets...'))
+        return fs.copy('./node_modules/simplemde/dist/simplemde.min.js', './assets/js/simplemde/simplemde.min.js')
+      } else {
+        throw err
+      }
+    })
+  },
+  /**
+   * ACE Modes
+   */
+  () => {
+    return fs.accessAsync('./assets/js/ace').then(() => {
+      console.info(colors.white('  └── ') + colors.magenta('ACE modes directory already exists. Task aborted.'))
+      return true
+    }).catch(err => {
+      if (err.code === 'ENOENT') {
+        console.info(colors.white('  └── ') + colors.green('Copy + Minify ACE modes to assets...'))
+        return fs.ensureDirAsync('./assets/js/ace').then(() => {
+          return Promise.join(
+            // Core
+            Promise.all([
+              fs.readFileAsync('./node_modules/brace/index.js', 'utf8'),
+              fs.readFileAsync('./node_modules/brace/ext/modelist.js', 'utf8'),
+              fs.readFileAsync('./node_modules/brace/theme/dawn.js', 'utf8'),
+              fs.readFileAsync('./node_modules/brace/theme/tomorrow_night.js', 'utf8'),
+              fs.readFileAsync('./node_modules/brace/mode/markdown.js', 'utf8')
+            ]).then(items => {
+              console.info(colors.white('      ace.js'))
+              let result = uglify.minify(items.join(';\n'), { output: { 'max_line_len': 1000000 } })
+              return fs.writeFileAsync('./assets/js/ace/ace.js', result.code)
+            }),
+            // Modes
+            fs.readdirAsync('./node_modules/brace/mode').then(modeList => {
+              return Promise.map(modeList, mdFile => {
+                return fs.readFileAsync(path.join('./node_modules/brace/mode', mdFile), 'utf8').then(modeCode => {
+                  console.info(colors.white('      mode-' + mdFile))
+                  let result = uglify.minify(modeCode, { output: { 'max_line_len': 1000000 } })
+                  return fs.writeFileAsync(path.join('./assets/js/ace', 'mode-' + mdFile), result.code)
+                })
+              }, { concurrency: 3 })
+            })
+          )
+        })
+      } else {
+        throw err
+      }
+    })
+  },
+  /**
+   * i18n
+   */
+  () => {
+    console.info(colors.white('  └── ') + colors.green('Copying i18n client files...'))
+    return fs.ensureDirAsync('./assets/js/i18n').then(() => {
+      return fs.readJsonAsync('./server/locales/en/browser.json').then(enContent => {
+        return fs.readdirAsync('./server/locales').then(langs => {
+          return Promise.map(langs, lang => {
+            console.info(colors.white('      ' + lang + '.json'))
+            let outputPath = path.join('./assets/js/i18n', lang + '.json')
+            return fs.readJsonAsync(path.join('./server/locales', lang + 'browser.json'), 'utf8').then((content) => {
+              return fs.outputJsonAsync(outputPath, _.defaultsDeep(content, enContent))
+            }).catch(err => { // eslint-disable-line handle-callback-err
+              return fs.outputJsonAsync(outputPath, enContent)
+            })
+          })
+        })
+      })
+    })
+  },
+  /**
+   * Delete Fusebox cache
+   */
+  () => {
+    console.info(colors.white('  └── ') + colors.green('Clearing fuse-box cache...'))
+    return fs.emptyDirAsync('./.fusebox')
+  }
+], f => { return f() })

tools/pug-lintrc.json

@@ -0,0 +1,16 @@
+{
+  "disallowDuplicateAttributes": true,
+  "disallowIdAttributeWithStaticValue": true,
+  "disallowMultipleLineBreaks": true,
+  "requireClassLiteralsBeforeAttributes": true,
+  "requireIdLiteralsBeforeAttributes": true,
+  "requireLineFeedAtFileEnd": true,
+  "requireLowerCaseAttributes": true,
+  "requireLowerCaseTags": true,
+  "requireSpaceAfterCodeOperator": true,
+  "requireStrictEqualityOperators": true,
+  "validateAttributeQuoteMarks": "'",
+  "validateAttributeSeparator": ", ",
+  "validateDivTags": true,
+  "validateIndentation": 2
+}

tools/semver_next.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+# Increment a version string using Semantic Versioning (SemVer) terminology.
+
+# Parse command line options.
+
+while getopts ":Mmp" Option
+do
+  case $Option in
+    M ) major=true;;
+    m ) minor=true;;
+    p ) patch=true;;
+  esac
+done
+
+shift $(($OPTIND - 1))
+
+version=$1
+
+# Build array from version string.
+
+a=( ${version//./ } )
+
+# If version string is missing or has the wrong number of members, show usage message.
+
+if [ ${#a[@]} -ne 3 ]
+then
+  echo "usage: $(basename $0) [-Mmp] major.minor.patch"
+  exit 1
+fi
+
+# Increment version numbers as requested.
+
+if [ ! -z $major ]
+then
+  ((a[0]++))
+  a[1]=0
+  a[2]=0
+fi
+
+if [ ! -z $minor ]
+then
+  ((a[1]++))
+  a[2]=0
+fi
+
+if [ ! -z $patch ]
+then
+  ((a[2]++))
+fi
+
+echo "${a[0]}.${a[1]}.${a[2]}"

tools/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "alwaysStrict": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "preserveConstEnums": true,
+    "removeComments": true,
+    "sourceMap": false,
+    "strictNullChecks": true,
+    "suppressImplicitAnyIndexErrors": true,
+    "target": "es5"
+  },
+  "exclude": [
+    ".fusebox",
+    "data",
+    "node_modules",
+    "repo"
+  ]
+}