Skip to content

feat: setup jsdoc for documentation #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

feat: setup jsdoc for documentation #58

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bffc75a
setup jsdoc for documentation
Samridhi-98 Feb 4, 2022
14fcf03
added jsdoc setup for sub-directories
Samridhi-98 Feb 14, 2022
c9abf78
changed script
Samridhi-98 Feb 14, 2022
bcc9073
add uild-docs in npm
Samridhi-98 Feb 14, 2022
a10da2a
build-docs working
Samridhi-98 Feb 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions dashboard/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
"coverage": "npm run coverage:unit && npm run coverage:integration",
"coverage:unit": "npm run test:unit && codecov",
"coverage:integration": "npm run test:integration && codecov",
"dev": "nodemon ./server/index.js"
"dev": "nodemon ./server/index.js",
"generate-docs": "jsdoc --configure ../jsdoc.conf.json"
},
"author": "elit-altum",
"license": "Apache-2.0",
Expand All @@ -38,11 +39,12 @@
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.4.0",
"eslint-plugin-promise": "^5.1.0",
"jsdoc": "^3.6.10",
"mocha": "^8.4.0",
"mock-require": "^3.0.3",
"nodemon": "^2.0.7",
"nyc": "^15.1.0",
"prettier": "^2.3.0",
"sinon": "^11.1.1"
}
}
}
6 changes: 4 additions & 2 deletions frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"coverage:unit": "exit 0",
"coverage:integration": "exit 0",
"dev": "next .",
"build": "next build . && next export ."
"build": "next build . && next export .",
"generate-docs": "jsdoc --configure ../jsdoc.conf.json"
},
"author": "elit-altum",
"license": "Apache-2.0",
Expand Down Expand Up @@ -46,9 +47,10 @@
"eslint-plugin-promise": "^5.1.0",
"eslint-plugin-react": "^7.24.0",
"eslint-plugin-react-hooks": "^4.2.0",
"jsdoc": "^3.6.10",
"nodemon": "^2.0.7",
"postcss": "^8.3.5",
"prettier": "^2.3.0",
"tailwindcss": "^2.2.4"
}
}
}
26 changes: 26 additions & 0 deletions jsdoc.conf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"plugins": [],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_",
"include": [
"."
],
"exclude": [
"node_modules"
]
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": [
"jsdoc",
"closure"
]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"coverage": "node npm/coverage.js",
"dev:dashboard": "nodemon ./dashboard/server/index.js",
"dev:client": "next ./frontend",
"build": "node npm/build.js"
"build": "node npm/build.js",
"generate-docs": "jsdoc --configure jsdoc.conf.json -d ./out"
},
"keywords": [
"newman",
Expand All @@ -39,10 +40,11 @@
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.4.0",
"eslint-plugin-promise": "^5.1.0",
"jsdoc": "^3.6.10",
"nodemon": "^2.0.12",
"prettier": "^2.3.0"
},
"dependencies": {
"async": "^3.2.1"
}
}
}
6 changes: 4 additions & 2 deletions reporter/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"test:integration": "exit 0",
"coverage": "npm run coverage:unit && npm run coverage:integration",
"coverage:unit": "npm run test:unit && codecov",
"coverage:integration": "exit 0"
"coverage:integration": "exit 0",
"generate-docs": "jsdoc --configure ../jsdoc.conf.json"
},
"author": "elit-altum",
"license": "Apache-2.0",
Expand All @@ -35,10 +36,11 @@
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.4.0",
"eslint-plugin-promise": "^5.1.0",
"jsdoc": "^3.6.10",
"mocha": "^8.4.0",
"mock-require": "^3.0.3",
"nyc": "^15.1.0",
"prettier": "^2.3.0",
"sinon": "^11.1.1"
}
}
}