Skip to content

Commit e28a5da

Browse files
authored
⬆️ Update JSDoc generation and dependencies
* 🐛 jsdoc generation command for improved documentation consistency and readability Adjusted the `generate-jsDocs` npm script to include the `-p` flag for better JSDoc generation. This modification aims to enhance the consistency and readability of the documentation. It ensures that the project's JSDoc configuration file is utilized during the generation process, promoting a standardized documentation output. This change contributes to improving maintainability and comprehensibility of the codebase. * ⬆️ clean-jsdoc-theme to version 4.2.14 This update includes improvements and fixes for the JSDoc theme. * 📦 Bump version to 1.1.2 and update dev dependencies This update includes bumping the package version to 1.1.2 and updating dev dependencies to their latest versions, ensuring compatibility and potential bug fixes. No issues addressed.
1 parent 5ee0538 commit e28a5da

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "netsuite-custommodules-template",
3-
"version": "1.1.0",
3+
"version": "1.1.2",
44
"description": "NS Template project for testing and using CI/CD for your NetSuite SuiteCloud projects.",
55
"scripts": {
66
"test": "jest --coverage --ci --testResultsProcessor=\"./node_modules/jest-junit-reporter\" --testPathPattern=$npm_config_testpattern --$npm_config_watch ",
@@ -20,7 +20,7 @@
2020
"save-token": "node ./node_modules/@oracle/suitecloud-cli/src/suitecloud.js account:savetoken --account $npm_config_account --authid $npm_config_authid --tokenid $npm_config_tokenid --tokensecret $npm_config_tokensecret",
2121
"deploy-pipeline": "npm run deploy",
2222
"add-ns-dependents": "npm run suitecloud -- project:adddependencies && bash .ci/scripts/rmDependents.sh",
23-
"generate-jsDocs": "jsdoc -c .ci/config/jsDocsConf.json && cp .ci/templates/web.config.private docs/private/web.config && cp -f docs/private/styles/clean-jsdoc-theme.min.css docs/assets/templates/clean-jsdoc-theme.min.css && cp -f .ci/templates/web.config.search.private ./docs/private/data/web.config",
23+
"generate-jsDocs": "jsdoc -c .ci/config/jsDocsConf.json -p && cp .ci/templates/web.config.private docs/private/web.config && cp -f docs/private/styles/clean-jsdoc-theme.min.css docs/assets/templates/clean-jsdoc-theme.min.css && cp -f .ci/templates/web.config.search.private ./docs/private/data/web.config",
2424
"generate-mdDocs": "npm run generate-jsDocs && jsdoc2md --template .ci/templates/README.hbs ./src/**/*[^.min].js > README.md",
2525
"generate-wiki": "mkdir -p wiki && node .ci/config/docsMD.config.min.js && mv wiki/README.md wiki/HOME.md",
2626
"docs": "npm run clean && npm run generate-jsDocs && npm run generate-mdDocs && npm run generate-wiki",
@@ -57,7 +57,7 @@
5757
"@types/jsdom": "^20.0.1",
5858
"@vnetwork-solutions/ns-custom-stubs-template": "^2.0.1",
5959
"alias-quokka-plugin": "^0.1.0",
60-
"clean-jsdoc-theme": "^4.1.10",
60+
"clean-jsdoc-theme": "^4.2.14",
6161
"contributor-table": "^1.0.0",
6262
"jest": "^29.3.1",
6363
"jest-environment-jsdom": "^29.3.1",

0 commit comments

Comments
 (0)