Commit Graph

11 Commits

Author SHA1 Message Date
Edgars Eglītis
7528fcf890 fix(docutils): remove @appium/typedoc-plugin-appium and all other uses of typedoc (#19465) 2023-12-05 08:46:07 +01:00
Christian Bromann
a959eec9cf docs(appium): Add contributing documentation (#18691) 2023-05-26 22:57:01 -07:00
Christopher Hiller
592f9adcb1 fix(typedoc-plugin-appium): parameter descriptions work
In #18132, I found that parameter descriptions of commands were being omitted from the output. Those descriptions have to come from a method, because they cannot be expressed in their original location (a method map) via JS or a docstring.

In addition, if an extension's implementation did not describe the parameters (e.g., in `@param` tags), we need to pull those descriptions out of `ExternalDriver` (assuming they exist).

Furthermore, we were executing the conversion _too early_ in TypeDoc's lifecycle, since its internal plugins haven't run yet. One of those plugins actually moves the `@param` comments from the _signature_ into the appropriate parameter. Once those are there, we can find them.

- Added a new list of "comment finders" which are parameter-specific (could probably do the same thing for return statements)
- Moved some functions into different modules and renamed a couple things to be more accurate.
- Update VSCode launch config
- `CommandData` now requires a reflection of a method. This was true before, but not formalized
2023-02-14 14:31:38 -08:00
Christopher Hiller
8b33414901 feat(typedoc-appium-plugin): implement cross-referencing of methods
This is getting pretty close, but:

- Commands from a driver will show even w/o a `newMethodMap` or `execMethodMap`; it is able to understand that it's overriding `BaseDriver`
- It's also able to understand the associated routes
- And it's able to understand the routes even if `BaseDriver` does not implement it

Still working on the parameters display, but we have the name override working at least.

Added some docstrings in `fake-driver`, `base-driver` for testing
2023-01-03 12:50:53 -08:00
Christopher Hiller
0c7fb7adeb chore(vscode): fix launch configurations
- Adds a "Run Appium" launch/debug config
- Fixes the "Run Current File" launch/debug config
- Fixes the monorepo's root TS config to handle requiring `ts-node/register` when `mocha` bootstrapped via `node`.  _`node`_ must require `ts-node`; not `mocha`.

Closes #17895
2022-12-09 12:29:51 -08:00
Christopher Hiller
0b8addb233 chore(): update vscode debug profiles 2022-11-22 14:32:10 -08:00
Christopher Hiller
78f6a23bd3 chore: dev script builds types
- `npm run dev` will build all artifacts in "watch" mode (distfiles and types)
- also updated the default build task for vscode
2022-04-12 14:54:22 -07:00
Christopher Hiller
37e7b8266c chore: update wallaby & vscode configs 2022-03-09 14:50:45 -08:00
Christopher Hiller
f0cb12d2e8 chore(eslint-config-appium): dev & test env improvements
- add `jsconfig.json` for the TS language server to understand the project
- update `.wallaby.js` to transpile fixtures if necessary; run on save to reduce lag
- update single-file Mocha debug launch config
- add `test` env in `babel.config.json` which is used by the former
- add some handy vscode tasks
- add a bunch of types
- remove unused `babel-eslint` (we use `@babel/eslint-parser`)
- bump `ecmaVersion` in `eslint-config-appium`
- remove cruft from babel configs (`shippedProposals: true` goes a long way)
- enable `sinon-chai` globally in tests
- add `rewiremock` for module-level mocking (sinon cannot do this itself, but they work in tandem)
2021-10-20 11:39:59 -07:00
Christopher Hiller
8800bc8aa3 chore: add babel config for debugging (wip) 2021-05-17 14:17:41 -07:00
Dan Graham
001e2f3674 Add VSCode launch configurations (#10683)
* Added debug, attach to debug, test-all, and test-current-file
* The debug and attach to debug allow you to run Appium server
* Made some changes to how package.json is located to support being able to run Mocha tests directly from 'test/' instead of from 'build/test/'
2018-05-15 11:35:46 -07:00