forge/typedoc.jsonc at main · electron/forge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
{
  "$schema": "https://typedoc.org/schema.json",
  "out": "api-docs",
  "entryPointStrategy": "packages",
  "entryPoints": [
    "packages/api/core",
    "packages/maker/*",
    "packages/plugin/*",
    "packages/publisher/*",
    "packages/utils/types",
  ],
  "sourceLinkExternal": false,
  "externalSymbolLinkMappings": {
    // @electron-forge/shared-types
    "@electron/packager": {
      "OfficialArch": "https://packages.electronjs.org/packager/v20.0.3/types/OfficialArch.html",
      "OfficialPlatform": "https://packages.electronjs.org/packager/v20.0.3/types/OfficialPlatform.html",
      "Options": "https://packages.electronjs.org/packager/v20.0.3/interfaces/Options.html",
      "HookFunction": "https://packages.electronjs.org/packager/v20.0.3/types/HookFunction.html",
      "FinalizePackageTargetsHookFunction": "https://packages.electronjs.org/packager/v20.0.3/types/FinalizePackageTargetsHookFunction.html",
      "IgnoreFunction": "https://packages.electronjs.org/packager/v20.0.3/types/IgnoreFunction.html",
      "PackagerOsxSignOptions": "https://packages.electronjs.org/packager/v20.0.3/interfaces/PackagerOsxSignOptions.html",
      "PackagerUniversalOptions": "https://packages.electronjs.org/packager/v20.0.3/interfaces/PackagerUniversalOptions.html",
      "MacOSProtocol": "https://packages.electronjs.org/packager/v20.0.3/interfaces/MacOSProtocol.html",
      "Win32MetadataOptions": "https://packages.electronjs.org/packager/v20.0.3/interfaces/Win32MetadataOptions.html",
      "PackagerWindowsSignOptions": "https://packages.electronjs.org/packager/v20.0.3/interfaces/PackagerWindowsSignOptions.html",
      // Ignored as not part of Forge for API consumers
      "Options.dir": "#",
      "Options.arch": "#",
      "Options.platform": "#",
      "Options.out": "#",
    },
    "@electron/get": {
      "ElectronDownloadRequestOptions": "https://packages.electronjs.org/get/v4.0.2/interfaces/ElectronDownloadRequestOptions.html",
    },
    "@electron/asar": {
      "CreateOptions": "https://packages.electronjs.org/asar/v4.0.1/types/CreateOptions.html",
    },
    "@electron/rebuild": {
      "RebuildOptions": "https://packages.electronjs.org/rebuild/v4.2.0/interfaces/RebuildOptions.html",
    },
    "listr2": {
      "ListrBaseClassOptions": "https://listr2.kilic.dev/api/listr2/interfaces/ListrBaseClassOptions.html",
      "ListrTask": "https://listr2.kilic.dev/api/listr2/interfaces/ListrTask.html",
      "TaskWrapper": "https://listr2.kilic.dev/api/listr2/interfaces/ListrTaskWrapper.html",
      "ListrDefaultRenderer": "https://listr2.kilic.dev/api/listr2/type-aliases/ListrDefaultRenderer.html",
      "ListrDefaultRendererValue": "https://listr2.kilic.dev/api/listr2/type-aliases/ListrDefaultRendererValue.html",
      "ListrSimpleRenderer": "https://listr2.kilic.dev/api/listr2/type-aliases/ListrSimpleRenderer.html",
      "ListrSimpleRendererValue": "https://listr2.kilic.dev/api/listr2/type-aliases/ListrSimpleRendererValue.html",
    },
    "@types/node": {
      "\"child_process\".ChildProcess": "https://nodejs.org/api/child_process.html#class-childprocess",
      // Ignored as part of Node.js docs (there's intentional link to Node docs instead in hierarchy)
      "\"child_process\".fork": "#",
      "\"child_process\".spawn": "#",
      "\"child_process\".exec": "#",
      "EventEmitter.defaultMaxListeners": "#",
    },
    // @electron-forge/maker-dmg
    "electron-installer-dmg": {
      // Links to in-interface names
      "__type.name": "#name",
    },
    // @electron-forge/maker-snap
    "electron-installer-snap": {
      "createSnap.Options": "https://electron-userland.github.io/electron-installer-snap/master/interfaces/createsnap.snapcraftoptions.html",
      "createSnap.SnapcraftConfig": "https://electron-userland.github.io/electron-installer-snap/master/modules/createsnap.html#customsnapcraftconfig",
    },
    // @electron-forge/maker-squirrel
    "@electron/windows-sign": {
      "SignToolOptions": "https://packages.electronjs.org/windows-sign/v2.0.6/interfaces/SignToolOptions.html",
    },
    "electron-winstaller": {
      // Links to in-interface names
      "SquirrelWindowsOptions.authors": "#authors",
      "SquirrelWindowsOptions.certificateFile": "#certificatefile",
      "SquirrelWindowsOptions.certificatePassword": "#certificatepassword",
      "SquirrelWindowsOptions.remoteReleases": "#remotereleases",
      "SquirrelWindowsOptions.owners": "#owners",
      "SquirrelWindowsOptions.usePackageJson": "#usepackagejson",
      "SquirrelWindowsOptions.windowsSign": "#windowssign",
    },
    // @electron-forge/plugin-fuses
    "@electron/fuses": {
      "FuseConfig": "https://packages.electronjs.org/fuses/v2.1.3/types/FuseConfig.html",
    },
    // @electron-forge/plugin-webpack
    "webpack": {
      "exports.Configuration": "https://webpack.js.org/configuration/",
    },
    "webpack-dev-server": {
      "Configuration": "https://webpack.js.org/configuration/dev-server/",
    },
    // @electron-forge/publisher-gcs
    "@google-cloud/storage": {
      "ConfigMetadata": "https://docs.cloud.google.com/storage/docs/metadata",
      "StorageOptions": "https://docs.cloud.google.com/nodejs/docs/reference/storage/latest/storage/storageoptions",
      "UploadOptions": "https://docs.cloud.google.com/nodejs/docs/reference/storage/latest/storage/uploadoptions",
    },
    // @electron-forge/publisher-github
    "@octokit/core": {
      "OctokitOptions": "https://github.com/octokit/core.js#options",
    },
    // @electron-forge/publisher-s3
    "@aws-sdk/types": {
      "Credentials": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-types/Interface/Credentials/",
    },
  },
  // Replaces previous *.base.json concept: it is
  // a per-package default documentation. It can still
  // be overwritten if needed with a per-package config.
  "packageOptions": {
    "excludeInternal": true,
    // Usually, we want to use "externalSymbolLinkMappings"
    // to point out symbols that are in external packages,
    // while allow for exceptions if Typedoc docs offer
    // better quality of documentation or upstream docs
    // are manually maintained and in risk of being
    // out-of-date.
    "excludeExternals": true,
  },
}