Skip to content

Commit 87ccf52

Browse files
committed
feat(app): use last jhipster api addNpmscript
1 parent 59df130 commit 87ccf52

File tree

5 files changed

+14
-7
lines changed

5 files changed

+14
-7
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
> JHipster module, additional [compodoc](https://github.com/compodoc/compodoc) support in your JHipster application
99
1010
<p align="center">
11-
<img src="https://raw.githubusercontent.com/groupe-sii/compodoc/master/screenshots/main-view.png" alt="Compodoc: The missing documentation tool for your Angular application">
11+
<img src="https://raw.githubusercontent.com/compodoc/generator-jhipster-compodoc/master/screenshots/main-view.png" alt="Compodoc: The missing documentation tool for your Angular application">
1212
</p>
1313

1414
# Introduction
@@ -43,7 +43,13 @@ Due to a limitation of yeoman about file override, you will have to accept the o
4343

4444
```bash
4545
conflict package.json
46-
? Overwirte package.json? (Ynaxdh)
46+
? Overwrite package.json? (Ynaxdh)
47+
```
48+
49+
Enjoy compodoc in your Angular application
50+
51+
```bash
52+
npm run doc
4753
```
4854

4955
# License

generators/app/index.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ module.exports = yeoman.Base.extend({
3232
writing: {
3333
writeTemplates : function () {
3434
jhipsterFunc.addNpmDevDependency('compodoc', '0.0.26');
35+
jhipsterFunc.addNpmScript('doc', './node_modules/.bin/compodoc -p src/tsconfig.json');
3536
},
3637

3738
registering: function () {
@@ -49,5 +50,7 @@ module.exports = yeoman.Base.extend({
4950

5051
end: function () {
5152
this.log('End of JHipster compodoc generator');
53+
this.log(' Run compodoc using npm scripts :');
54+
this.log(' > npm run doc');
5255
}
5356
});

generators/app/templates/dummy.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
"url": "git+https://github.com/compodoc/generator-jhipster-compodoc.git"
2323
},
2424
"dependencies": {
25-
"yeoman-generator": "0.22.4",
26-
"chalk": "1.1.1",
25+
"yeoman-generator": "0.24.1",
26+
"chalk": "1.1.3",
2727
"mkdirp": "0.5.1",
28-
"generator-jhipster": "^3.0.0"
28+
"generator-jhipster": "^3.12.1"
2929
},
3030
"devDependencies": {
3131
"fs-extra": "0.26.4",

screenshot/main-view.png

148 KB
Loading

0 commit comments

Comments
 (0)