vuepress-jsdoc 4.3.0 → 4.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
+ ## <small>4.3.1 (2022-10-06)</small>
2
+
3
+ * build(deps): update dependencies and fix an npm script ([78a6e83](https://github.com/ph1p/vuepress-jsdoc/commit/78a6e83))
4
+ * build(deps): update dependencies and rename success to include ([dd5b6c4](https://github.com/ph1p/vuepress-jsdoc/commit/dd5b6c4))
5
+ * chore: audit example dependencies ([21823a1](https://github.com/ph1p/vuepress-jsdoc/commit/21823a1))
6
+ * chore: drop node 14 ([ae30caf](https://github.com/ph1p/vuepress-jsdoc/commit/ae30caf))
7
+ * chore: remove unused import ([a52a31e](https://github.com/ph1p/vuepress-jsdoc/commit/a52a31e))
8
+
9
+
10
+
1
11
  ## 4.3.0 (2022-02-15)
2
12
 
13
+ * 4.3.0 ([18a9a6a](https://github.com/ph1p/vuepress-jsdoc/commit/18a9a6a))
3
14
  * feat(include): add include flag, fix some bugs and improve performance ([082a60a](https://github.com/ph1p/vuepress-jsdoc/commit/082a60a))
4
15
 
5
16
 
package/dist/cmds.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- declare const _default: (version: string) => void;
2
1
  /**
3
2
  * This method builds the cli interface and is necessary because
4
3
  * we need the version from the package.json here. We do not import
5
4
  * this here, because otherwise the folder structure in the dist folder would get mixed up.
6
5
  * @param {string} version a version string
7
6
  */
7
+ declare const _default: (version: string) => void;
8
8
  export default _default;
@@ -1,6 +1,6 @@
1
1
  export declare enum StatisticType {
2
2
  EMPTY = "EMPTY",
3
3
  ERROR = "ERROR",
4
- SUCCESS = "SUCCESS",
4
+ INCLUDE = "INCLUDE",
5
5
  EXCLUDE = "EXCLUDE"
6
6
  }
package/dist/constants.js CHANGED
@@ -5,6 +5,6 @@ var StatisticType;
5
5
  (function (StatisticType) {
6
6
  StatisticType["EMPTY"] = "EMPTY";
7
7
  StatisticType["ERROR"] = "ERROR";
8
- StatisticType["SUCCESS"] = "SUCCESS";
8
+ StatisticType["INCLUDE"] = "INCLUDE";
9
9
  StatisticType["EXCLUDE"] = "EXCLUDE";
10
10
  })(StatisticType = exports.StatisticType || (exports.StatisticType = {}));
package/dist/index.js CHANGED
@@ -292,7 +292,7 @@ var generate = function (argv) { return __awaiter(void 0, void 0, void 0, functi
292
292
  if (!entry.file)
293
293
  continue;
294
294
  color = (_p = {},
295
- _p[constants_1.StatisticType.SUCCESS] = 'green',
295
+ _p[constants_1.StatisticType.INCLUDE] = 'green',
296
296
  _p[constants_1.StatisticType.ERROR] = 'red',
297
297
  _p[constants_1.StatisticType.EMPTY] = 'yellow',
298
298
  _p[constants_1.StatisticType.EXCLUDE] = 'blue',
@@ -8,7 +8,7 @@ import { DirectoryFile, FileTree } from '../interfaces';
8
8
  * @param {object} tree tree array
9
9
  * @returns {object} paths array, tree, excluded array
10
10
  */
11
- export declare const listFolder: (srcPath: string, exclude: string[], include: string[], mainPath?: string | undefined, tree?: FileTree[]) => Promise<{
11
+ export declare const listFolder: (srcPath: string, exclude: string[], include: string[], mainPath?: string, tree?: FileTree[]) => Promise<{
12
12
  paths: DirectoryFile[];
13
13
  tree: FileTree[];
14
14
  excluded: DirectoryFile[];
@@ -252,7 +252,7 @@ var writeContentToFile = function (parseData, dest) { return __awaiter(void 0, v
252
252
  return [4 /*yield*/, promises_1.default.writeFile(path, parseData.content, 'utf-8')];
253
253
  case 3:
254
254
  _b.sent();
255
- type = (parseData === null || parseData === void 0 ? void 0 : parseData.empty) ? constants_1.StatisticType.EMPTY : constants_1.StatisticType.SUCCESS;
255
+ type = (parseData === null || parseData === void 0 ? void 0 : parseData.empty) ? constants_1.StatisticType.EMPTY : constants_1.StatisticType.INCLUDE;
256
256
  _b.label = 4;
257
257
  case 4: return [2 /*return*/, __assign(__assign({}, parseData), { type: type })];
258
258
  case 5:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vuepress-jsdoc",
3
- "version": "4.3.0",
3
+ "version": "4.3.1",
4
4
  "description": "Generate jsdoc markdown files for vuepress",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -14,7 +14,7 @@
14
14
  "prepare": "husky install",
15
15
  "version": "conventional-changelog -p karma -i CHANGELOG.md -s -r 0 && git add .",
16
16
  "docs": "./bin/vuepress-jsdoc.js --source=./dist --partials=./example/partials/*.hbs --readme ./README.md --include=\"**/*.(ts|js)\" --exclude=\"**/*.d.ts,**/interfaces.*,**/constants.*\"",
17
- "docs:dev": "npx concurrently --kill-others \"npm run dev\" \"npm run docs && npx vuepress dev documentation\"",
17
+ "docs:dev": "npx concurrently --kill-others \"npm run dev\" \"npm run docs -- -w\" \"npx vuepress dev documentation\"",
18
18
  "docs:build": "npm run build && npm run docs && npx vuepress build documentation"
19
19
  },
20
20
  "keywords": [
@@ -81,34 +81,35 @@
81
81
  "dependencies": {
82
82
  "chalk": "^4.1.2",
83
83
  "chokidar": "^3.5.3",
84
- "commander": "^9.0.0",
84
+ "commander": "^9.4.1",
85
85
  "del": "^6.0.0",
86
86
  "front-matter": "^4.0.2",
87
87
  "jsdoc-to-markdown": "^7.1.1",
88
- "micromatch": "^4.0.4",
88
+ "micromatch": "^4.0.5",
89
89
  "mkdirp": "^1.0.4",
90
- "vue-docgen-cli": "^4.44.15"
90
+ "vue-docgen-cli": "^4.51.0"
91
91
  },
92
92
  "devDependencies": {
93
- "@types/jest": "^27.4.0",
93
+ "@types/jest": "^29.1.1",
94
94
  "@types/jsdoc-to-markdown": "^7.0.3",
95
95
  "@types/micromatch": "^4.0.2",
96
96
  "@types/mkdirp": "^1.0.2",
97
- "@typescript-eslint/eslint-plugin": "^5.12.0",
98
- "@typescript-eslint/parser": "^5.12.0",
99
- "babel-jest": "^27.5.1",
97
+ "@typescript-eslint/eslint-plugin": "^5.39.0",
98
+ "@typescript-eslint/parser": "^5.39.0",
99
+ "babel-jest": "^29.1.2",
100
100
  "cross-env": "^7.0.3",
101
- "eslint": "^8.9.0",
102
- "eslint-config-prettier": "^8.3.0",
103
- "eslint-plugin-import": "^2.25.4",
104
- "eslint-plugin-jest": "^26.1.1",
101
+ "eslint": "^8.24.0",
102
+ "eslint-config-prettier": "^8.5.0",
103
+ "eslint-plugin-import": "^2.26.0",
104
+ "eslint-plugin-jest": "^27.1.1",
105
105
  "eslint-plugin-prefer-arrow": "^1.2.3",
106
- "husky": "^7.0.4",
107
- "jest": "^27.5.1",
108
- "lint-staged": "^12.3.4",
109
- "memfs": "^3.4.1",
110
- "ts-jest": "^27.1.3",
111
- "typescript": "^4.5.5"
106
+ "husky": "^8.0.1",
107
+ "jest": "^29.1.2",
108
+ "lint-staged": "^13.0.3",
109
+ "memfs": "^3.4.7",
110
+ "ts-jest": "^29.0.3",
111
+ "typescript": "^4.8.4",
112
+ "vue": "^2.7.8"
112
113
  },
113
114
  "lint-staged": {
114
115
  "src/**/*.{css,scss,json}": [