Skip to content

Commit

Permalink
feat(include): add include flag, fix some bugs and improve performance
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Feb 15, 2022
1 parent 3cdbc8a commit 082a60a
Show file tree
Hide file tree
Showing 14 changed files with 5,884 additions and 5,114 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test-and-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:

strategy:
matrix:
node-version: [14.x, 16.x]
node-version: [14.x, 16.x, 17.x]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-and-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:

strategy:
matrix:
node-version: [14.x, 16.x]
node-version: [14.x, 16.x, 17.x]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/vercel-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:

strategy:
matrix:
node-version: [14.x, 16.x]
node-version: [14.x, 16.x, 17.x]

steps:
- uses: actions/checkout@v1
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Use these options after `vuepress-jsdoc`.
| --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 [more information](https://github.com/micromatch/micromatch#ismatch) |
| --include | -e | | Pattern to include files/folders (Comma seperated) - \*.test.js,exclude.js [more information](https://github.com/micromatch/micromatch#ismatch) |
| --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) |
Expand Down Expand Up @@ -162,7 +163,7 @@ Use `headline` to add a custom `h1` title.
To use typescript, you have to install these dev-dependencies:

```bash
yarn add -D typescript jsdoc-babel @babel/cli @babel/core @babel/preset-env @babel/preset-typescript jsdoc-to-markdown
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.
Expand Down
6,563 changes: 3,980 additions & 2,583 deletions example/package-lock.json

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "",
"main": "index.js",
"scripts": {
"docs": "../bin/vuepress-jsdoc.js --jsDocConfigPath ./jsdoc.json --source=./src --dist=./documentation --title=API --exclude=class.js --partials=./partials/*.hbs --readme=./README.md",
"docs": "../bin/vuepress-jsdoc.js --jsDocConfigPath=jsdoc.json --source=./src --dist=./documentation --title=API --exclude=class.js --partials=./partials/*.hbs --readme=./README.md",
"docs:dev": "npm run docs -- --watch",
"dev": "npm run docs && vuepress dev documentation",
"build:local": "npm run docs && vuepress build documentation",
Expand All @@ -14,17 +14,17 @@
"author": "",
"license": "ISC",
"dependencies": {
"vuepress": "^1.8.2"
"vuepress": "^1.9.7"
},
"devDependencies": {
"@babel/cli": "^7.16.0",
"@babel/core": "^7.16.0",
"@babel/plugin-proposal-class-properties": "^7.16.0",
"@babel/preset-env": "^7.16.4",
"@babel/preset-typescript": "^7.16.0",
"concurrently": "^6.4.0",
"@babel/cli": "^7.17.3",
"@babel/core": "^7.17.3",
"@babel/plugin-proposal-class-properties": "^7.16.7",
"@babel/preset-env": "^7.16.11",
"@babel/preset-typescript": "^7.16.7",
"concurrently": "^7.0.0",
"jsdoc-babel": "^0.5.0",
"jsdoc-to-markdown": "^7.1.0",
"typescript": "^4.4.4"
"jsdoc-to-markdown": "^7.1.1",
"typescript": "^4.5.5"
}
}
Loading

0 comments on commit 082a60a

Please sign in to comment.