Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(typedoc-appium-plugin): implement cross-referencing of methods #17971

Merged
merged 4 commits into from
Jan 3, 2023

Commits on Dec 30, 2022

  1. 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
    boneskull committed Dec 30, 2022
    Configuration menu
    Copy the full SHA
    3aea8dd View commit details
    Browse the repository at this point in the history
  2. chore(typedoc-plugin-appium): better sorting, refactors

    trying to make some things less opaque.  maybe failed
    boneskull committed Dec 30, 2022
    Configuration menu
    Copy the full SHA
    c0314f1 View commit details
    Browse the repository at this point in the history
  3. feat: create @appium/tsconfig

    For the TypeDoc plugin to correctly pull information from `@appium/types` and `@appium/base-driver`, they both need `tsconfig.json` files.
    
    They currently _have_ `tsconfig.json` files, but they extend base configs in the monorepo root, which is problematic.  Moving the configs into a package seems reasonable.  Further, all packages must publish `tsconfig.json`.  There's precedent for publishing a `tsconfig.json` this way.
    
    FWIW the `paths` and `references` fields in the `tsconfig.json` files seem to be ignored by TypeDoc, so we can get away with this.
    boneskull committed Dec 30, 2022
    Configuration menu
    Copy the full SHA
    6501425 View commit details
    Browse the repository at this point in the history

Commits on Jan 3, 2023

  1. chore(base-driver): do not use EmptyObject

    I do not trust it
    boneskull committed Jan 3, 2023
    Configuration menu
    Copy the full SHA
    d2873d4 View commit details
    Browse the repository at this point in the history