fix(cli): remove sleep package | wait 10s if --inspect flag in CONTRIBUTING.md and docs/README.md

fix #1090

Author: vogloblinsky

CONTRIBUTING.md

@@ -29,6 +29,18 @@ See this folder for more details : [DOCS](./docs/README.md)
 
 ### Debugging process
 
+-   install sleep package `npm i sleep`
+-   add these lines in index-cli.ts, atfer --files check
+
+```
+const sleep = require('sleep');
+const isInInspectMode = /--inspect/.test(process.execArgv.join(' '));
+if (isInInspectMode) {
+    // wait 10 seconds for debugger to connect in Chrome devtools
+    sleep.sleep(10);
+}
+```
+
 -   open one terminal and run inside compodoc folder : `npm run start`
 -   add `debugger`statement where you want to debug your code
 -   open Chrome and this url : chrome://inspect

docs/README.md

@@ -87,3 +87,24 @@ This will put compodoc command available everywhere.
 > npm start
 
 Launch watch process for source files and rollup build.
+
+## Node.js inspecting
+
+-   install sleep package `npm i sleep`
+-   add these lines in index-cli.ts, atfer --files check
+
+```
+const sleep = require('sleep');
+const isInInspectMode = /--inspect/.test(process.execArgv.join(' '));
+if (isInInspectMode) {
+    // wait 10 seconds for debugger to connect in Chrome devtools
+    sleep.sleep(10);
+}
+```
+
+-   open one terminal and run inside compodoc folder : `npm run start`
+-   add `debugger`statement where you want to debug your code
+-   open Chrome and this url : chrome://inspect
+-   open another terminal with the source code of the [demo project](https://github.com/compodoc/compodoc-demo-todomvc-angular), and run `node --inspect ../compodoc/bin/index-cli.js -p tsconfig.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc --toggleMenuItems "'all'" -s`
+-   Compodoc will wait 10s before starting when it detects --inspect flag
+-   open the debug window in Chrome, and click `inspect`

package-lock.json

@@ -113,7 +113,6 @@
         "os-name": "^4.0.0",
         "pdfmake": "^0.2.0",
         "semver": "^7.3.5",
-        "sleep": "^6.3.0",
         "traverse": "^0.6.6",
         "ts-morph": "^11.0.0",
         "ts-simple-ast": "12.4.0",

package.json

@@ -13,15 +13,14 @@ import AngularVersionUtil from './utils/angular-version.util';
 import { COMPODOC_DEFAULTS } from './utils/defaults';
 import { logger } from './utils/logger';
 import { ParserUtil } from './utils/parser.util.class';
-import { handlePath, readConfig, ignoreDirectory } from './utils/utils';
+import { readConfig, ignoreDirectory } from './utils/utils';
 
 import { cosmiconfigSync } from 'cosmiconfig';
 
 const os = require('os');
 const osName = require('os-name');
 const pkg = require('../package.json');
 const program = require('commander');
-const sleep = require('sleep');
 
 const cosmiconfigModuleName = 'compodoc';
 
@@ -638,13 +637,6 @@ Note: Certain tabs will only be shown if applicable to a given dependency`,
             }
         }
 
-        const isInInspectMode = /--inspect/.test(process.execArgv.join(' '));
-
-        if (isInInspectMode) {
-            // wait 10 seconds for debugger to connect in Chrome devtools
-            sleep.sleep(10);
-        }
-
         if (programOptions.serve && !Configuration.mainData.tsconfig && programOptions.output) {
             // if -s & -d, serve it
             if (!FileEngine.existsSync(Configuration.mainData.output)) {
@@ -849,14 +841,16 @@ Note: Certain tabs will only be shown if applicable to a given dependency`,
 
                         let startCwd = sourceFolder;
 
-                        let excludeParserTestFilesWithCwdDepth = excludeParser.testFilesWithCwdDepth();
+                        let excludeParserTestFilesWithCwdDepth =
+                            excludeParser.testFilesWithCwdDepth();
                         if (!excludeParserTestFilesWithCwdDepth.status) {
                             startCwd = excludeParser.updateCwd(
                                 cwd,
                                 excludeParserTestFilesWithCwdDepth.level
                             );
                         }
-                        let includeParserTestFilesWithCwdDepth = includeParser.testFilesWithCwdDepth();
+                        let includeParserTestFilesWithCwdDepth =
+                            includeParser.testFilesWithCwdDepth();
                         if (!includeParser.testFilesWithCwdDepth().status) {
                             startCwd = includeParser.updateCwd(
                                 cwd,