docs: API

.yarnclean

@@ -5,15 +5,16 @@ tests
 powered-test
 
 # asset directories
-docs
-doc
-website
-images
-assets
+# breaks jsdoc2md
+#docs
+#doc
+#website
+#images
+#assets
 
 # examples
-example
-examples
+#example
+#examples
 
 # code coverage directories
 coverage
@@ -41,5 +42,4 @@ Gruntfile.js
 *.gz
 *.md
 
-!tslint/lib/test
-!tslint\lib\test
+!tslint/lib/test

docs/Options.md

@@ -133,7 +133,7 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well.
 | nodeGypRebuild | <a name="Config-nodeGypRebuild"></a>Whether to execute `node-gyp rebuild` before starting to package the app. Defaults to `false`.
 | electronDist | <a name="Config-electronDist"></a>The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows.
 | electronDownload | <a name="Config-electronDownload"></a>The [electron-download](https://github.com/electron-userland/electron-download#usage) options.
-| publish | <a name="Config-publish"></a>See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration).
+| publish | <a name="Config-publish"></a><ul> <li>Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS).</li> <li></li> <li>See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration).</li> </ul>
 | forceCodeSigning | <a name="Config-forceCodeSigning"></a>Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct).
 | electronVersion | <a name="Config-electronVersion"></a>The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.
 | artifactName | <a name="Config-artifactName"></a><p>The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). Defaults to <code>${productName}-${version}.${ext}</code> (some target can have another defaults, see corresponding options).</p> <p>Currently supported only for <code>mas</code>, <code>pkg</code>, <code>dmg</code> and <code>nsis</code>.</p>

docs/Publishing Artifacts.md

@@ -58,73 +58,14 @@ But please consider using automatic rules instead of explicitly specifying `publ
 
 ## Publish Options
 
-[publish](#PublishConfiguration) can be specified in the [configuration options](https://github.com/electron-userland/electron-builder/wiki/Options#Config) or any platform- or target- specific options.
+See [GithubOptions](https://github.com/electron-userland/electron-builder/wiki/API#electron-builder-httpoutpublishoptionsgithuboptions--publishconfiguration),
+[S3Options](https://github.com/electron-userland/electron-builder/wiki/API#electron-builder-httpoutpublishoptionss3options--publishconfiguration),
+[BintrayOptions](https://github.com/electron-userland/electron-builder/wiki/API#module_electron-builder-http/out/publishOptions.BintrayOptions).
+
+Can be specified in the [configuration options](https://github.com/electron-userland/electron-builder/wiki/Options#Config) or any platform- or target- specific options.
 
 ```json
 "win": {
   "publish": ["github", "bintray"]
 }
 ```
-
-<!-- do not edit. start of generated block -->
-* [publish](#PublishConfiguration)
-* [publish Amazon S3](#S3Options)
-* [publish Bintray](#BintrayOptions)
-* [publish Generic (any HTTP(S) server)](#GenericServerOptions)
-* [publish GitHub](#GithubOptions)
-
-<a name="PublishConfiguration"></a>
-### `publish`
-
-Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options.
-
-If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`.
-If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`.
-
-Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS).
-
-Amazon S3 — `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public.
-
-| Name | Description
-| --- | ---
-| **provider** | <a name="PublishConfiguration-provider"></a>The provider, one of `github`, `s3`, `bintray`, `generic`.
-| owner | <a name="PublishConfiguration-owner"></a>The owner.
-
-<a name="S3Options"></a>
-### `publish` Amazon S3
-
-[Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html).
-
-| Name | Description
-| --- | ---
-| **bucket** | <a name="S3Options-bucket"></a>The bucket name.
-| path | <a name="S3Options-path"></a>The directory path. Defaults to `/`.
-| channel | <a name="S3Options-channel"></a>The channel. Defaults to `latest`.
-| acl | <a name="S3Options-acl"></a>The ACL. Defaults to `public-read`.
-| storageClass | <a name="S3Options-storageClass"></a>The type of storage to use for the object. One of `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`. Defaults to `STANDARD`.
-
-<a name="BintrayOptions"></a>
-### `publish` Bintray
-| Name | Description
-| --- | ---
-| package | <a name="BintrayOptions-package"></a>The Bintray package name.
-| repo | <a name="BintrayOptions-repo"></a>The Bintray repository name. Defaults to `generic`.
-| user | <a name="BintrayOptions-user"></a>The Bintray user account. Used in cases where the owner is an organization.
-
-<a name="GenericServerOptions"></a>
-### `publish` Generic (any HTTP(S) server)
-| Name | Description
-| --- | ---
-| **url** | <a name="GenericServerOptions-url"></a>The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros.
-| channel | <a name="GenericServerOptions-channel"></a>The channel. Defaults to `latest`.
-
-<a name="GithubOptions"></a>
-### `publish` GitHub
-| Name | Description
-| --- | ---
-| repo | <a name="GithubOptions-repo"></a>The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository).
-| vPrefixedTagName | <a name="GithubOptions-vPrefixedTagName"></a>Whether to use `v`-prefixed tag name. Defaults to `true`.
-| host | <a name="GithubOptions-host"></a>The host (including the port if need). Defaults to `github.com`.
-| protocol | <a name="GithubOptions-protocol"></a><p>The protocol, one of <code>https</code> or <code>http</code>. Defaults to <code>https</code>.</p> <p>GitHub Publisher supports only <code>https</code>.</p>
-
-<!-- end of generated block -->

