search

cancerberoSgx / jsdoc-templates-demo

demo of well-known jsdoc3 templates
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/
25 stars 7 forks source link

Tutorial or example of how to install templates #8

Open ejgutierrez74 opened 4 days ago

ejgutierrez74 commented 4 days ago

Hi, ive installed in Webstorm in a local project JSDOc 4.0.4, would like to use some of the templates. I cant find any tutorial or explanation of how to install or prepare it to use.

Also if i install locally using npm most of them give me errors

eduardo@MiPcLinux:~/WebstormProjects/Calculadora$ npm install tui-jsdoc-template

added 31 packages, changed 39 packages, and audited 74 packages in 7m

7 packages are looking for funding
  run `npm fund` for details

5 high severity vulnerabilities

Some issues need review, and may require choosing
a different dependency.

Run `npm audit` for details.
eduardo@MiPcLinux:~/WebstormProjects/Calculadora$ npm audit
# npm audit report

lodash.pick  >=4.0.0
Severity: high
Prototype Pollution in lodash - https://github.com/advisories/GHSA-p6mc-m468-83gw
No fix available
node_modules/lodash.pick
  cheerio  0.19.0 - 1.0.0-rc.12
  Depends on vulnerable versions of css-select
  Depends on vulnerable versions of lodash.pick
  node_modules/cheerio
    tui-jsdoc-template  *
    Depends on vulnerable versions of cheerio
    node_modules/tui-jsdoc-template

nth-check  <2.0.1
Severity: high
Inefficient Regular Expression Complexity in nth-check - https://github.com/advisories/GHSA-rp65-9cf3-cjxr
No fix available
node_modules/nth-check
  css-select  <=3.1.0
  Depends on vulnerable versions of nth-check
  node_modules/css-select

5 high severity vulnerabilities

Some issues need review, and may require choosing
a different dependency.
eduardo@MiPcLinux:~/WebstormProjects/Calculadora$ npm install ink-docstrap

added 15 packages, and audited 89 packages in 7m

14 packages are looking for funding
  run `npm fund` for details

8 vulnerabilities (2 moderate, 6 high)

To address all issues possible (including breaking changes), run:
  npm audit fix --force

Some issues need review, and may require choosing
a different dependency.

Run `npm audit` for details.
eduardo@MiPcLinux:~/WebstormProjects/Calculadora$  npm audit fix --force
npm warn using --force Recommended protections disabled.
npm warn audit Updating ink-docstrap to 0.5.4, which is a SemVer major change.
npm warn audit No fix available for tui-jsdoc-template@*

removed 13 packages, changed 2 packages, and audited 76 packages in 3m

https://github.com/user-attachments/assets/ad6cb3fb-d2b6-44d7-a1ed-2f1d8976bd76

https://github.com/user-attachments/assets/df62a999-680c-4ccc-8941-b3c8d8ef78fa

7 packages are looking for funding
  run `npm fund` for details

# npm audit report

lodash.pick  >=4.0.0
Severity: high
Prototype Pollution in lodash - https://github.com/advisories/GHSA-p6mc-m468-83gw
No fix available
node_modules/lodash.pick
  cheerio  0.19.0 - 1.0.0-rc.12
  Depends on vulnerable versions of css-select
  Depends on vulnerable versions of lodash.pick
  node_modules/cheerio
    tui-jsdoc-template  *
    Depends on vulnerable versions of cheerio
    node_modules/tui-jsdoc-template

moment  <=2.29.1
Severity: high
Regular Expression Denial of Service in moment - https://github.com/advisories/GHSA-87vv-r9j6-g5qv
Regular Expression Denial of Service in moment - https://github.com/advisories/GHSA-446m-mv8f-q348
Path Traversal: 'dir/../../filename' in moment.locale - https://github.com/advisories/GHSA-8hfj-j24r-96c4
fix available via `npm audit fix --force`
Will install ink-docstrap@1.3.2, which is a breaking change
node_modules/moment
  ink-docstrap  <=0.5.4
  Depends on vulnerable versions of moment
  node_modules/ink-docstrap

nth-check  <2.0.1
Severity: high
Inefficient Regular Expression Complexity in nth-check - https://github.com/advisories/GHSA-rp65-9cf3-cjxr
No fix available
node_modules/nth-check
  css-select  <=3.1.0
  Depends on vulnerable versions of nth-check
  node_modules/css-select

7 high severity vulnerabilities

To address all issues possible (including breaking changes), run:
  npm audit fix --force

Some issues need review, and may require choosing
a different dependency.

Also no demo folder anywhere....

# ink-docstrap
npm install ink-docstrap
node node_modules/jsdoc/jsdoc.js -c jsdoc-config.json -t node_modules/ink-docstrap/template
rm -rf demo/ink-docstrap
mv output demo/ink-docstrap

eduardo@MiPcLinux:~/WebstormProjects/Calculadora$ node node_modules/jsdoc/jsdoc.js -c jsdoc-config.json -t node_modules/ink-docstrap/template
Cannot parse the config file jsdoc-config.json: Error: ENOENT: no such file or directory, open 'jsdoc-config.json'
Exiting JSDoc because an error occurred. See the previous log messages for details.
There are no input files to process.
ejgutierrez74 commented 4 days ago

Added screemcast in case can be useful:

https://github.com/user-attachments/assets/7e87084e-371b-4488-ba8c-3438ba0364e7