Skip to content

Commit

Permalink
1.1.13
Browse files Browse the repository at this point in the history
  • Loading branch information
vogloblinsky committed Jul 9, 2021
2 parents 8ef351f + 7eb1d65 commit 6266425
Show file tree
Hide file tree
Showing 17 changed files with 409 additions and 2,210 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,16 @@
<a name="1.1.13"></a>

## [1.1.13](https://github.com/compodoc/compodoc/compare/1.1.12...1.1.13) (2021-06-09)

### Features

- feat(cli): Support --watch with --exportFormat json ([fdfe925](https://github.com/compodoc/compodoc/commit/fdfe925)), closes [#1087](https://github.com/compodoc/compodoc/issues/1087)

### Bug fixes

- fix(dark): better dark mode ([f93090b](https://github.com/compodoc/compodoc/commit/f93090b)), closes [#1092](https://github.com/compodoc/compodoc/issues/1092)
- fix(cli): remove sleep package | wait 10s if --inspect flag in CONTRIBUTING.md and docs/README.md ([a1d5a1a](https://github.com/compodoc/compodoc/commit/a1d5a1a)), closes [#1090](https://github.com/compodoc/compodoc/issues/1090)

<a name="1.1.12"></a>

## [1.1.12](https://github.com/compodoc/compodoc/compare/1.1.11...1.1.12) (2021-06-07)
Expand Down
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions docs/README.md
Expand Up @@ -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`

0 comments on commit 6266425

Please sign in to comment.