Skip to content

Commit 00139c6

Browse files
docs(*): Use publish-scripts to publish docs
1 parent ad146eb commit 00139c6

File tree

6 files changed

+106
-170
lines changed

6 files changed

+106
-170
lines changed

package.json

+3-10
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@
2424
"test:downstream": "npm run build && test_downstream_projects",
2525
"watch": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1",
2626
"debug": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1 --browsers=Chrome",
27-
"docs": "./scripts/docs.js",
27+
"docs": "generate_docs && publish_docs",
2828
"release": "release --deps @uirouter/core && node ./scripts/bower_release.js",
2929
"prepublishOnly": "npm run build",
30-
"publishdocs": "node scripts/publishdocs.js",
3130
"artifacts": "artifact_tagging"
3231
},
3332
"homepage": "https://ui-router.github.io",
@@ -77,12 +76,12 @@
7776
"angular": ">=1.2.0"
7877
},
7978
"devDependencies": {
80-
"@types/angular": "^1.6.42",
79+
"@types/angular": "1.6.25",
8180
"@types/angular-animate": "1.5.9",
8281
"@types/angular-mocks": "1.5.11",
8382
"@types/jasmine": "2.8.6",
8483
"@types/jquery": "3.3.0",
85-
"@uirouter/publish-scripts": "2.2.10",
84+
"@uirouter/publish-scripts": "2.3.0",
8685
"dts-downlevel": "0.3.0",
8786
"fork-ts-checker-webpack-plugin": "0.3.0",
8887
"jasmine-core": "3.0.0",
@@ -103,13 +102,7 @@
103102
"ts-loader": "3.3.1",
104103
"tslint": "5.9.1",
105104
"tslint-eslint-rules": "4.1.1",
106-
"typedoc": "0.9.0",
107-
"typedoc-plugin-external-module-name": "1.0.10",
108-
"typedoc-plugin-internal-external": "1.0.10",
109-
"typedoc-plugin-single-line-tags": "1.0.0",
110-
"typedoc-plugin-ui-router": "1.0.6",
111105
"typescript": "2.6.2",
112-
"ui-router-typedoc-themes": "1.0.2",
113106
"webpack": "3.10.0"
114107
}
115108
}

scripts/docs.js

-58
This file was deleted.

scripts/publishdocs.js

-39
This file was deleted.

tsconfig.typedoc.json

-19
This file was deleted.

typedoc.json

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"compilerOptions": {
3+
"emitDecoratorMetadata": true,
4+
"experimentalDecorators": true,
5+
"module": "commonjs",
6+
"target": "es5",
7+
"allowSyntheticDefaultImports": true,
8+
"outDir": "build/es5",
9+
"declaration": false,
10+
"sourceMap": false,
11+
"importHelpers": true
12+
},
13+
"typedoc": {
14+
"publishDir": "_ng1_docs",
15+
"include": [
16+
{
17+
"package": "@uirouter/core",
18+
"repo": "https://github.com/ui-router/core.git",
19+
"entry": "src/index.ts"
20+
}
21+
],
22+
"generateOptions": {
23+
"tsconfig": "typedoc.json",
24+
"readme": "DOCS.md",
25+
"name": "@uirouter/angularjs",
26+
"theme": "node_modules/ui-router-typedoc-themes/bin/default",
27+
"out": "_doc",
28+
"internal-aliases": "internal,coreapi,ng1api",
29+
"external-aliases": "internalapi,external",
30+
"navigation-label-globals": "@uirouter/angularjs"
31+
}
32+
},
33+
"files": [
34+
"src/index.ts",
35+
"src/legacy/stateEvents.ts",
36+
"src/legacy/resolveService.ts",
37+
".downstream_cache/@uirouter/core/src/index.ts",
38+
"node_modules/typedoc/node_modules/typescript/lib/lib.es6.d.ts"
39+
]
40+
}

yarn.lock

+63-44
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,35 @@
1414
dependencies:
1515
"@types/angular" "*"
1616

17-
"@types/angular@*":
17+
"@types/angular@*", "@types/[email protected]":
1818
version "1.6.25"
1919
resolved "https://registry.yarnpkg.com/@types/angular/-/angular-1.6.25.tgz#d403e94b40e06af3d9b76da5031795a9b929d08a"
2020

