From 686ca284fe8edc863ad257087628e89b0f0be4a2 Mon Sep 17 00:00:00 2001 From: n1474335 Date: Wed, 28 Aug 2019 16:37:31 +0100 Subject: [PATCH] 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. --- .gitignore | 3 - .npmignore | 1 - .travis.yml | 3 +- Gruntfile.js | 32 ---- docs/favicon.ico | Bin 1082 -> 0 bytes docs/jsdoc.conf.json | 32 ---- package-lock.json | 362 ------------------------------------------- package.json | 4 - 8 files changed, 1 insertion(+), 436 deletions(-) delete mode 100755 docs/favicon.ico delete mode 100755 docs/jsdoc.conf.json diff --git a/.gitignore b/.gitignore index 6c9f300a..e546c949 100755 --- a/.gitignore +++ b/.gitignore @@ -2,9 +2,6 @@ node_modules npm-debug.log travis.log build -docs/* -!docs/*.conf.json -!docs/*.ico .vscode .*.swp .DS_Store diff --git a/.npmignore b/.npmignore index 6f32ec06..05ab5f52 100755 --- a/.npmignore +++ b/.npmignore @@ -3,6 +3,5 @@ npm-debug.log travis.log build/* !build/node -docs .vscode .github diff --git a/.travis.yml b/.travis.yml index e99e3903..6996a5e1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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 diff --git a/Gruntfile.js b/Gruntfile.js index e228d785..3eb67068 100755 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -52,17 +52,10 @@ 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"); @@ -70,7 +63,6 @@ module.exports = function (grunt) { // 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"); @@ -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: { @@ -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", @@ -298,7 +273,6 @@ module.exports = function (grunt) { }, { expand: true, - src: "docs/**", dest: "build/prod/" }, ] @@ -332,12 +306,6 @@ module.exports = function (grunt) { mode: "755", }, src: ["build/**/*", "build/"] - }, - docs: { - options: { - mode: "755", - }, - src: ["docs/**/*", "docs/"] } }, watch: { diff --git a/docs/favicon.ico b/docs/favicon.ico deleted file mode 100755 index fa2deb032ee0845745e495fb77de2fab56e2871a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1082 zcmZQzU}Ruq5a0*V3JfYN3=Con3=A3!3=9Gc3=DD%5OD?q;Q#;s1XLiTeSCZn93)mj zL4o~*2^0ML`uhAjIy$`D+S_lBoq6--EndBP^{M3KWNDBYAUt*I)MbwzJ%Zbf&3>3WK=htHdw%ESg9~uUmb?Vfqe=t2rG&o#A zaTOI6#e4GP$&+Y$!EV53|KY=jzb{y@;3z10Z{50eCMeuM>XFSs5C7ArPlMe8iifRR zw?1`tc9sD7pMimaf8V}+kDy@ywi{#)x_*%R4<0=DciXmYKlbk3`!h2$Q_tPq9clyv zLuY4a%IejtyQfc|UVHiS<+q@)1nB|!bJeO# zVL}Y~`T5F|Cr_^I@9&>eSy>t8