mirror of
https://github.com/appium/appium.git
synced 2026-03-02 23:30:59 -06:00
4746080e54
Run `npm run typedoc` to generate docs in `typedoc-docs` dir. I thought I'd take a few mins and set this up. It was _mostly_ straightforward, except: 1. Figuring out the "entry point" for each package was difficult until I realized `.js` entry points are assumed to be compiled, and thus require a `sourceMappingUrl` reference. IMO this is probably a bug in TypeDoc 2. The `sourceMappingUrl` must reference an external sourcemap file; not an inline source map. If it's an inline source map, the system tries to `fs.open` a large data-url. 3. The babel config does not control whether external sourcemaps are created; `@babel/cli` does. So I needed to change those. 4. Practically speaking, I don't see any drawback to external sourcemaps _yet_ 5. TypeDoc has poor support for cross-package type references in monorepos, and I had to add a plugin which implements a workaround 6. Per some suggestions in the docs, I modified the order of references in the root `tsconfig.json` to start with "the biggest one first" I didn't modify any types or docstrings anywhere.
33 lines
491 B
JSON
33 lines
491 B
JSON
{
|
|
"presets": [
|
|
[
|
|
"@babel/preset-env",
|
|
{
|
|
"targets": {
|
|
"node": "14"
|
|
},
|
|
"shippedProposals": true
|
|
}
|
|
]
|
|
],
|
|
"plugins": ["source-map-support"],
|
|
"comments": false,
|
|
"sourceMaps": true,
|
|
"env": {
|
|
"coverage": {
|
|
"plugins": [
|
|
[
|
|
"istanbul",
|
|
{
|
|
"exclude": ["test", "build"]
|
|
}
|
|
]
|
|
]
|
|
},
|
|
"test": {
|
|
"retainLines": true,
|
|
"comments": true
|
|
}
|
|
}
|
|
}
|