npmpackage.info

@appium/typedoc-plugin-appium

Cross-platform automation framework for all kinds of apps, built on top of the W3C WebDriver protocol

0.6.6

19,333

Apache-2.0

JavaScript

59.75 kB

5,419,930 4.9

Installations

npm install @appium/typedoc-plugin-appium

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

^14.17.0 || ^16.13.0 || >=18.0.0

Node Version

18.17.0

NPM Version

lerna/6.6.2/node@v18.17.0+arm64 (darwin)

Score

65.8

Supply Chain

82.5

Quality

74.2

Maintenance

Vulnerability

89.6

License

Pull Requests

Open

1

Total

6,290

Closed

734

Merged

5,555

Issues

Open

132

Total

13,807

Closed

13,675

Releases

1,276

@appium/test-support@3.1.3

Published on 08 Jan 2025

@appium/eslint-config-appium-ts@1.0.2

Published on 08 Jan 2025

@appium/support@6.0.3

Published on 08 Jan 2025

@appium/base-plugin@2.3.0

Published on 08 Jan 2025

@appium/images-plugin@3.0.27

Published on 08 Jan 2025

appium@2.15.0

Published on 08 Jan 2025

View all 1,276 releases

Contributors

353

View all 353 contributors

Languages

JavaScript

TypeScript

HTML

Shell

Python

Ruby

CSS

JavaScript (79.43%)

TypeScript (19.38%)

HTML (0.99%)

Shell (0.09%)

Python (0.05%)

Ruby (0.04%)

CSS (0.03%)

Developer

appium

Download Statistics

Total Downloads

5,419,930

Last Day

2,114

Last Week

9,733

Last Month

46,401

Last Year

1,841,376

GitHub Statistics

19,333 Stars

11,296 Commits

6,116 Forks

883 Watching

142 Branches

353 Contributors

Bundle Size

198.65 kB

Minified

59.75 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.6.6

Package Id

@appium/typedoc-plugin-appium@0.6.6

Unpacked Size

459.98 kB

Size

101.56 kB

File Count

196

NPM Version

lerna/6.6.2/node@v18.17.0+arm64 (darwin)

Node Version

18.17.0

Publised On

17 Aug 2023

Total Downloads

Cumulative downloads

Total Downloads

5,419,930

Last day

-27.9%

2,114

Compared to previous day

Last week

-23.8%

9,733

Compared to previous week

Last month

-9.1%

46,401

Compared to previous month

Last year

-48.5%

1,841,376

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

handlebars lodash pluralize type-fest

Peer Dependencies

appium typedoc typedoc-plugin-markdown typedoc-plugin-resolve-crossmodule-references typescript

Versions

`@appium/typedoc-plugin-appium`

TypeDoc plugin for Appium & its extensions

Overview

This package leverages TypeDoc to generate command documentation (HTTP endpoints, payload information, etc.) for Appium v2+ drivers and plugins.

Important Note

If you are an Appium extension author and just want to build HTML docs, don't install this directly--instead, install @appium/docutils, which is a higher-level package that configures everything for you.

If you only want to build markdown docs for your extension, then you can use this package directly.

Installation

npm v8+ is required to install this package.

1npm install @appium/typedoc-plugin-appium --save-dev

The above command installs the plugin as well as all necessary peer dependencies. See package.json for the full list of dependencies.

Usage

TypeDoc is configured via a typedoc.json or typedoc.js file (read the docs for more information).

An Appium extension author wishing to generate markdown documentation for their extension will need to create a typedoc.json. At minimum, it should contain:

1{
2  "entryPointStrategy": "packages",
3  "entryPoints": ["."],
4  "name": "<name of extension>",
5  "theme": "appium",
6  "out": "<path to output directory>"
7}

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, as well as the following:

`outputModules`

boolean - Output module, class, interface, and other type information (the usual TypeDoc output) in addition to command documentation. This is needed for full documentation of types. Default value: true

`outputBuiltinCommands`

boolean - Outputs all commands and types from Appium builtins--not just your extension. This is intended to be used by Appium itself. Default value: false

`packageTitles`

Array<{name: string, title: string}>: An array of objects containing module name name and display name title. By default, the module name is used for the title; use this to override that behavior. Default value: undefined

`commandsDir`

string - The name of the "commands" directory relative to the TypeDoc output directory (out). Default value: commands

`forceBreadcrumbs`

boolean - Forces breadcrumbs to be output; overrides hideBreadcrumbs from typedoc-plugin-markdown. Default value: false

Development

This packages uses snapshot tests to assert the generated markdown is correct. If you have made changes which affect the plugin's output, you will need to update the snapshots.

To update the snapshots, execute:

1UPDATE_SNAPSHOT=1 npm run test:e2e

This will (likely) modify the snapshots in your working copy, so you will then need to commit them.

License

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-labeler.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/auto-labeler.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/clean-cache.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/clean-cache.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-update-docs-resources.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-update-docs-resources.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-update-docs-resources.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-update-docs-resources.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/deploy.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/deploy.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/docs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fossa.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/fossa.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/fossa.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/fossa.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-hold.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/on-hold.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-title.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/pr-title.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/renovate.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/renovate.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/renovate.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/renovate.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/deploy.yml:38
Warn: npmCommand not pinned by hash: .github/workflows/deploy.yml:40
Warn: pipCommand not pinned by hash: .github/workflows/docs.yml:48
Warn: downloadThenRun not pinned by hash: .github/workflows/fossa.yml:23
Warn: pipCommand not pinned by hash: .github/workflows/publish-doc.yml:35
Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 12 third-party GitHubAction dependencies pinned
Info: 2 out of 4 npmCommand dependencies pinned
Info: 0 out of 2 pipCommand dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More