Skip to content

Commit 686ca28

Browse files
committed
Removed JSDoc generation as it is never really used. JSDoc comments are still required but the doc files will no longer be generated. This simplifies the build process and config scripts.
1 parent b21643f commit 686ca28

8 files changed

+1
-436
lines changed

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ node_modules
22
npm-debug.log
33
travis.log
44
build
5-
docs/*
6-
!docs/*.conf.json
7-
!docs/*.ico
85
.vscode
96
.*.swp
107
.DS_Store

.npmignore

-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@ npm-debug.log
33
travis.log
44
build/*
55
!build/node
6-
docs
76
.vscode
87
.github

.travis.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ before_script:
1111
script:
1212
- grunt lint
1313
- grunt test
14-
- grunt docs
14+
- grunt testnodeconsumer
1515
- grunt prod --msg="$COMPILE_MSG"
1616
- xvfb-run --server-args="-screen 0 1200x800x24" grunt testui
17-
- grunt testnodeconsumer
1817
before_deploy:
1918
- grunt exec:sitemap
2019
- grunt copy:ghPages

Gruntfile.js

-32
Original file line numberDiff line numberDiff line change
@@ -52,25 +52,17 @@ module.exports = function (grunt) {
5252
"A task which checks whether consuming CJS and ESM apps work with the CyberChef build",
5353
["exec:setupNodeConsumers", "exec:testCJSNodeConsumer", "exec:testESMNodeConsumer", "exec:testESMDeepImportNodeConsumer", "exec:teardownNodeConsumers"]);
5454

55-
grunt.registerTask("docs",
56-
"Compiles documentation in the /docs directory.",
57-
["clean:docs", "jsdoc", "chmod:docs"]);
58-
59-
6055
grunt.registerTask("default",
6156
"Lints the code base",
6257
["eslint", "exec:repoSize"]);
6358

64-
65-
grunt.registerTask("doc", "docs");
6659
grunt.registerTask("tests", "test");
6760
grunt.registerTask("lint", "eslint");
6861

6962

7063
// Load tasks provided by each plugin
7164
grunt.loadNpmTasks("grunt-eslint");
7265
grunt.loadNpmTasks("grunt-webpack");
73-
grunt.loadNpmTasks("grunt-jsdoc");
7466
grunt.loadNpmTasks("grunt-contrib-clean");
7567
grunt.loadNpmTasks("grunt-contrib-copy");
7668
grunt.loadNpmTasks("grunt-contrib-watch");
@@ -117,7 +109,6 @@ module.exports = function (grunt) {
117109
node: ["build/node/*"],
118110
config: ["src/core/config/OperationConfig.json", "src/core/config/modules/*", "src/code/operations/index.mjs"],
119111
nodeConfig: ["src/node/index.mjs", "src/node/config/OperationConfig.json"],
120-
docs: ["docs/*", "!docs/*.conf.json", "!docs/*.ico", "!docs/*.png"],
121112
standalone: ["build/prod/CyberChef*.html"]
122113
},
123114
eslint: {
@@ -130,22 +121,6 @@ module.exports = function (grunt) {
130121
node: ["src/node/**/*.{js,mjs}"],
131122
tests: ["tests/**/*.{js,mjs}"],
132123
},
133-
jsdoc: {
134-
options: {
135-
destination: "docs",
136-
template: "node_modules/ink-docstrap/template",
137-
recurse: true,
138-
readme: "./README.md",
139-
configure: "docs/jsdoc.conf.json"
140-
},
141-
all: {
142-
src: [
143-
"src/**/*.js",
144-
"src/**/*.mjs",
145-
"!src/core/vendor/**/*"
146-
],
147-
}
148-
},
149124
accessibility: {
150125
options: {
151126
accessibilityLevel: "WCAG2A",
@@ -298,7 +273,6 @@ module.exports = function (grunt) {
298273
},
299274
{
300275
expand: true,
301-
src: "docs/**",
302276
dest: "build/prod/"
303277
},
304278
]
@@ -332,12 +306,6 @@ module.exports = function (grunt) {
332306
mode: "755",
333307
},
334308
src: ["build/**/*", "build/"]
335-
},
336-
docs: {
337-
options: {
338-
mode: "755",
339-
},
340-
src: ["docs/**/*", "docs/"]
341309
}
342310
},
343311
watch: {

docs/favicon.ico

-1.06 KB
Binary file not shown.

docs/jsdoc.conf.json

-32
This file was deleted.

0 commit comments

Comments
 (0)