• d3 from d3-flextree: 3.x.x
• EventDispatcher
• htmlparser: 2.0.0
• innersvg: 2.x.x
• prism: 1.29.0
• promise
• deep-iterator: 2.4.0

• bootstrap native: 5.0.0
• es6-shim: 0.35.1
• svg-pan-zoom: 3.6.1
• tablesort: 5.4.0
• vis: 4.21.0
• lunr: 2.3.9

If you are using Compodoc in module mode with a JavaScript file, require('@compodoc/compodoc'), the first entry file is src/index.ts.

If you are using Compodoc with the CLI, the first entry file is src/index-cli.ts.

The process of Compodoc is:

• handle CLI flags
• find files to scan using tsconfig.json include and/or exclude options, or use the root folder of tsconfig.json
• scan the files using TypeScript compiler
• generate all the internal stuff
• emit files for each category (modules, components, etc)
• echo the result of the generation.

Unit testing is done by running several documentation generation with many different files and projects.

E2E testing is done with SauceLabs service.

npm run test

1. Install selenium-standalone:

   npm install selenium-standalone@latest -g

2. Configure selenium-standalone:

   selenium-standalone install

3. Start selenium-standalone:

   selenium-standalone start

4. Start local documentation generation in another terminal tab:

   npm run test:simple-doc

5. Start local E2E testing:

   npm run local-test-e2e-mocha

1. Install

   npm i

2. Init

   npm run build

3. Link

   npm link

   This will make compodoc command available everywhere.

4. Start

   npm start

   Launch watch process for source files and rollup build.

1. Install sleep package:

   npm i sleep

2. Add these lines in index-cli.ts, after --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);
   }

3. Open one terminal and run inside compodoc folder:

   npm run start

4. Add debugger statement where you want to debug your code.

5. Open Chrome and this url: chrome://inspect.

6. Open another terminal with the source code of the demo project, and run:

   node --inspect ../compodoc/bin/index-cli.js -p tsconfig.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc --toggleMenuItems "'all'" -s

7. Compodoc will wait 10s before starting when it detects --inspect flag.

8. Open the debug window in Chrome, and click inspect.

• gitflow start new release
• in git release branhc, bump package.json and packe-lock.json version number
• update changelog : npm run changelog, and copy-paste data in CHANGELOG.md
• close release branch
• npm publish --access public