21-
"@types/angular@^1.6.42":
22-
version "1.6.42"
23-
resolved "https://registry.yarnpkg.com/@types/angular/-/angular-1.6.42.tgz#8d587afeccff635900ffb04a10a0cae894704ef2"
21+
"@types/events@*":
22+
version "1.1.0"
23+
resolved "https://registry.yarnpkg.com/@types/events/-/events-1.1.0.tgz#93b1be91f63c184450385272c47b6496fd028e02"
2424

25-
26-
version "4.0.0"
27-
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.0.tgz#1dd742ad5c9bce308f7a52d02ebc01421bc9102f"
25+
"@types/fs-extra@^4.0.0":
26+
version "4.0.7"
27+
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.7.tgz#02533262386b5a6b9a49797dc82feffdf269140a"
28+
dependencies:
29+
"@types/node" "*"
30+
31+
"@types/glob@*":
32+
version "5.0.35"
33+
resolved "https://registry.yarnpkg.com/@types/glob/-/glob-5.0.35.tgz#1ae151c802cece940443b5ac246925c85189f32a"
2834
dependencies:
35+
"@types/events" "*"
36+
"@types/minimatch" "*"
2937
"@types/node" "*"
3038

31-
32-
version "4.0.31"
33-
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.31.tgz#a7fba66fafe42713aee88eeca8db91192efe6e72"
39+
"@types/handlebars@^4.0.31":
40+
version "4.0.36"
41+
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.36.tgz#ff57c77fa1ab6713bb446534ddc4d979707a3a79"
3442

35-
36-
version "9.1.8"
37-
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.1.8.tgz#d227f18bcb8f3f187e16965f2444859a04689758"
43+
"@types/highlight.js@^9.1.8":
44+
version "9.12.2"
45+
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.2.tgz#6ee7cd395effe5ec80b515d3ff1699068cd0cd1d"
3846

3947
4048
version "2.8.6"
@@ -44,47 +52,58 @@
4452
version "3.3.0"
4553
resolved "https://registry.yarnpkg.com/@types/jquery/-/jquery-3.3.0.tgz#6316ac20a1a13c5d521a2dc661befc7184f73f5b"
4654

47-
"@types/[email protected].74":
48-
version "4.14.74"
49-
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.74.tgz#ac3bd8db988e7f7038e5d22bd76a7ba13f876168"
55+
"@types/lodash@^4.14.37":
56+
version "4.14.102"
57+
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.102.tgz#586a3e22385fc79b07cef9c5a1c8a5387986fbc8"
5058

51-
52-
version "0.3.0"
53-
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.3.0.tgz#583c223dd33385a1dda01aaf77b0cd0411c4b524"
59+
60+
version "0.0.28"
61+
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.0.28.tgz#44ba754e9fa51432583e8eb30a7c4dd249b52faa"
62+
63+
"@types/minimatch@*":
64+
version "3.0.3"
65+
resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
5466

55-
67+
"@types/minimatch@^2.0.29":
5668
version "2.0.29"
5769
resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-2.0.29.tgz#5002e14f75e2d71e564281df0431c8c1b4a2a36a"
5870

5971
"@types/node@*":
6072
version "8.0.6"
6173
resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.6.tgz#ed2c3e011cb51ccd3cf874989130f1b9ffe06069"
6274

63-
64-
version "0.7.0"
65-
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.0.tgz#229c157c6bc1e67d6b990e6c5e18dbd2ff58cff0"
75+
"@types/shelljs@^0.7.0":
76+
version "0.7.8"
77+
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.8.tgz#4b4d6ee7926e58d7bca448a50ba442fd9f6715bd"
6678
dependencies:
79+
"@types/glob" "*"
6780
"@types/node" "*"
6881

6982
"@uirouter/[email protected]":
7083
version "5.0.16"
7184
resolved "https://registry.yarnpkg.com/@uirouter/core/-/core-5.0.16.tgz#c6f9e2041df1b6ad3bc28b089e55241a1cb4610f"
7285

