ignore code climate reporter error

Author: eidng8

.eslintrc.js

@@ -7,48 +7,32 @@
 module.exports = {
   root: true,
   env: {
-    node: true
+    node: true,
   },
   extends: [
     'plugin:vue/essential',
     '@vue/standard',
-    '@vue/typescript/recommended'
+    '@vue/typescript/recommended',
+    'plugin:prettier/recommended',
   ],
   parserOptions: {
-    ecmaVersion: 2020
+    ecmaVersion: 2020,
   },
   rules: {
-    'comma-dangle': [
-      'error',
-      'always-multiline',
-    ],
-    'eqeqeq': 'off',
-    'space-before-function-paren': [
+    eqeqeq: 'off',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
       'error',
       {
-        'anonymous': 'always',
-        'named': 'never',
-        'asyncArrow': 'always',
+        args: 'after-used',
       },
     ],
-    'object-curly-spacing': [
-      'error',
-      'never',
-    ],
-    'operator-linebreak': [
-      'error',
-      'before',
-    ],
-    'semi': [
-      'error',
-      'always',
-    ],
-    'yoda': [
+    yoda: [
       'error',
       'always',
       {
-        'exceptRange': true,
-        'onlyEquality': true,
+        exceptRange: true,
+        onlyEquality: true,
       },
     ],
     'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
@@ -64,5 +48,12 @@ module.exports = {
         jest: true,
       },
     },
-  ]
+    {
+      files: ['*.js'],
+      rules: {
+        'no-unused-vars': 2,
+        '@typescript-eslint/no-unused-vars': 'off',
+      },
+    },
+  ],
 };

.gitignore

@@ -1,4 +1,5 @@
 /dist
+/docs
 /lib
 /tests/e2e/reports
 

.huskyrc.json

@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "pretty-quick --staged"
+  }
+}

.prettierrc.json

@@ -0,0 +1,15 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "printWidth": 80,
+  "proseWrap": "never",
+  "quoteProps": "as-needed",
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "useTabs": false,
+  "vueIndentScriptAndStyle": false
+}

.travis.yml

@@ -26,13 +26,13 @@ script:
   - cat ./coverage/lcov.info | coveralls
   - npm run test:e2e
 after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || echo code climate error is ignored.
 
 before_deploy:
   - export TRAVIS_TAG=${TRAVIS_TAG:-$(node -p "require('./package.json').version")-$(date +'%Y.%m.%d')-$(git log --format=%h -1)}
   - echo ${TRAVIS_TAG}
-  - "if [[ ${TAGGED} != 1 ]]; then git tag ${TRAVIS_TAG} && export TAGGED=1; fi"
-  - "if [[ ! -e dist ]]; then npm run build && export PACKAGE=$(npm pack --silent); fi"
+  - 'if [[ ${TAGGED} != 1 ]]; then git tag ${TRAVIS_TAG} && export TAGGED=1; fi'
+  - 'if [[ ! -e dist ]]; then npm run build && export PACKAGE=$(npm pack --silent); fi'
 deploy:
   - provider: releases
     skip_cleanup: true

README.md

@@ -1,45 +1,51 @@
 # vue-tree
 
