forked from appium/appium
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(typedoc-plugin-appium): add options and 3p support
E2E tests are quasi-blocking on merge & release of TypeStrong/typedoc#2130; it is a huge pain to test without this. - Adds some options to control output - Rename `CommandsReflection` to `ExtensionReflection` due to poor granular control over the display name - Rename the custom "kinds"; add kinds for drivers and plugins (which affects display titles) - Remove namespace from "kinds" for same reason - Refactors, reformatting - Rename entry point from `plugin.ts` to `index.ts` - Update keywords in `package.json` for auto-discovery - Remove cruft from root `typedoc.json` - Update `README.md` - Update peer dependencies; the other plugins must be peer deps or typedoc will be unable to auto-discover them
- Loading branch information
Showing
31 changed files
with
525 additions
and
185 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,64 @@ | ||
# `@appium/typedoc-plugin-appium` | ||
|
||
> TypeDoc plugin for Appium & its extensions | ||
> TypeDoc plugin for [Appium](https://appium.io) & its extensions | ||
## Usage | ||
## Overview | ||
|
||
This package leverages [TypeDoc](https://typedoc.org) to generate command documentation (HTTP endpoints, payload information, etc.) for Appium v2+ drivers and plugins. | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install appium@next typedoc @appium/typedoc-plugin-appium --save-dev | ||
``` | ||
const typedocPluginAppium = require('@appium/typedoc-plugin-appium'); | ||
|
||
// TODO: DEMONSTRATE API | ||
`typedoc` and `appium` are peer dependencies of this package. Newer versions of `npm` will install these automatically (if possible). | ||
|
||
## Usage | ||
|
||
TypeDoc is configured via a `typedoc.json` or `typedoc.js` file ([read the docs](https://typedoc.org/guides/options/) for more information). | ||
|
||
An Appium extension author wishing to generate documentation for their extension will need to create a `typedoc.json`. At minimum, it should contain: | ||
|
||
> TODO: The plugin should be able to detect the entry points automatically, so this should not be necessary | ||
```json | ||
{ | ||
"entryPointStrategy": "packages", | ||
"entryPoints": [ | ||
"./node_modules/appium", | ||
"./node_modules/@appium/base-driver", | ||
"./node_modules/@appium/types", | ||
"." | ||
], | ||
"name": "<name of extension>", | ||
"out": "<path to output directory>" | ||
} | ||
``` | ||
|
||
Once this file is created, you can run `typedoc` to generate the documentation, and it will be output into the `out` directory as configured above. | ||
|
||
## Options | ||
|
||
This plugin supports all of the options from [typedoc-plugin-markdown](https://npm.im/typedoc-plugin-markdown), as well as the following: | ||
|
||
### `commandsDir` | ||
|
||
> TODO | ||
### `forceBreadcrumbs` | ||
|
||
> TODO | ||
### `outputBuiltinCommands` | ||
|
||
> TODO | ||
### `outputModules` | ||
|
||
> TODO | ||
## License | ||
|
||
Copyright © 2022 OpenJS Foundation. Licensed Apache-2.0 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
module.exports = require('./build/lib/plugin.js'); | ||
module.exports = require('./build/lib/index.js'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.