CHANGELOG.md

5.0.0 (2023-11-23)

• feat(vuepress): switch to vuepress 2 (351af08)
• build(deps): update dependencies (2e85188)
• build(deps): update example (c9529fe)
• build(workflow): set node 16 in github action (4822a0a)
• Make sidebar config compatible with Vuepress 2 (592a7b5)
• Wait for async extractConfig() call to complete (6ddb19f)

BREAKING CHANGE

• no vuepress 1 support anymore, drop older node versions

Switch from chalk to kleur Fix some bugs

4.3.1 (2022-10-06)

• 4.3.1 (8b596fb)
• build(deps): update dependencies and fix an npm script (82a5b93)
• build(deps): update dependencies and rename success to include (dd5b6c4)
• chore: audit example dependencies (21823a1)
• chore: drop node 14 (ae30caf)
• chore: remove unused import (a52a31e)

4.3.0 (2022-02-15)

• 4.3.0 (18a9a6a)
• feat(include): add include flag, fix some bugs and improve performance (082a60a)

4.2.0 (2021-11-17)

• 4.2.0 (3cdbc8a)
• build(deps): update dependencies (858dff8)

4.1.1 (2021-10-05)

• 4.1.1 (975b04f)
• chore(deps): update dependencies (b3ac12c)

4.1.0 (2021-09-20)

• 4.1.0 (ac88980)
• chore: update dependencies and documentation (8e83013)

4.0.4 (2021-09-03)

• 4.0.4 (1452e46)
• refactor: fix some code smells (a910cff)
• docs: fix watch-mode and add more informations (c356bcc)
• docs: remove old informations (1e4f344)
• docs: update documentation (453019f)
• docs: update readme (91bb90b)
• docs(readme): update explanation about readme (5340d78)

4.0.3 (2021-09-02)

• 4.0.3 (f45ec52)
• fix(log): remove log (631a711)
• build: rename workflow and fix command (8e2dfe5)
• docs: update workflow and scripts (88e8f01)
• chore: update ignore files (9c60b4a)

4.0.2 (2021-09-02)

• 4.0.2 (2654a37)
• docs: document vuepress-jsdoc with itself (6c93149)

4.0.1 (2021-09-02)

• test: fix index file (227b46b)
• 4.0.1 (b445b61)
• fix(index): handle index files (a65e631)
• build: remove condition (f59edb3)

4.0.0 (2021-09-02)

• build: drop pinst and replace with npm scripts (fbd03cc)
• build: replace npm i with npm ci (6097456)
• build: update condition (a07bd8f)
• build: update workflow (2e31d33)
• build: update workflow (17df727)
• build: update workflow (f0749ff)
• build: update workflow and npmignore file (5147a6f)
• build: update workflow file (a9f1c17)
• build: update workflows (9218a40)
• build(babel): remove babel config, it is not needed (4406baa)
• build(workflow): update github action files (4200177)
• 4.0.0 (58025eb)
• refactor: add named exports (f3297ac)
• refactor: start to rewrite the code (9001695)
• refactor: update file loop (114d6cf)
• refactor: update watch mode and fix some bugs (7b5debd)
• refactor(parser): exclude file writing (a00ef94)
• refactor(regex): simplify regular expression (413ee2b)
• refactor(smells): fix some code smells (45370ea)
• chore: move and rename some files (53c423d)
• chore: remove vscode folder (4df9d12)
• chore: rename master to main (5e6ea33)
• fix: update build script (71f9bfa)
• fix(ci): comment out config code (1b8870e)
• fix(clearLine): use readline module (9d581e7)
• fix(config): exclude files by jsdoc config (af706c5)
• fix(file): check if file exists (91279bb)
• fix(test): move replacement of filename up (b59411e)
• fix(type): handle empty type (0e2fc24)
• feat(result): print out result of file parsing (c99cf50)
• feat(stdout): start to play around with the log ouput (9edb992)
• feat(tree): add file tree and handle readme correctly (74017df)
• feat(typescript): move to typescript and fix eslint errors (f4d73c8)
• feat(watch): add chokidar to watch files on cli use and enable to watch files as vuepress plugin (c9694a3)
• test: fix and update tests (180e13f)
• test: fix tests (b2a7481)
• test: update tests and add file check in vupress config generator (c1b9e16)
• docs: upload preview gif to github (6143547)

3.7.1 (2021-08-30)

• 3.7.1 (dd6a1d0)
• fix(docgen): remove shell command and import cli module directly (761b7c9)

3.7.0 (2021-08-30)

• build: update node versions (b3624b7)
• build(deps): update package lock (7ae6a05)
• 3.7.0 (16352a8)
• fix(docgen): remove not necessary path and use build-in fs.promises (5e7ba4a), closes #44
• chore: update package lock in example directory (fff7d06)