73-
"@uirouter/publish-scripts@2.2.10":
74-
version "2.2.10"
75-
resolved "https://registry.yarnpkg.com/@uirouter/publish-scripts/-/publish-scripts-2.2.10.tgz#08db3cfeacb1961b7668eb55d70956a7853aea28"
86+
"@uirouter/publish-scripts@2.3.0":
87+
version "2.3.0"
88+
resolved "https://registry.yarnpkg.com/@uirouter/publish-scripts/-/publish-scripts-2.3.0.tgz#63c00cbd126cb38d9e94a6f8299cf92e6e303e6f"
7689
dependencies:
7790
conventional-changelog "^1.1.4"
7891
conventional-changelog-ui-router-core "^1.4.2"
7992
find-parent-dir "^0.3.0"
8093
git-semver-tags "^1.2.1"
94+
lodash "^4.17.5"
8195
npm-run-all "^4.1.1"
8296
open "^0.0.5"
8397
readline-sync "^1.4.7"
8498
shelljs "^0.7.8"
8599
shx "^0.2.2"
86100
tmp "^0.0.33"
87101
tweak-sourcemap-paths "0.0.3"
102+
typedoc "0.8.0"
103+
typedoc-plugin-external-module-name "1.1.1"
104+
typedoc-plugin-internal-external "1.0.10"
105+
typedoc-plugin-ui-router "1.0.6"
106+
ui-router-typedoc-themes "1.0.2"
88107
yargs "^9.0.1"
89108

90109
JSONStream@^1.0.3, JSONStream@^1.0.4:
@@ -3034,6 +3053,10 @@ lodash@^3.8.0:
30343053
version "3.10.1"
30353054
resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"
30363055

3056+
lodash@^4.17.5:
3057+
version "4.17.5"
3058+
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
3059+
30373060
log4js@^2.3.9:
30383061
version "2.4.1"
30393062
resolved "https://registry.yarnpkg.com/log4js/-/log4js-2.4.1.tgz#b0c4e88133e0e3056afdc6f91f7f377576158778"
@@ -5088,33 +5111,29 @@ typedoc-default-themes@^0.5.0:
50885111
version "0.5.0"
50895112
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"
50905113

5091-
typedoc-plugin-external-module-name@1.0.10:
5092-
version "1.0.10"
5093-
resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-name/-/typedoc-plugin-external-module-name-1.0.10.tgz#f97c1df450d9ec75bf06b72bf3f9a12382184135"
5114+
typedoc-plugin-external-module-name@1.1.1:
5115+
version "1.1.1"
5116+
resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-name/-/typedoc-plugin-external-module-name-1.1.1.tgz#0ef2d6a760b42c703519c474258b6f062983aa83"
50945117

50955118
50965119
version "1.0.10"
50975120
resolved "https://registry.yarnpkg.com/typedoc-plugin-internal-external/-/typedoc-plugin-internal-external-1.0.10.tgz#df9fd6ee1743f009c39b8746a3c26edc36ce8bcd"
50985121

5099-
5100-
version "1.0.0"
5101-
resolved "https://registry.yarnpkg.com/typedoc-plugin-single-line-tags/-/typedoc-plugin-single-line-tags-1.0.0.tgz#4210b4fbd18d9b8f753e151047965195b4081261"
5102-
51035122
51045123
version "1.0.6"
51055124
resolved "https://registry.yarnpkg.com/typedoc-plugin-ui-router/-/typedoc-plugin-ui-router-1.0.6.tgz#6d452d499d1bd35701ebfdeb2beee670d8530e8b"
51065125

5107-
typedoc@0.9.0:
5108-
version "0.9.0"
5109-
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.9.0.tgz#159bff7c7784ce5b91d86f3e4cc8928e62040957"
5110-
dependencies:
5111-
"@types/fs-extra" "4.0.0"
5112-
"@types/handlebars" "4.0.31"
5113-
"@types/highlight.js" "9.1.8"
5114-
"@types/lodash" "4.14.74"
5115-
"@types/marked" "0.3.0"
5116-
"@types/minimatch" "2.0.29"
5117-
"@types/shelljs" "0.7.0"
5126+
typedoc@0.8.0:
5127+
version "0.8.0"
5128+
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.8.0.tgz#d7172bc6a29964f451b7609c005beadadefe2361"
5129+
dependencies:
5130+
"@types/fs-extra" "^4.0.0"
5131+
"@types/handlebars" "^4.0.31"
5132+
"@types/highlight.js" "^9.1.8"
5133+
"@types/lodash" "^4.14.37"
5134+
"@types/marked" "0.0.28"
5135+
"@types/minimatch" "^2.0.29"
5136+
"@types/shelljs" "^0.7.0"
51185137
fs-extra "^4.0.0"
51195138
handlebars "^4.0.6"
51205139
highlight.js "^9.0.0"

0 commit comments

Comments
 (0)