package.json

@@ -20,7 +20,8 @@
     "npm-publish": "yarn compile && ./packages/npm-publish.sh && conventional-changelog -p angular -i CHANGELOG.md -s",
     "schema": "typescript-json-schema packages/electron-builder/tsconfig.json Config --out packages/electron-builder/scheme.json --noExtraProps --useTypeOfKeyword --strictNullChecks",
     "jsdoc": "ts2jsdoc packages/electron-updater packages/electron-builder-http",
-    "docs": "rm -rf jsdoc/out/docs && jsdoc -R jsdoc/readme.md -c jsdoc/jsdoc.json -d jsdoc/out/docs"
+    "docs": "jsdoc2md --files 'jsdoc/out/**/*.js' --name-format --module-index-format grouped --separators --plugin dmd-tf > docs/API.md",
+    "api-docs": "node ./test/vendor/yarn.js docs && node ./test/vendor/yarn.js docs"
   },
   "//": "repository must be specified otherwise conventional-changelog will use forked repo (currently cloned)",
   "repository": "electron-userland/electron-builder",
@@ -30,7 +31,7 @@
     "ajv": "^5.0.3-beta",
     "ajv-keywords": "^2.0.1-beta.1",
     "archiver": "^1.3.0",
-    "aws-sdk": "^2.24.0",
+    "aws-sdk": "^2.25.0",
     "bluebird-lst": "^1.0.1",
     "chalk": "^1.1.3",
     "chromium-pickle-js": "^0.2.0",
@@ -55,7 +56,7 @@
     "sanitize-filename": "^1.6.1",
     "semver": "^5.3.0",
     "stat-mode": "^0.2.2",
-    "ts-jsdoc": "^1.0.0",
+    "ts-jsdoc": "^1.0.2",
     "tunnel-agent": "^0.6.0",
     "update-notifier": "^2.1.0",
     "uuid-1345": "^0.99.6",
@@ -64,7 +65,7 @@
   "devDependencies": {
     "@types/electron": "^1.4.33",
     "@types/ini": "^1.3.29",
-    "@types/jest": "^18.1.1",
+    "@types/jest": "^19.2.0",
     "@types/js-yaml": "^3.5.29",
     "@types/node-forge": "^0.6.6",
     "@types/source-map-support": "^0.2.28",
@@ -78,12 +79,12 @@
     "convert-source-map": "^1.4.0",
     "decompress-zip": "^0.3.0",
     "depcheck": "^0.6.7",
-    "docdash": "https://github.com/develar/docdash.git",
+    "dmd-tf": "^3.0.3",
     "electron-download-tf": "4.0.0",
     "jest-cli": "^19.0.2",
     "jest-environment-node-debug": "^2.0.0",
     "jest-junit": "^1.3.0",
-    "jsdoc": "^3.4.3",
+    "jsdoc-to-markdown": "^3.0.0",
     "path-sort": "^0.1.0",
     "source-map-support": "^0.4.11",
     "ts-babel": "^2.0.0",