chore: enhance infrastructure

Author: AngusFu

.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+    jest: true,
+    browser: true
+  },
+  plugins: ['prettier'],
+  extends: ['eslint:recommended', require.resolve('eslint-config-prettier')],
+  rules: {
+    'prettier/prettier': 'warn',
+    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+  },
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module'
+  }
+}

.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 80,
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "insertPragma": false,
+  "arrowParens": "avoid",
+  "htmlWhitespaceSensitivity": "ignore"
+}

lib/compileTemplate.js

@@ -5,21 +5,22 @@ var chalk = require('chalk')
 var vueCompiler = require('vue-template-compiler')
 var transpile = require('vue-template-es2015-compiler')
 
-module.exports = function compileTemplate (template, compiler) {
+module.exports = function compileTemplate(template) {
   var compiled = vueCompiler.compile(template)
   if (compiled.errors.length) {
-    compiled.errors.forEach(function (msg) {
+    compiled.errors.forEach(function(msg) {
       console.error('\n' + chalk.red(msg) + '\n')
     })
     throw new Error('Vue template compilation failed')
   } else {
     return {
       render: toFunction(compiled.render),
-      staticRenderFns: '[' + compiled.staticRenderFns.map(toFunction).join(',') + ']'
+      staticRenderFns:
+        '[' + compiled.staticRenderFns.map(toFunction).join(',') + ']'
     }
   }
 }
 
-function toFunction (code) {
+function toFunction(code) {
   return transpile('function render () {' + code + '}')
 }

lib/customTOC.js

@@ -2,8 +2,8 @@ const select = require('unist-util-select')
 const { slugify } = require('transliteration')
 const toString = require('mdast-util-to-string')
 
-module.exports = function yaml () {
-  return function transformer (tree, file) {
+module.exports = function yaml() {
+  return function transformer(tree, file) {
     let lastH2 = null
     const level2 = []
 
@@ -19,7 +19,7 @@ module.exports = function yaml () {
 
       // TOC
       if (depth === 2) {
-        level2.push(lastH2 = node)
+        level2.push((lastH2 = node))
       } else if (depth === 3) {
         lastH2.children.push(node)
       }
@@ -29,7 +29,7 @@ module.exports = function yaml () {
   }
 }
 
-function attchSlug (node, id) {
+function attchSlug(node, id) {
   if (!node.data) {
     node.data = {}
   }

lib/index.js

@@ -33,7 +33,7 @@ const processor = unified()
   // add `v-pre` for code blocks
   .use(
     () =>
-      function transformer (tree) {
+      function transformer(tree) {
         const pres = select(tree, 'element[tagName=pre]')
         pres.forEach(pre => {
           const { children, properties } = pre
@@ -55,25 +55,29 @@ const processor = unified()
 const compileTemplate = require('./compileTemplate')
 const styleInjectFile = join(__dirname, 'styleInject.js')
 
-module.exports = function process (path, option, callback) {
+module.exports = function process(path, option, callback) {
   if (typeof option === 'function') {
     callback = option
   }
 
   const file = vfile.readSync(path)
   file.userOption = option
   // 与 vuepress-plugin-playground 整合
-  file.contents = file.contents.toString().replace(/```(html|vue)\s+@(playground|demo)\s/g, m => {
-    return m.replace(/@(playground|demo)/, '')
-  })
-  processor.process(file, function (err, file) {
+  file.contents = file.contents
+    .toString()
+    .replace(/```(html|vue)\s+@(playground|demo)\s/g, m => {
+      return m.replace(/@(playground|demo)/, '')
+    })
+  processor.process(file, function(err, file) {
     if (err) {
       return callback(err)
     }
 
     if (file) {
       const { components, styles } = file.data
-      const content = `<article class="markdown-body">${file.contents}</article>`
+      const content = `<article class="markdown-body">${
+        file.contents
+      }</article>`
       const { render, staticRenderFns } = compileTemplate(content)
 
       file.extname = '.js'

lib/inline/compile.js

@@ -4,7 +4,7 @@ const vue = require('rollup-plugin-vue')
 const commonjs = require('rollup-plugin-commonjs')
 const memory = require('../rollup/pluginMemory')
 
-module.exports = function compile (sfc, name) {
+module.exports = function compile(sfc, name) {
   let style = ''
   const file = resolve(process.cwd(), './virtual.vue')
   const config = {
@@ -16,7 +16,7 @@ module.exports = function compile (sfc, name) {
       }),
       commonjs(),
       vue({
-        css (content) {
+        css(content) {
           style = content
         },
         vue: {
@@ -30,10 +30,12 @@ module.exports = function compile (sfc, name) {
     name,
     format: 'iife'
   }
-  return rollup(config).then(bundle => bundle.generate(output)).then(ret => {
-    return {
-      style,
-      script: ret.code
-    }
-  })
+  return rollup(config)
+    .then(bundle => bundle.generate(output))
+    .then(ret => {
+      return {
+        style,
+        script: ret.code
+      }
+    })
 }

lib/inline/normalize.js

@@ -1,8 +1,7 @@
-
 /**
  * 用于从 Vue SFC 代码块中提取出不同部分
  */
-module.exports = function normalizeVueDemo (code) {
+module.exports = function normalizeVueDemo(code) {
   const reStyle = /<style(|\s*[^>]+)>([\s\S]+)<\/style>/
   const reScript = /<script(|\s*[^>]+)>([\s\S]+)<\/script>/
   const reTemplate = /<template(|\s*[^>]+)>([\s\S]+)<\/template>/
@@ -19,7 +18,10 @@ module.exports = function normalizeVueDemo (code) {
 
   // if `<template>` absent
   if (template === '') {
-    template = code.replace(reStyle, '').replace(reScript, '')
+    template = code
+      .replace(reStyle, '')
+      .replace(reScript, '')
+      .trim()
   }
 
   if (script === '') {
@@ -40,7 +42,9 @@ ${script}
 </script>`
 
   if (style !== '') {
-    sfc = `<style ${styleAttrs ? `${styleAttrs} ` : ''}scoped>${style}</style>\n` + sfc
+    sfc =
+      `<style ${styleAttrs ? `${styleAttrs} ` : ''}scoped>${style}</style>\n` +
+      sfc
   }
 
   const demoOnly = templateAttrs.indexOf('demo-only') > -1

lib/parseFront.js

@@ -3,8 +3,8 @@ const select = require('unist-util-select')
 const toString = require('mdast-util-to-string')
 const ofType = (node, type) => is({ type }, node)
 
-module.exports = function yaml () {
-  return function transformer (tree, file) {
+module.exports = function yaml() {
+  return function transformer(tree, file) {
     const headings = select(tree, 'heading[depth=1]')
     const h1 = headings.length && headings[0]
     const heading = h1 ? toString(h1) : 'Not Found'

lib/rollup/pluginMemory.js

@@ -1,21 +1,21 @@
 /**
  * https://github.com/TrySound/rollup-plugin-memory/blob/master/src/index.js
  */
-function isPath (path) {
+function isPath(path) {
   return typeof path === 'string'
 }
 
-function isContents (contents) {
+function isContents(contents) {
   return typeof contents === 'string' || Buffer.isBuffer(contents)
 }
 
-module.exports = function memory (config = {}) {
+module.exports = function memory(config = {}) {
   let path = isPath(config.path) ? config.path : null
   let contents = isContents(config.contents) ? String(config.contents) : null
 
   return {
     // do not use `options` as name for 1st argument
-    options (rollupOptions) {
+    options(rollupOptions) {
       const { input } = rollupOptions
       if (input && typeof input === 'object') {
         if (isPath(input.path)) {
@@ -28,7 +28,7 @@ module.exports = function memory (config = {}) {
       rollupOptions.input = path
     },
 
-    resolveId (id) {
+    resolveId(id) {
       if (path === null || contents === null) {
         throw Error(
           "'path' should be a string and 'contents' should be a string of Buffer"
@@ -39,7 +39,7 @@ module.exports = function memory (config = {}) {
       }
     },
 
-    load (id) {
+    load(id) {
       if (id === path) {
         return contents
       }

lib/styleInject.js

@@ -1,5 +1,5 @@
 // https://github.com/egoist/style-inject/blob/master/src/index.js
-module.exports = function styleInject (css, { insertAt } = {}) {
+module.exports = function styleInject(css, { insertAt } = {}) {
   if (!css || typeof document === 'undefined') return
 
   const head = document.head || document.getElementsByTagName('head')[0]
@@ -22,7 +22,7 @@ module.exports = function styleInject (css, { insertAt } = {}) {
     style.appendChild(document.createTextNode(css))
   }
 
-  return function () {
+  return function() {
     head.removeChild(style)
   }
 }

lib/vueTransform.js

@@ -7,11 +7,11 @@ const classnames = require('classnames')
 const compileInlineDemo = require('./inline/compile')
 const normalizeInlineDemo = require('./inline/normalize')
 
-module.exports = function vueTransform () {
+module.exports = function vueTransform() {
   return transformer
 }
 
-function transformer (tree, file, next) {
+function transformer(tree, file, next) {
   let uid = 0
   const promises = []
   visit(tree, 'element', visitor)
@@ -29,7 +29,7 @@ function transformer (tree, file, next) {
       next(e, tree, file)
     })
 
-  function visitor (node) {
+  function visitor(node) {
     if (!is({ tagName: 'pre' }, node)) {
       return
     }

package.json

@@ -4,12 +4,14 @@
   "description": "",
   "main": "lib/index.js",
   "scripts": {
-    "test": "jest --watch"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/AngusFu/md2vue.git"
+    "test": "jest --watch",
+    "commit": "npx git-cz",
+    "release": "npx standard-version",
+    "lint": "eslint ./lib",
+    "lint:fix": "eslint --fix --ext .js,.jsx ./lib",
+    "format": "pretty-quick --pattern \"**/*.*(js|jsx)\""
   },
+  "repository": "git+https://github.com/AngusFu/md2vue.git",
   "author": "wemlion <[email protected]>",
   "license": "MIT",
   "bugs": {
@@ -54,9 +56,48 @@
     "stylus": "^0.54.5"
   },
   "devDependencies": {
+    "@commitlint/cli": "^7.5.2",
+    "@commitlint/config-conventional": "^7.5.0",
     "@vue/test-utils": "^1.0.0-beta.24",
+    "babel-eslint": "^10.0.1",
+    "commitizen": "^3.0.7",
+    "cz-conventional-changelog": "^2.1.0",
+    "eslint": "^5.15.1",
+    "eslint-config-prettier": "^4.1.0",
+    "eslint-formatter-friendly": "^6.0.0",
+    "eslint-plugin-prettier": "^3.0.1",
+    "husky": "^1.3.1",
     "jest": "^23.5.0",
-    "standard-version": "^5.0.0",
+    "lint-staged": "^8.1.5",
+    "prettier": "^1.16.4",
+    "pretty-quick": "^1.10.0",
+    "standard-version": "^5.0.1",
     "vue": "^2.5.17"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "pretty-quick --staged && lint-staged"
+    }
+  },
+  "lint-staged": {
+    "linters": {
+      "*.{js,jsx}": [
+        "eslint --format friendly"
+      ]
+    },
+    "ignore": [
+      "**/dist/*.js"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
   }
 }