Commit Graph

9600 Commits

Author SHA1 Message Date
renovate[bot] 172bdae436 fix(types): update definitelytyped 2023-02-05 00:47:22 +00:00
renovate[bot] 8129a228a9 fix(support): update dependency jimp to v0.17.10 2023-02-04 23:08:22 +00:00
renovate[bot] 9ce3263918 fix(support): update dependency jimp to v0.16.13 2023-02-04 11:37:47 +00:00
renovate[bot] c342bb0eed chore(docutils): update dependency mkdocs-material to v9.0.11 2023-02-04 09:56:59 +00:00
renovate[bot] e92911f5ca fix(docutils): update dependency type-fest to v3.5.4 2023-02-03 23:36:13 +00:00
Christopher Hiller abfeb21be6 feat(docutils): implement mkdocs validation
- Better grouping of `validate` command options in `--help`
- Move some more constants into the module
- Removed the "guess" functions and replaced them with functions which use `which` to actually find the necessary executables
- Moved `isStringArray()` to `util`
- Fixed some error messages and added more
- Simplified use of `DocutilsValidator#fail()`
- Removed option for custom path to `requirements.txt`
2023-02-03 11:54:02 -08:00
renovate[bot] 706efcf9cf chore(docutils): update dependency mkdocs-material to v9.0.10 2023-02-03 15:38:21 +00:00
renovate[bot] bcda967fec chore(deps): update dependency @types/yargs to v17.0.22 2023-02-03 12:01:13 +00:00
Christopher Hiller db4a1d6489 fix(typedoc-plugin-appium): better top-level header for extension reflection
It now shows "Command API" if there's only one 3p extension we're documenting, and "(name) Command API" if there are multiple (e.g. in the case of a monorepo)
2023-02-02 16:25:45 -08:00
Christopher Hiller f16e6c8a16 chore(docutils): tweak some logging 2023-02-02 16:25:45 -08:00
Christopher Hiller 6bb06e2c19 feat(typedoc-plugin-appium): implemented outputBuiltinCommands
This value defaults to `false`, as extension authors will typically not want that stuff.