3.6.0 (2021-08-01)

• 3.6.0 (83e1672)
• fix(eslint): update script (0416c53)
• fix(exclude): remove empty string from exclude array (81e9a71), closes #43

3.5.0 (2021-03-05)

• 3.5.0 (caa632c)
• build(deps): update dependencies (01ded9e)
• chore(build): trigger sonar scan (1fa5cf0)

3.4.1 (2021-02-18)

• 3.4.1 (c249827)
• refactor(husky): update commit hooks (717a5cc)
• fix(stats): add condition to check stats length (afa705b)
• fix(vue): .vue files can be placed in subfolders (bbd40d3)
• chore: switch to npm 7 (f3456ac)
• docs(readme): update demo link (30b0d8f)

3.4.0 (2021-02-14)

• 3.4.0 (c32392f)
• feat(exclude): update pattern check and fix some bugs (5b89547)

3.3.0 (2021-02-14)

• 3.3.0 (a770921)
• build(github): remove unused code (7d1e02f)
• build(github): update workflow (840a521)
• feat(vue): add vue-docgen to support better vue file parsing (787ca8d)
• docs(image): update gif (cc0153e)

3.2.0 (2020-08-04)

• 3.2.0 (8b9c85d)
• feat(error): drop ci command and exit with error code (37d4bd6)

3.1.0 (2020-08-03)

• build(deps): update all dependencies (7367a9a)
• build(example): remove file and switch to npm (73725ac)
• build(node): drop node 8 (cfdbdcd)
• build(workflow): add master condition (d6989d3)
• build(workflow): add missing install (07eb952)
• build(workflow): update workflow file (e06b0c7)
• build(yarn): drop yarn and use npm instead (9ef5c7a)
• chore: release 3.1.0 (31288bb)
• feat(ci): add new ci parameter and new result box (62a26a9), closes #31

3.0.0 (2020-04-09)

• chore: release 2.1.1 (7fdcf99)
• chore: release v3.0.0 (2f28c29)
• feat(partials): add the possibility to change jsdoc2markdown partials (ab158aa)
• feat(typescript): add working typescript example (6db6cb5)
• fix(workflow): update now command (c5c2c73)
• build(deps): bump acorn from 6.4.0 to 6.4.1 in /example (3981b0f)
• build(deps): update dependencies (203d170)
• A newline is needed at the end of this file (ad75e37)

2.0.2 (2019-12-30)

• chore: release 2.0.2 (95f149c)
• fix(parser): fix bug in tags and restructure slots (2812042)

2.0.1 (2019-12-05)

• chore: release 2.0.1 (e509ea8)
• build(deps): update dependencies (ce7cbaa), closes #24
• fix(template): add correct path to partials (219fe25)
• refactor(example): update example files (8759b7c)

2.0.0 (2019-12-01)

• chore: release 2.0.0 (a962893)
• build(demo): add demo link to example vuepress build (dfd3550)
• build(demo): add demo link to example vuepress build (1d3b019)
• build(deps): update dependencies (9339e87)
• build(release-it): add package to release new builds (440345a)
• feat(vue-markdown): drop vuedoc (959c54f)
• feat(workflows): add github actions and update config (68859f3)
• refactor: update doc to markdown (2f891b0)
• 1.8.1 (2c404ca)

1.8.0 (2019-08-15)

• 1.8.0 (1568e30)
• improvement(cli): show path of src file (7f628ff)

1.7.4 (2019-07-26)

• 1.7.4 (73fd9f4)
• build(deps): bump lodash from 4.17.11 to 4.17.14 in /example (4b22ca3)
• build(deps): bump lodash.template from 4.4.0 to 4.5.0 (92c2648)
• build(deps): bump lodash.template from 4.4.0 to 4.5.0 in /example (6de4f9d)
• refactor: remove code and lock file - update dependencies (d604412)
• refactor: update dependencies (c3beca6)

1.7.3 (2019-05-30)

• 1.7.3 (02d6b28)
• refactor: update dependencies (e16729c)

1.7.2 (2019-04-23)

• 1.7.2 (63fff49)
• refactor(ignore): add coverage to npmignore (f553399)

1.7.1 (2019-04-23)

• 1.7.1 (26a99a2)
• refactor(error): add more useful errors (3bef503), closes #17

1.7.0 (2019-04-02)

• 1.7.0 (eecad87)
• Update bug_report.md (a9773b9)
• Update issue templates (ad9dbef)
• feat(headline): add ability to use custom headline (8aa34d1), closes #14

1.6.0 (2019-02-25)