-[![Master Build](https://travis-ci.com/eidng8/vue-tree.svg?branch=master)](https://travis-ci.com/eidng8/vue-tree)
-[![Master Coverage](https://coveralls.io/repos/github/eidng8/vue-tree/badge.svg?branch=master)](https://coveralls.io/github/eidng8/vue-tree?branch=master)
-[![Known Vulnerabilities](https://snyk.io/test/github/eidng8/vue-tree/badge.svg?targetFile=package.json)](https://snyk.io/test/github/eidng8/vue-tree?targetFile=package.json)
-
-A Vue.js tree view component with stable DOM tree. By stable, it means the
-DOM structure will not change once it is rendered.
+[![master build](https://img.shields.io/travis/com/eidng8/vue-tree?color=333&logo=travis)](https://travis-ci.com/eidng8/vue-tree) [![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/eidng8/vue-tree?color=333&logo=snyk)](https://snyk.io/test/github/eidng8/vue-tree?targetFile=package.json) [![maintainability](https://img.shields.io/codeclimate/maintainability/eidng8/vue-tree?color=333&logo=code-climate)](https://codeclimate.com/github/eidng8/vue-tree/maintainability) [![master coverage](https://img.shields.io/coveralls/github/eidng8/vue-tree/master?color=333&logo=coveralls)](https://coveralls.io/github/eidng8/vue-tree?branch=master) [![dev build](https://img.shields.io/travis/com/eidng8/vue-tree/dev?color=333&label=dev%20build&logo=travis)](https://travis-ci.com/eidng8/vue-tree/tree/dev) [![dev coverage](https://img.shields.io/coveralls/github/eidng8/vue-tree/dev?color=333&label=dev%20coverage&logo=coveralls)](https://coveralls.io/github/eidng8/vue-tree?branch=dev)
 
+A Vue.js tree view component with stable DOM tree. By stable, it means the DOM structure will not change once it is rendered.
 
 ## Performance Consideration
 
-The DOM structure of this component doesn't change once rendered.
-Comparing to others using `v-if`, which generate sub-nodes while expanded.
-While working on long list of items, lags will be obvious.
-
-* This component will have a lag when once it is being rendered. After it is
-rendered, sub-trees are controlled by CSS, no DOM structure happens.
-* `v-if` components will lag whenever sub-trees are expanded, every time they
-are expanded.
+The DOM structure of this component doesn't change once rendered. Comparing to others using `v-if`, which generate sub-nodes while expanded. While working on long list of items, lags will be obvious.
 
+- This component will have a lag when once it is being rendered. After it is rendered, sub-trees are controlled by CSS, no DOM structure happens.
+- `v-if` components will lag whenever sub-trees are expanded, every time they are expanded.
 
 ## Theming
 
-This component provides a dark theme out of box. To use it, just add the
-`g8-tree__dark` class to the element.
+The bundled style sheet can be imported from `'g8-vue-tree/dist/g8-vue-tree.css'`. This component provides a dark theme out of box. To use it, just add the `g8-tree__dark` class to the element.
 
 ```html
 <ul class="g8-tree-view g8-tree__dark">
   <g8-tree-view></g8-tree-view>
 </ul>
 ```
 
-If you want to change the color of the component, just defined two variables
-before importing the scss file.
+If you want to change the color of the component, just defined two variables before importing the scss file.
 
 ```scss
 /* index.scss */
 
 /* define these two variables before importing the scss file */
-$g8-tree-bg: #ccc !default;
-$g8-tree-fg: #333 !default;
+$g8-tree-bg: #ccc;
+$g8-tree-fg: #333;
 
-@import "~vue-tree/src/components/tree-view.scss";
+@import '~vue-tree/src/components/tree-view.scss';
 ```
+
+## Props
+
+| Prop name | Description | Type | Values | Default |
+| --- | --- | --- | --- | --- |
+| item | The tree data to be rendered. | G8TreeItem | - |  |
+| checker | Whether to add a checkbox before each item, allowing multiple nodes to<br>be checked. | boolean | - | false |
+
+## Events
+
+| Event name | Type | Description |
+| --- | --- | --- |
+| click | G8ClickEvent | A tree node has been clicked. |
+| dblclick | G8ClickEvent | A tree node has been double clicked. |
+| tag-clicked | G8TagClickEvent | A tree node tag has been clicked. |
+| tag-dbl-clicked | G8TagClickEvent | A tree node tag has been double clicked. |
+| state-changed | G8StateChangeEvent | Checkbox state of the node has changed. |

docgen.config.js

@@ -0,0 +1,11 @@
+/*
+ * GPLv3 https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * Author: eidng8
+ */
+
+module.exports = {
+  componentsRoot: 'src/components',
+  components: '**/*.vue',
+  outDir: 'docs',
+};