vuepress-jsdoc 4.3.0 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
+## 5.0.0 (2023-11-23)
+
+* feat(vuepress): switch to vuepress 2 ([351af08](https://github.com/ph1p/vuepress-jsdoc/commit/351af08))
+* build(deps): update dependencies ([2e85188](https://github.com/ph1p/vuepress-jsdoc/commit/2e85188))
+* build(deps): update example ([c9529fe](https://github.com/ph1p/vuepress-jsdoc/commit/c9529fe))
+* build(workflow): set node 16 in github action ([4822a0a](https://github.com/ph1p/vuepress-jsdoc/commit/4822a0a))
+* Make sidebar config compatible with Vuepress 2 ([592a7b5](https://github.com/ph1p/vuepress-jsdoc/commit/592a7b5))
+* Wait for async `extractConfig()` call to complete ([6ddb19f](https://github.com/ph1p/vuepress-jsdoc/commit/6ddb19f))
+
+
+### BREAKING CHANGE
+
+* no vuepress 1 support anymore, drop older node versions
+
+Switch from chalk to kleur
+Fix some bugs
+
+
+## <small>4.3.1 (2022-10-06)</small>
+
+* 4.3.1 ([8b596fb](https://github.com/ph1p/vuepress-jsdoc/commit/8b596fb))
+* build(deps): update dependencies and fix an npm script ([82a5b93](https://github.com/ph1p/vuepress-jsdoc/commit/82a5b93))
+* build(deps): update dependencies and rename success to include ([dd5b6c4](https://github.com/ph1p/vuepress-jsdoc/commit/dd5b6c4))
+* chore: audit example dependencies ([21823a1](https://github.com/ph1p/vuepress-jsdoc/commit/21823a1))
+* chore: drop node 14 ([ae30caf](https://github.com/ph1p/vuepress-jsdoc/commit/ae30caf))
+* chore: remove unused import ([a52a31e](https://github.com/ph1p/vuepress-jsdoc/commit/a52a31e))
+
+
+
 ## 4.3.0 (2022-02-15)
 
+* 4.3.0 ([18a9a6a](https://github.com/ph1p/vuepress-jsdoc/commit/18a9a6a))
 * feat(include): add include flag, fix some bugs and improve performance ([082a60a](https://github.com/ph1p/vuepress-jsdoc/commit/082a60a))
 
 

package/README.md

@@ -4,10 +4,14 @@
 [![npm](https://img.shields.io/npm/v/vuepress-jsdoc.svg)](https://www.npmjs.com/package/vuepress-jsdoc)
 [![vercel](https://img.shields.io/badge/vercel-demo-black)](https://vuepress-jsdoc-example.vercel.app)
 
-This npm package is a command line script, which scans your JavaScript, Vue or Typescript source code and generates markdown files for vuepress with the help of [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) and [vue-docgen-cli](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-cli).
+This npm package serves as a command line script designed to analyze your JavaScript, Vue, or TypeScript source code. Leveraging [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) and [vue-docgen-cli](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-cli), it dynamically generates markdown files tailored for VuePress.
 
 ![CLI ./example](https://user-images.githubusercontent.com/15351728/131877824-0124e47f-9080-4976-88d0-84ad04b64f24.gif)
 
+## Vuepress support
+
+This npm package is compatible with VuePress 2; however, it requires a version lower than `5.0.0` for proper functionality with VuePress 1.
+
 ## How to
 
 ```bash
@@ -24,29 +28,6 @@ vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API -
 
 You can also use `npx vuepress-jsdoc`, if you want.
 
-#### Plugin (Dev-Mode) `alpha`
-
-You can use `vuepress-jsdoc` also as plugin.
-This plugin watches you generated files.
-
-```javascript
-// ./documentation/.vuepress/config.js
-plugins: [
-  [
-    require('vuepress-jsdoc').default,
-    {
-      folder: 'code',
-      source: './dist',
-      dist: './documentation',
-      title: 'API',
-      partials: ['./example/partials/*.hbs'],
-      readme: './README.md',
-      exclude: '**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*'
-    }
-  ]
-];
-```
-
 #### Watch-Mode `alpha`
 
 If you do not want to run`vuepress-jsdoc` again and again and again.
@@ -137,12 +118,13 @@ module.exports = {
 
 ## Custom readme
 
-You can easily add a custom path to your readme by using the `--readme ./path/to/file.md` parameter. If you move a `README.md` inside your source folder, it should resolve it automatically.
-You can set the title by passing it to the `sidebarTree('Mainpage title')` function inside your `./.vuepress/config.js`.
+To include a custom path for your readme, simply utilize the `--readme ./path/to/file.md` parameter. If you relocate a `README.md` file into your source folder, the system will automatically resolve it.
+
+For setting the title, provide it as an argument to the `sidebarTree('Mainpage title')` function within your `./.vuepress/config.js` file.
 
 ## @vuepress comment block
 
-You can add custom meta data to your pages by using the `@vuepress` block:
+Enhance your page customization by incorporating custom metadata through the `@vuepress` block:
 
 ```javascript
 /*
@@ -160,15 +142,13 @@ Use `headline` to add a custom `h1` title.
 
 ## Typescript
 
-To use typescript, you have to install these dev-dependencies:
+To integrate TypeScript support, install the following dev-dependencies with the following command:
 
 ```bash
 npm install -D typescript jsdoc-babel @babel/cli @babel/core @babel/preset-env @babel/preset-typescript jsdoc-to-markdown
 ```
 
-Next, you have to add a `jsdoc.json` to your project with some settings and add it with the `-c` parameter.
-You can find a full working example with all settings inside the `./example` folder.
-The example shows also how to use babel-`plugins`.
+After installation, include a `jsdoc.json` file in your project with specific settings, and reference it using the `-c` parameter. For a comprehensive example with all the necessary configurations, refer to the `./example` folder. The example also demonstrates the usage of Babel plugins.
 
 ## Example
 

package/dist/cmds.d.ts

@@ -1,8 +1,8 @@
-declare const _default: (version: string) => void;
 /**
  * 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
  */
+declare const _default: (version: string) => void;
 export default _default;

package/dist/cmds.js

@@ -6,15 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * headline: cmds.ts
  * ---
  */
-var commander_1 = require("commander");
-var _1 = require(".");
+const commander_1 = require("commander");
+const _1 = require(".");
 /**
  * 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
  */
-exports.default = (function (version) {
+exports.default = (version) => {
     commander_1.program.version(version).description('a CLI Tool to generate markdown files for vuepress');
     commander_1.program
         .description('Generate the md files')
@@ -31,4 +31,4 @@ exports.default = (function (version) {
         .option('-c, --jsDocConfigPath <string>', 'Path to jsdoc config')
         .action(_1.generate);
     commander_1.program.parse(process.argv);
-});
+};

package/dist/constants.d.ts

@@ -1,6 +1,6 @@
 export declare enum StatisticType {
     EMPTY = "EMPTY",
     ERROR = "ERROR",
-    SUCCESS = "SUCCESS",
+    INCLUDE = "INCLUDE",
     EXCLUDE = "EXCLUDE"
 }

package/dist/constants.js

@@ -5,6 +5,6 @@ var StatisticType;
 (function (StatisticType) {
     StatisticType["EMPTY"] = "EMPTY";
     StatisticType["ERROR"] = "ERROR";
-    StatisticType["SUCCESS"] = "SUCCESS";
+    StatisticType["INCLUDE"] = "INCLUDE";
     StatisticType["EXCLUDE"] = "EXCLUDE";
-})(StatisticType = exports.StatisticType || (exports.StatisticType = {}));
+})(StatisticType || (exports.StatisticType = StatisticType = {}));

package/dist/index.d.ts

@@ -5,13 +5,7 @@ import { CLIArguments } from './interfaces';
  */
 export declare const generate: (argv: CLIArguments) => Promise<void>;
 /**
- * The vuepress plugins
+ * Watch files in source folder
  * @param {CLIArguments} argv
- * @param {object} ctx
- * @returns {object}
  */
-declare const plugin: (argv: CLIArguments, ctx: any) => {
-    name: string;
-    ready: () => Promise<void>;
-};
-export default plugin;
+export declare const watchFiles: (argv: CLIArguments) => void;