chore: update dependencies and documentation

Author: ph1p

example/package-lock.json

@@ -17,14 +17,14 @@
     "vuepress": "^1.8.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.5",
     "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/preset-env": "^7.15.0",
+    "@babel/preset-env": "^7.15.6",
     "@babel/preset-typescript": "^7.15.0",
     "concurrently": "^6.2.1",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-to-markdown": "^7.0.1",
-    "typescript": "^4.4.2"
+    "typescript": "^4.4.3"
   }
 }

example/package.json

@@ -13,8 +13,8 @@
     "prepublishOnly": "npm i && npm run build",
     "prepare": "husky install",
     "version": "conventional-changelog -p karma -i CHANGELOG.md -s -r 0 && git add .",
-    "docs": "npx vuepress-jsdoc --source=./dist --partials=./example/partials/*.hbs --readme ./README.md --exclude=\"**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*\"",
-    "docs:dev": "npm run docs && npx vuepress dev documentation",
+    "docs": "./bin/vuepress-jsdoc.js --source=./dist --partials=./example/partials/*.hbs --readme ./README.md --exclude=\"**/*.d.ts,**/interfaces.*,**/constants.*\"",
+    "docs:dev": "npx concurrently --kill-others \"npm run dev\" \"npm run docs && npx vuepress dev documentation\"",
     "docs:build": "npm run build && npm run docs && npx vuepress build documentation"
   },
   "keywords": [
@@ -81,34 +81,34 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "chokidar": "^3.5.2",
-    "commander": "^8.1.0",
+    "commander": "^8.2.0",
     "del": "^6.0.0",
     "front-matter": "^4.0.2",
     "jsdoc-to-markdown": "^7.0.1",
     "micromatch": "^4.0.4",
     "mkdirp": "^1.0.4",
-    "vue-docgen-cli": "^4.41.1"
+    "vue-docgen-cli": "^4.41.2"
   },
   "devDependencies": {
     "@types/jest": "^27.0.1",
     "@types/jsdoc-to-markdown": "^7.0.1",
     "@types/micromatch": "^4.0.2",
     "@types/mkdirp": "^1.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.30.0",
-    "@typescript-eslint/parser": "^4.30.0",
-    "babel-jest": "^27.1.0",
+    "@typescript-eslint/eslint-plugin": "^4.31.1",
+    "@typescript-eslint/parser": "^4.31.1",
+    "babel-jest": "^27.2.0",
     "cross-env": "^7.0.3",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-jest": "^24.4.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "husky": "^7.0.2",
-    "jest": "^27.1.0",
+    "jest": "^27.2.0",
     "lint-staged": "^11.1.2",
-    "memfs": "^3.2.3",
+    "memfs": "^3.3.0",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.4.2"
+    "typescript": "^4.4.3"
   },
   "lint-staged": {
     "src/**/*.{css,scss,json}": [

package-lock.json

@@ -1,7 +1,19 @@
+/*
+ * @vuepress
+ * ---
+ * headline: cmds.ts
+ * ---
+ */
 import { program } from 'commander';
 
 import { generate } from '.';
 
+/**
+ * This method builds the cli interface and is necessary because
+ * we need the version from the package.json here. We do not import
+ * this here, because otherwise the folder structure in the dist folder would get mixed up.
+ * @param {string} version a version string
+ */
 export default (version: string) => {
   program.version(version).description('a CLI Tool to generate markdown files for vuepress');
 

package.json

@@ -21,7 +21,7 @@ import { generateVueSidebar } from './lib/vue-sidebar';
 
 /**
  * Create the sidebar
- * @param options {object}
+ * @param {object} options
  * @returns {Promise}
  */
 const createVuepressSidebar = options =>
@@ -37,8 +37,8 @@ const createVuepressSidebar = options =>
 
 /**
  * Parse file
- * @param file {DirectoryFile}
- * @param argv {CLIArguments}
+ * @param {DirectoryFile} file
+ * @param {CLIArguments} argv
  * @returns {Promise}
  */
 const parseDirectoryFile = async (file: DirectoryFile, argv: CLIArguments) => {
@@ -59,6 +59,12 @@ const parseDirectoryFile = async (file: DirectoryFile, argv: CLIArguments) => {
   }
 };
 
+/**
+ * Create the readme file. First page when entering the documentation.
+ * @param {CLIArguments} argv
+ * @param {string} deletedPaths
+ * @returns {void}
+ */
 const createReadmeFile = async (argv: CLIArguments, deletedPaths?: string[]) => {
   const { srcFolder, codeFolder, docsFolder, title, readme } = parseArguments(argv);
 
@@ -83,7 +89,7 @@ const createReadmeFile = async (argv: CLIArguments, deletedPaths?: string[]) =>
 
 /**
  * Parse all CLI arguments
- * @param argv {CLIArguments}
+ * @param {CLIArguments} argv
  * @returns {object} all arguments
  */
 const parseArguments = (argv: CLIArguments) => {
@@ -189,7 +195,7 @@ export const generate = async (argv: CLIArguments) => {
 
 /**
  * Watch files in source folder
- * @param argv {CLIArguments}
+ * @param {CLIArguments} argv
  */
 const watchFiles = (argv: CLIArguments) => {
   const { exclude, srcFolder, codeFolder, docsFolder, title } = parseArguments(argv);
@@ -234,8 +240,8 @@ const watchFiles = (argv: CLIArguments) => {
 
 /**
  * The vuepress plugins
- * @param argv {CLIArguments}
- * @param ctx {object}
+ * @param {CLIArguments} argv
+ * @param {object} ctx
  * @returns {object}
  */
 const plugin = (argv: CLIArguments, ctx) => ({

src/cmds.ts

@@ -10,7 +10,7 @@ import { DirectoryFile } from '../interfaces';
 
 /**
  * Search in file for @vuepress comment
- * @param fileContent {string} content of given file
+ * @param {string} fileContent content of given file
  * @returns {object} object of found frontmatter data
  */
 export const parseComment = (fileContent: string) => {
@@ -46,8 +46,8 @@ export const parseComment = (fileContent: string) => {
 
 /**
  * Helper function to get header as structured markdown
- * @param content {string} file content
- * @param file {object} file object
+ * @param {string} content file content
+ * @param {object} file file object
  * @returns {string} markdown header
  */
 export const parseVuepressFileHeader = (content: string, file: DirectoryFile) => {

src/index.ts

@@ -12,10 +12,10 @@ import { DirectoryFile, FileTree } from '../interfaces';
 
 /**
  * Recursively traverse folders and return exluded files, a file list and a file tree.
- * @param srcPath {string} path to source dir
- * @param exclude {array} exluded file patter list
- * @param mainPath {string} path to hold source dir
- * @param tree {object} tree array
+ * @param {string} srcPath path to source dir
+ * @param {array} exclude exluded file patter list
+ * @param {string} mainPath path to hold source dir
+ * @param {object} tree tree array
  * @returns {object} paths array, tree, excluded array
  */
 export const listFolder = async (srcPath: string, exclude: string[] = [], mainPath?: string, tree: FileTree[] = []) => {

src/lib/comment-parser.ts

@@ -91,9 +91,9 @@ export const parseFile = async (
 
 /**
  * Parse a vue file
- * @param file {DirectoryFile}
- * @param srcFolder {string}
- * @param destFolder {string}
+ * @param {DirectoryFile} file
+ * @param {string} srcFolder
+ * @param {string} destFolder
  * @returns {object} file data
  */
 export const parseVueFile = async (
@@ -153,8 +153,8 @@ export const parseVueFile = async (
 
 /**
  * Write content on disk
- * @param parseData {ParseReturn | null}
- * @param dest {string}
+ * @param {ParseReturn | null} parseData
+ * @param {string} dest
  * @returns {Promise | null} null or type with some data of the saved file
  */
 export const writeContentToFile = async (parseData: ParseReturn | null, dest: string) => {

src/lib/list-folder.ts

@@ -6,22 +6,22 @@
  */
 /**
  * Get extension of file
- * @param path {string}
+ * @param {string} path
  * @returns {string} extension of file
  */
 export const getExtension = (path: string) => path.substring(path.length, path.lastIndexOf('.'));
 
 /**
  * Check if extension ist correct
- * @param path {string}
- * @param extensions {string[]}
+ * @param {string} path
+ * @param {string[]} extensions
  * @returns {boolean}
  */
 export const checkExtension = (path: string, extensions: string[]) => extensions.indexOf(getExtension(path)) >= 0;
 
 /**
  * Get filename without extension
- * @param path {string}
+ * @param {string} path
  * @returns {string} filename
  */
 export const getFilename = (path: string) =>