feat(ci): add new ci parameter and new result box

closes #31
ph1p · Aug 3, 2020 · 62a26a9 · 62a26a9
1 parent 7367a9a
commit 62a26a9
Show file tree

Hide file tree

Showing 10 changed files with 160 additions and 182 deletions.
diff --git a/.github/workflows/test-and-publish.yml b/.github/workflows/test-and-publish.yml
@@ -26,7 +26,6 @@ jobs:
           npm test
 
   release:
-    if: github.event.base_ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     needs: test
     steps:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,195 +1,123 @@
 # [1.8.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.8.0...v1.8.1) (2019-08-28)
 
-
-
 # [1.8.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.7.3...v1.8.0) (2019-08-15)
 
-
-
 ## [1.7.3](https://github.com/ph1p/vuepress-jsdoc/compare/v1.7.2...v1.7.3) (2019-05-30)
 
-
-
 ## [1.7.2](https://github.com/ph1p/vuepress-jsdoc/compare/v1.7.1...v1.7.2) (2019-04-23)
 
-
-
 ## [1.7.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.7.0...v1.7.1) (2019-04-23)
 
-
-
 # [1.7.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.6.0...v1.7.0) (2019-04-02)
 
-
 ### Features
 
-* **headline:** add ability to use custom headline ([8aa34d1](https://github.com/ph1p/vuepress-jsdoc/commit/8aa34d1)), closes [#14](https://github.com/ph1p/vuepress-jsdoc/issues/14)
-
-
+- **headline:** add ability to use custom headline ([8aa34d1](https://github.com/ph1p/vuepress-jsdoc/commit/8aa34d1)), closes [#14](https://github.com/ph1p/vuepress-jsdoc/issues/14)
 
 # [1.6.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.5.0...v1.6.0) (2019-02-25)
 
-
 ### Bug Fixes
 
-* **title:** do not add duplicate header for vuedoc.md parsed files ([#16](https://github.com/ph1p/vuepress-jsdoc/issues/16)) ([b1d267c](https://github.com/ph1p/vuepress-jsdoc/commit/b1d267c))
-
+- **title:** do not add duplicate header for vuedoc.md parsed files ([#16](https://github.com/ph1p/vuepress-jsdoc/issues/16)) ([b1d267c](https://github.com/ph1p/vuepress-jsdoc/commit/b1d267c))
 
 ### Features
 
-* **changelog:** add changelog and update dependencies ([6e92f5c](https://github.com/ph1p/vuepress-jsdoc/commit/6e92f5c))
-* **cli:** allow to specify multiple rm patterns ([#15](https://github.com/ph1p/vuepress-jsdoc/issues/15)) ([67a059a](https://github.com/ph1p/vuepress-jsdoc/commit/67a059a))
-
-
+- **changelog:** add changelog and update dependencies ([6e92f5c](https://github.com/ph1p/vuepress-jsdoc/commit/6e92f5c))
+- **cli:** allow to specify multiple rm patterns ([#15](https://github.com/ph1p/vuepress-jsdoc/issues/15)) ([67a059a](https://github.com/ph1p/vuepress-jsdoc/commit/67a059a))
 
 # [1.5.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.4.1...v1.5.0) (2019-02-24)
 
-
 ### Features
 
-* **title:** add title to every page ([6fa477a](https://github.com/ph1p/vuepress-jsdoc/commit/6fa477a)), closes [#14](https://github.com/ph1p/vuepress-jsdoc/issues/14)
-
-
+- **title:** add title to every page ([6fa477a](https://github.com/ph1p/vuepress-jsdoc/commit/6fa477a)), closes [#14](https://github.com/ph1p/vuepress-jsdoc/issues/14)
 
 ## [1.4.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.4.0...v1.4.1) (2019-02-18)
 
-
 ### Bug Fixes
 
-* **eslint:** fix eslint warning ([bbe7a0e](https://github.com/ph1p/vuepress-jsdoc/commit/bbe7a0e))
-
+- **eslint:** fix eslint warning ([bbe7a0e](https://github.com/ph1p/vuepress-jsdoc/commit/bbe7a0e))
 
 ### Features
 
-* **eslint:** add eslint and fix eslint errors ([f864002](https://github.com/ph1p/vuepress-jsdoc/commit/f864002))
-* **jsx/tsx:** add ability to document .jsx and .tsx (React JSX) files ([#11](https://github.com/ph1p/vuepress-jsdoc/issues/11)) ([db628ce](https://github.com/ph1p/vuepress-jsdoc/commit/db628ce))
-
-
+- **eslint:** add eslint and fix eslint errors ([f864002](https://github.com/ph1p/vuepress-jsdoc/commit/f864002))
+- **jsx/tsx:** add ability to document .jsx and .tsx (React JSX) files ([#11](https://github.com/ph1p/vuepress-jsdoc/issues/11)) ([db628ce](https://github.com/ph1p/vuepress-jsdoc/commit/db628ce))
 
 # [1.4.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.3.1...v1.4.0) (2019-02-15)
 
-
 ### Features
 
-* **jsdoc-config:** add new cli argument to set path to jsdoc config (experimental) ([0f25e8c](https://github.com/ph1p/vuepress-jsdoc/commit/0f25e8c))
-
-
+- **jsdoc-config:** add new cli argument to set path to jsdoc config (experimental) ([0f25e8c](https://github.com/ph1p/vuepress-jsdoc/commit/0f25e8c))
 
 ## [1.3.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.3.0...v1.3.1) (2019-02-11)
 
-
-
 # [1.3.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.2.2...v1.3.0) (2019-02-02)
 
-
-
 ## [1.2.2](https://github.com/ph1p/vuepress-jsdoc/compare/v1.2.1...v1.2.2) (2019-01-31)
 
-
 ### Bug Fixes
 
-* remove package-lcok ([a4eef2d](https://github.com/ph1p/vuepress-jsdoc/commit/a4eef2d))
-
-
+- remove package-lcok ([a4eef2d](https://github.com/ph1p/vuepress-jsdoc/commit/a4eef2d))
 
 ## [1.2.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.2.0...v1.2.1) (2019-01-31)
 
-
 ### Bug Fixes
 
-* add chalk ([42dcdea](https://github.com/ph1p/vuepress-jsdoc/commit/42dcdea))
-
-
+- add chalk ([42dcdea](https://github.com/ph1p/vuepress-jsdoc/commit/42dcdea))
 
 # [1.2.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.1.1...v1.2.0) (2019-01-31)
 
-
 ### Features
 
-* **delete:** add delete pattern and do not overwrite readme ([e08f4fe](https://github.com/ph1p/vuepress-jsdoc/commit/e08f4fe)), closes [#9](https://github.com/ph1p/vuepress-jsdoc/issues/9)
-
-
+- **delete:** add delete pattern and do not overwrite readme ([e08f4fe](https://github.com/ph1p/vuepress-jsdoc/commit/e08f4fe)), closes [#9](https://github.com/ph1p/vuepress-jsdoc/issues/9)
 
 ## [1.1.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.1.0...v1.1.1) (2019-01-30)
 
-
-
 # [1.1.0](https://github.com/ph1p/vuepress-jsdoc/compare/v1.0.3...v1.1.0) (2019-01-29)
 
-
 ### Features
 
-* **exclude:** add pattern to exclude files ([e13117b](https://github.com/ph1p/vuepress-jsdoc/commit/e13117b))
-
-
+- **exclude:** add pattern to exclude files ([e13117b](https://github.com/ph1p/vuepress-jsdoc/commit/e13117b))
 
 ## [1.0.3](https://github.com/ph1p/vuepress-jsdoc/compare/v1.0.2...v1.0.3) (2019-01-28)
 
-
 ### Bug Fixes
 
-* **children:** Filter undefined children ([0afdd41](https://github.com/ph1p/vuepress-jsdoc/commit/0afdd41))
-
-
+- **children:** Filter undefined children ([0afdd41](https://github.com/ph1p/vuepress-jsdoc/commit/0afdd41))
 
 ## [1.0.2](https://github.com/ph1p/vuepress-jsdoc/compare/v1.0.1...v1.0.2) (2019-01-25)
 
-
-
 ## [1.0.1](https://github.com/ph1p/vuepress-jsdoc/compare/v1.0.0...v1.0.1) (2018-12-18)
 
-
-
 # [1.0.0](https://github.com/ph1p/vuepress-jsdoc/compare/v0.3.0...v1.0.0) (2018-12-18)
 
-
 ### Features
 
-* **readme:** add ability to add a custom readme ([7b5b1ce](https://github.com/ph1p/vuepress-jsdoc/commit/7b5b1ce))
-
-
+- **readme:** add ability to add a custom readme ([7b5b1ce](https://github.com/ph1p/vuepress-jsdoc/commit/7b5b1ce))
 
 # [0.3.0](https://github.com/ph1p/vuepress-jsdoc/compare/v0.2.1...v0.3.0) (2018-12-03)
 
-
 ### Bug Fixes
 
-* **hook:** fix git pre-commit hook ([341831e](https://github.com/ph1p/vuepress-jsdoc/commit/341831e))
-
-
+- **hook:** fix git pre-commit hook ([341831e](https://github.com/ph1p/vuepress-jsdoc/commit/341831e))
 
 ## [0.2.1](https://github.com/ph1p/vuepress-jsdoc/compare/v0.2.0...v0.2.1) (2018-11-30)
 
-
 ### Bug Fixes
 
-* **parser:** fix bug in parser and update example ([78cbbaf](https://github.com/ph1p/vuepress-jsdoc/commit/78cbbaf))
-
-
+- **parser:** fix bug in parser and update example ([78cbbaf](https://github.com/ph1p/vuepress-jsdoc/commit/78cbbaf))
 
 # [0.2.0](https://github.com/ph1p/vuepress-jsdoc/compare/v0.1.3...v0.2.0) (2018-11-30)
 
-
 ### Features
 
-* **comment:** add a ability to add custom met data and fix a bug when parsing index.js files ([30ec64e](https://github.com/ph1p/vuepress-jsdoc/commit/30ec64e)), closes [#2](https://github.com/ph1p/vuepress-jsdoc/issues/2)
-
-
+- **comment:** add a ability to add custom met data and fix a bug when parsing index.js files ([30ec64e](https://github.com/ph1p/vuepress-jsdoc/commit/30ec64e)), closes [#2](https://github.com/ph1p/vuepress-jsdoc/issues/2)
 
 ## [0.1.3](https://github.com/ph1p/vuepress-jsdoc/compare/v0.1.2...v0.1.3) (2018-11-29)
 
-
-
 ## [0.1.2](https://github.com/ph1p/vuepress-jsdoc/compare/v0.1.1...v0.1.2) (2018-08-20)
 
-
-
 ## [0.1.1](https://github.com/ph1p/vuepress-jsdoc/compare/v0.1.0...v0.1.1) (2018-08-20)
 
-
-
 # [0.1.0](https://github.com/ph1p/vuepress-jsdoc/compare/v0.0.2...v0.1.0) (2018-08-20)
 
-
-
 ## 0.0.2 (2018-04-29)
diff --git a/README.md b/README.md
@@ -32,19 +32,20 @@ If no command passed it will run `generate` as default
 
 ### Options
 
-| Name              | Alias | Default         | Description                                                                             |
-| ----------------- | ----- | --------------- | --------------------------------------------------------------------------------------- |
-| --source          | -s    | ./src           | Source folder with .js or .ts files                                                     |
-| --dist            | -d    | ./documentation | Destination folder                                                                      |
-| --folder          | -f    | ./code          | Folder inside destination folder. Gets overwritten everytime                            |
-| --title           | -t    | API             | Title of your documentation                                                             |
-| --help            | -h    |                 | Show help                                                                               |
-| --version         | -v    |                 | Show current version                                                                    |
-| --readme          | -r    |                 | Path to custom readme file                                                              |
-| --exclude         | -e    |                 | Pattern to exclude files/folders (Comma seperated) - \*.test.js,exclude.js              |
-| --rmPattern       | -rm   |                 | Pattern when removing files. You can ex- and include files. (glob pattern)              |
-| --partials | -p    |                 | jsdoc2markdown partial templates (overwrites default ones) |
-| --jsDocConfigPath | -c    |                 | Path to [JsDoc Config](http://usejsdoc.org/about-configuring-jsdoc.html) (experimental) |
+| Name              | Alias | Default         | Description                                                                                                                                           |
+| ----------------- | ----- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| --source          | -s    | ./src           | Source folder with .js or .ts files                                                                                                                   |
+| --dist            | -d    | ./documentation | Destination folder                                                                                                                                    |
+| --folder          | -f    | ./code          | Folder inside destination folder. Gets overwritten everytime                                                                                          |
+| --title           | -t    | API             | Title of your documentation                                                                                                                           |
+| --help            | -h    |                 | Show help                                                                                                                                             |
+| --version         | -v    |                 | Show current version                                                                                                                                  |
+| --readme          | -r    |                 | Path to custom readme file                                                                                                                            |
+| --exclude         | -e    |                 | Pattern to exclude files/folders (Comma seperated) - \*.test.js,exclude.js                                                                            |
+| --rmPattern       | -rm   |                 | Pattern when removing files. You can ex- and include files. (glob pattern)                                                                            |
+| --partials        | -p    |                 | jsdoc2markdown partial templates (overwrites default ones)                                                                                            |
+| --jsDocConfigPath | -c    |                 | Path to [JsDoc Config](http://usejsdoc.org/about-configuring-jsdoc.html) (experimental)                                                               |
+| --ci              | -     | false           | Set this for your continuous integration tool. This causes errors to be thrown and not ignored. You can also use the global env variable `CI` instead |
 
 ### config.js
 
@@ -79,30 +80,30 @@ Create a `.vuepress` folder inside the `documentation` folder and add the follow
 
 ```javascript
 // auto generated sidebar
-const { sidebarTree } = require("../code/config");
+const { sidebarTree } = require('../code/config');
 
 module.exports = {
-  dest: "dist",
+  dest: 'dist',
   locales: {
-    "/": {
-      title: "vuepress-jsdoc",
-      description: "Generate jsdoc markdown files for vuepress"
+    '/': {
+      title: 'vuepress-jsdoc',
+      description: 'Generate jsdoc markdown files for vuepress'
     }
   },
   themeConfig: {
     editLinks: true,
     sidebarDepth: 4,
-    docsDir: "code",
+    docsDir: 'code',
     locales: {
-      "/": {
+      '/': {
         nav: [
           {
-            text: "Home",
-            link: "/"
+            text: 'Home',
+            link: '/'
           }
         ],
         // Add the generated sidebar
-        sidebar: Object.assign({}, sidebarTree("Mainpage title"))
+        sidebar: Object.assign({}, sidebarTree('Mainpage title'))
       }
     }
   }
@@ -119,7 +120,7 @@ If you want it to be overwritten, set `--rmPattern=./documentation/code/README.m
 
 ## @vuepress comment block
 
-You can add custom meta data your pages by using the `@vuepress` block:
+You can add custom meta data to your pages by using the `@vuepress` block:
 
 ```javascript
 /*
@@ -170,4 +171,4 @@ yarn build
 
 ## Contribute
 
-PRs are always welcome (:
+PRs are always welcome (:
diff --git a/tests/comment-parser.test.js → __tests__/comment-parser.test.js b/tests/comment-parser.test.js → __tests__/comment-parser.test.js
diff --git a/tests/sidebar.test.js → __tests__/sidebar.test.js b/tests/sidebar.test.js → __tests__/sidebar.test.js
diff --git a/tests/utils.test.js → __tests__/utils.test.js b/tests/utils.test.js → __tests__/utils.test.js
@@ -1,8 +1,11 @@
 'use strict';
 
-const { checkExtension, getFilename, asyncForEach } = require('../helpers/utils');
+const { checkExtension, getExtension, getFilename, asyncForEach } = require('../helpers/utils');
 
 describe('test utils', () => {
+  test('getExtension should return true', () => {
+    expect(getExtension('./dir/test.jpg')).toBe('.jpg');
+  });
   test('checkExtension should return true', () => {
     expect(checkExtension('./dir/test.jpg', ['.jpg'])).toBe(true);
   });