Skip to content

Commit

Permalink
Removed JSDoc generation as it is never really used. JSDoc comments a…
Browse files Browse the repository at this point in the history
…re still required but the doc files will no longer be generated. This simplifies the build process and config scripts.
  • Loading branch information
n1474335 committed Aug 28, 2019
1 parent b21643f commit 686ca28
Show file tree
Hide file tree
Showing 8 changed files with 1 addition and 436 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ node_modules
npm-debug.log
travis.log
build
docs/*
!docs/*.conf.json
!docs/*.ico
.vscode
.*.swp
.DS_Store
Expand Down
1 change: 0 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ npm-debug.log
travis.log
build/*
!build/node
docs
.vscode
.github
3 changes: 1 addition & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ before_script:
script:
- grunt lint
- grunt test
- grunt docs
- grunt testnodeconsumer
- grunt prod --msg="$COMPILE_MSG"
- xvfb-run --server-args="-screen 0 1200x800x24" grunt testui
- grunt testnodeconsumer
before_deploy:
- grunt exec:sitemap
- grunt copy:ghPages
Expand Down
32 changes: 0 additions & 32 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,25 +52,17 @@ module.exports = function (grunt) {
"A task which checks whether consuming CJS and ESM apps work with the CyberChef build",
["exec:setupNodeConsumers", "exec:testCJSNodeConsumer", "exec:testESMNodeConsumer", "exec:testESMDeepImportNodeConsumer", "exec:teardownNodeConsumers"]);

grunt.registerTask("docs",
"Compiles documentation in the /docs directory.",
["clean:docs", "jsdoc", "chmod:docs"]);


grunt.registerTask("default",
"Lints the code base",
["eslint", "exec:repoSize"]);


grunt.registerTask("doc", "docs");
grunt.registerTask("tests", "test");
grunt.registerTask("lint", "eslint");


// Load tasks provided by each plugin
grunt.loadNpmTasks("grunt-eslint");
grunt.loadNpmTasks("grunt-webpack");
grunt.loadNpmTasks("grunt-jsdoc");
grunt.loadNpmTasks("grunt-contrib-clean");
grunt.loadNpmTasks("grunt-contrib-copy");
grunt.loadNpmTasks("grunt-contrib-watch");
Expand Down Expand Up @@ -117,7 +109,6 @@ module.exports = function (grunt) {
node: ["build/node/*"],
config: ["src/core/config/OperationConfig.json", "src/core/config/modules/*", "src/code/operations/index.mjs"],
nodeConfig: ["src/node/index.mjs", "src/node/config/OperationConfig.json"],
docs: ["docs/*", "!docs/*.conf.json", "!docs/*.ico", "!docs/*.png"],
standalone: ["build/prod/CyberChef*.html"]
},
eslint: {
Expand All @@ -130,22 +121,6 @@ module.exports = function (grunt) {
node: ["src/node/**/*.{js,mjs}"],
tests: ["tests/**/*.{js,mjs}"],
},
jsdoc: {
options: {
destination: "docs",
template: "node_modules/ink-docstrap/template",
recurse: true,
readme: "./README.md",
configure: "docs/jsdoc.conf.json"
},
all: {
src: [
"src/**/*.js",
"src/**/*.mjs",
"!src/core/vendor/**/*"
],
}
},
accessibility: {
options: {
accessibilityLevel: "WCAG2A",
Expand Down Expand Up @@ -298,7 +273,6 @@ module.exports = function (grunt) {
},
{
expand: true,
src: "docs/**",
dest: "build/prod/"
},
]
Expand Down Expand Up @@ -332,12 +306,6 @@ module.exports = function (grunt) {
mode: "755",
},
src: ["build/**/*", "build/"]
},
docs: {
options: {
mode: "755",
},
src: ["docs/**/*", "docs/"]
}
},
watch: {
Expand Down
Binary file removed docs/favicon.ico
Binary file not shown.
32 changes: 0 additions & 32 deletions docs/jsdoc.conf.json

This file was deleted.

Loading

0 comments on commit 686ca28

Please sign in to comment.