As with removal of non-command reflections (via the plugin's `outputModules` option), this happens in a post-processing step after conversion but before rendering.
2023-02-02 16:25:45 -08:00
Christopher Hiller d9304d8212 chore(docutils): when complete, build command mentions the site dir 2023-02-02 16:25:45 -08:00
Christopher Hiller 21eb6b59f8 fix(docutils): disallow both --no-reference and --no-site
also add a final "done" message
2023-02-02 16:25:45 -08:00
Christopher Hiller 3872d40291 docs(docutils): more docstrings dogg 2023-02-02 16:25:45 -08:00
Christopher Hiller f96eb8652f chore(docutils): remove cruft from mkdocs module and refactor 2023-02-02 16:25:45 -08:00
Christopher Hiller 73ff1b8f3c fix(docutils): fix logic for 'include' prop of tsconfig.json 2023-02-02 16:25:45 -08:00
Christopher Hiller 53b60bc3bb feat(docutils): add a --no-reference-header option 2023-02-02 16:25:45 -08:00
Christopher Hiller fee07d38c3 fix(typedoc-plugin-appium): fix type and test problems
- Re-enable `strict` mode
- Fix failures arising from that
- Fix E2E test failures
2023-02-02 16:25:45 -08:00
Christopher Hiller 5960cc89ac chore(docutils): break out fs-related functions in util into their own module 2023-02-02 16:25:45 -08:00
Christopher Hiller 749569323f fix(typedoc-plugin-appium): command headings should be the command name
per discussion with @jlipps
2023-02-02 16:25:45 -08:00
Christopher Hiller 7c3d2b78e8 docs(types): hide internal remarks on ExternalDriver.createSession
`@remarks` is just kind of for "notes" or rumination, and `@privateRemarks` is the same but _for developers_.
2023-02-02 16:25:45 -08:00
Christopher Hiller 4f457468bb feat(docutils): do not fail on first validation error
This modifies the validator to collect all of the errors from validation (except those that are "unexpected" though not _so_ unexpected that I did not account for them; stuff like "unparseable output from `pip list --json`") and display them as they happen without aborting the entire validation process.
2023-02-02 16:25:45 -08:00
Christopher Hiller 8fbbdb93a2 fix(docutils): lint 2023-02-02 16:25:45 -08:00
Christopher Hiller 8a1ed8921f chore(docutils): simpler implementation for global log level control 2023-02-02 16:25:45 -08:00
Christopher Hiller 082197bd2b feat(docutils): enable updating of mkdocs nav based on commands
- also fix bad arg names
2023-02-02 16:25:45 -08:00
Christopher Hiller 93b5831e3a feat(docutils): add mkdocs output to build command
`build` now executes both `typedoc` and `mkdocs` unless options to one run or the other are passed.

- renamed `init-task` to `scaffold`
- renamed `build` to `typedoc`
- fix JSON5 stringification
- use typedoc's facilities for reading its own config files, which absolves us from having to expand the `extends` prop in `typedoc.json` (if any)
2023-02-02 16:25:45 -08:00
Christopher Hiller ccf5d3a638 chore(typedoc): refactor CLI cmds into separate modules 2023-02-02 16:25:45 -08:00
Christopher Hiller ab202aa673 feat(docutils): add "validate" command
The `validate` command checks the status of the environment and reports any problems to the user.

This includes Python env and dep checks, typescript and typedoc checks of installed version and configuration files (to varying degrees).

Also:

- Convert `mkdocs.js` to TS; remove `assertMkDocs` as that moved into the `validate` module
- JSON5 support for `tsconfig.json` (this is important, because the default `tsconfig.json` is a JSON5 file)
- Sorted the options in the `cli` module
- Renamed `types` to `model`
- Moved some constants into new module `constants`
2023-02-02 16:25:45 -08:00
Christopher Hiller 4955948651 feat(docutils): begin doc-generation cli
This provides some tools for extension authors to easily setup and configure their packages to build docs and create documentation via TypeDoc & mkdocs.
2023-02-02 16:25:45 -08:00
Christopher Hiller 3cd22ef4fb fix(typedoc-plugin-appium): add test-related types to tsconfig
(since we build test files via ts in this package)
2023-02-02 16:25:45 -08:00
Christopher Hiller 94940b274f fix(tsconfig): remove test-related types from shared tsconfig
These can be added on a per-module basis, for now
2023-02-02 16:25:45 -08:00
Christopher Hiller ed8af17334 fix(deps): update for npm audit 2023-01-31 10:48:17 -08:00
renovate[bot] 16d73357da fix(support): update dependency shell-quote to v1.8.0 2023-01-31 17:45:42 +00:00
renovate[bot] 27c8e0cc2e chore(docutils): update dependency mkdocs-material to v9.0.9 2023-01-31 13:53:17 +00:00
renovate[bot] cfb529772c fix(types): update dependency type-fest to v3.5.4 2023-01-30 15:37:17 +00:00
renovate[bot] 44bc6e4646 chore(docutils): update dependency mkdocs-material to v9.0.8 2023-01-30 11:40:15 +00:00
renovate[bot] 2dc8eb6856 chore(deps): update dependency eslint to v8.33.0 2023-01-29 12:35:02 +00:00
renovate[bot] 76a6ec0e67 chore(docutils): update dependency mkdocs-material to v9.0.7 2023-01-29 09:16:02 +00:00
Kazuaki Matsuo 6efcdd8605 docs(appium): remove unused jp resources (#18116) 2023-01-27 22:41:05 -08:00
Christopher Hiller 6c26b97124 fix(typedoc-plugin-appium): use simple filenames for ExtensionReflection objects
Closes #18110
2023-01-27 12:21:54 -08:00
Jonathan Lipps 388df9d30b docs(appium): include all reference output in docs build 2023-01-26 13:24:05 -08:00
ian zhang d43de6fdc6 docs(appium): #18104 Update build-drivers with zh-lang (#18108)
* #18104
Update build-drivers with zh-lang

* #18104
Update as upstream commit
2023-01-26 10:16:13 -08:00
Jonathan Lipps 1cd2a7df99 docs(appium): add plugin development guide 2023-01-25 12:21:18 -08:00
Kazuaki Matsuo 0f95213398 fix: add missing ' in an error message (#18105) 2023-01-25 11:28:36 -08:00
renovate[bot] 644f300cd8 fix(types): update dependency @types/express to v4.17.16 2023-01-24 10:56:47 +00:00
Christopher Hiller c5451e4d82 fix(base-driver,driver-test-support,support): update types for axios@1.2.3 2023-01-23 18:24:25 -08:00
renovate[bot] 20c176bae7 fix(support): update dependency axios to v1.2.3 2023-01-23 18:24:25 -08:00
renovate[bot] 444b9886a2 fix(execute-driver-plugin): update dependency webdriverio to v7.30.0 2023-01-23 18:24:08 -08:00
Christopher Hiller c8ff39a02e chore: do not publish tsconfig.tsbuildinfo
apparently the "files" prop does not take into account what the ".npmignore" file says, so these were still getting published.

hopefully this will fix it.
2023-01-23 16:39:36 -08:00
Christopher Hiller 4734673ac9 chore(execute-driver-plugin,support,types): use named tuples
The "old" way of defining tuples is `[T, U]`, but I think TS 4.7 introduced "named" tuples, which at least provides a little bit of context to consumers, e.g., `[foo: T, bar: U]`.  Since a tuple is just a fixed-length array, the names aren't actually used in code, but are surfaced in type information and error messages regardless.

Also:

- Fixed bad param name in definition of `SessionHandler`
- Used a semantically-correct type for `StopScreenRecordOptions.formFields`
2023-01-23 16:39:06 -08:00