• 1.6.0 (ac24d91)
• feat(changelog): add changelog and update dependencies (6e92f5c)
• feat(cli): allow to specify multiple rm patterns (#15) (67a059a), closes #15
• fix(title): do not add duplicate header for vuedoc.md parsed files (#16) (b1d267c), closes #16
• docs(readme): update readme (ffe0d03)

1.5.0 (2019-02-24)

• 1.5.0 (7f741a7)
• feat(title): add title to every page (6fa477a), closes #14
• test(sidebar): add sidebar test and add async foreach test (5d10de1)
• refactor: move async foreach to utils (56473a8)

1.4.1 (2019-02-18)

• fix(eslint): fix eslint warning (bbe7a0e)
• refactor: reorder code (89ff644)
• refactor(dependencies): update dependencies and add eslint (ebf62c4)
• docs: add Codacy badge (#12) (064c2ab), closes #12
• docs: update readme and add console output (db4a36f)
• feat(eslint): add eslint and fix eslint errors (f864002)
• feat(jsx/tsx): add ability to document .jsx and .tsx (React JSX) files (#11) (db628ce), closes #11

1.4.0 (2019-02-15)

• 1.4.0 (53e38c4)
• feat(jsdoc-config): add new cli argument to set path to jsdoc config (experimental) (0f25e8c)

1.3.1 (2019-02-11)

• 1.3.1 (1cb7a85)
• refactor: update denpendencies (293a206)

1.3.0 (2019-02-02)

• 1.3.0 (eebe5ef)
• refactor: update dependencies, split files and switch to kebab-case (0992836)

1.2.2 (2019-01-31)

• 1.2.2 (3dda693)
• fix: remove package-lcok (a4eef2d)

1.2.1 (2019-01-31)

• 1.2.1 (17a3f39)
• fix: add chalk (42dcdea)

1.2.0 (2019-01-31)

• 1.2.0 (2865442)
• feat(delete): add delete pattern and do not overwrite readme (e08f4fe), closes #9

1.1.1 (2019-01-30)

• 1.1.1 (77a5bc4)
• refactor: move packages and remove package-lock (c4daabb)

1.1.0 (2019-01-29)

• 1.1.0 (c94d92e)
• feat(exclude): add pattern to exclude files (e13117b)

1.0.3 (2019-01-28)

• 1.0.3 (6d239da)
• fix(children): Filter undefined children (0afdd41)

1.0.2 (2019-01-25)

• 1.0.2 (6babbd9)
• refactor: update dependencies (0ec2250)
• docs: update license (81a8f2f)
• docs: update readme (a876852)

1.0.1 (2018-12-18)

• 1.0.1 (a14d6c1)
• refactor: update example (367154a)
• docs: add more information to readme (f0fb738)

1.0.0 (2018-12-18)

• 1.0.0 (69371b9)
• feat(readme): add ability to add a custom readme (7b5b1ce)

0.3.0 (2018-12-03)

• [add] execution permissions to bin file (27feaa1)
• [add] new index to work with yargs (d9aa76e)
• [add] yargs dependencie (815942c)
• [update] bin file of the project (6fb1f6f)
• [update] cmds/generate.js to work with the new index.js (cba255c)
• [update] git mv index.js to cmds/generate.js (1cdb6df)
• [Update] README.md (2c13bf9)
• [update] relative path from generate.js to helpers (07cc2fa)
• [update] run prettier to index.js bin/vuepress-jsdoc.js generate.js (8d07ade)
• 0.3.0 (d643781)
• fix(hook): fix git pre-commit hook (341831e)

0.2.1 (2018-11-30)

• 0.2.1 (5204f26)
• fix(parser): fix bug in parser and update example (78cbbaf)

0.2.0 (2018-11-30)

• 0.2.0 (e1da34a)
• feat(comment): add a ability to add custom met data and fix a bug when parsing index.js files (30ec64e), closes #2
• refactor: readme (d4c3bf1)

0.1.3 (2018-11-29)

• 0.1.3 (40b0125)
• refactor: update dependencies (5a23951)
• refactor: update dependencies, switch to yarn and update the example (282bd92)

0.1.2 (2018-08-20)

• 0.1.2 (0c23a5e)
• Update dependencies (e444750)

0.1.1 (2018-08-20)

• 0.1.1 (7e60301)
• Add test folder to npmignore (0ca366a)
• Remove consoles and update readme (0c1a59c)

0.1.0 (2018-08-20)

• 0.0.3 (9fc8da3)
• 0.0.3 (294562a)
• 0.1.0 (d22c0f5)
• Add vue file support (8ebdb5d)
• Rename package to vuepress-jsdoc (b3d31a6)
• Update description (97e06b7)
• Update sidebar structure and add an full working example (15cf392)
• Update sidebar structure and add an full working example (47b3a8a)
• Work in progress (90b4882)

0.0.2 (2018-04-29)

• 0.0.2 (408c241)
• Fix checkbboxes (eb4a135)
• Initial commit (b380ffe)
• Remove log (3d6d4c0)
• Remove title (970eb28)