Merge pull request #1 from vuepress-reco/develop

Keep updated with upstream

Author: stevapple

.cz-config.js

@@ -0,0 +1,61 @@
+'use strict';
+
+module.exports = {
+
+  types: [
+    {
+      value: 'WIP',
+      name: '💪  WIP:      未完待续'
+    },
+    {
+      value: 'feat',
+      name: '✨  feat:     新的功能'
+    },
+    {
+      value: 'fix',
+      name: '🐞  fix:      Bug 修复'
+    },
+    {
+      value: 'refactor',
+      name: '🔨  refactor: 功能重构'
+    },
+    {
+      value: 'perf',
+      name: '🌸  perf:     性能优化'
+    },
+    {
+      value: 'docs',
+      name: '📚  docs:     文档相关'
+    },
+    {
+      value: 'test',
+      name: '🏁  test:     测试相关'
+    },
+    {
+      value: 'build',
+      name: '🧰  build:    构建或辅助工具的变动'
+    },
+    {
+      value: 'style',
+      name: '💅  style:    优化代码结构或格式'
+    },
+    {
+      value: 'revert',
+      name: '⏪  revert:   回退 commit'
+    },
+    {
+      value: 'chore',
+      name: '⚪  chore:    琐事，不属于以上任何类型'
+    }
+  ],
+
+  scopes: [
+    'vuepress-theme-reco',
+    'vuepress-plugin-back-to-top',
+    'vuepress-plugin-comments',
+    'vuepress-plugin-loading',
+    'vuepress-plugin-pagation'
+  ],
+  allowCustomScopes: true,
+  allowBreakingChanges: ["feat", "fix"]
+};

.eslintignore

@@ -1,3 +1,4 @@
 styles/
 images/
 node_modules/
+.cz-config.js

.gitignore

@@ -1,4 +1,2 @@
-node_modules/
-yarn.lock
-.DS_Store
-package-lock.json
+node_modules
+yarn-error.log

CHANGELOG.md

@@ -0,0 +1,37 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'footer-leading-blank': [1, 'always'],
+    'header-max-length': [2, 'always', 72],
+    'scope-case': [2, 'always', 'lower-case'],
+    'subject-case': [
+      2,
+      'never',
+      ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
+    ],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [0],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'WIP',
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'improvement',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test'
+      ]
+    ]
+  }
+}

commitlint.config.js

@@ -1,13 +1,13 @@
 module.exports = {
   title: "vuepress-theme-reco",
   description: 'A simple and beautiful vuepress blog theme .',
-  dest: 'example/docs/public',
+  dest: 'example/public',
   head: [
     ['link', { rel: 'icon', href: '/favicon.ico' }],
     ['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1,user-scalable=no' }]
   ],
   // theme: 'reco',
-  theme: require.resolve('../../../'),
+  theme: require.resolve('../../packages/vuepress-theme-reco'),
   themeConfig: {
     nav: [
       { text: 'Home', link: '/', icon: 'reco-home' },