@appium/mcp-documentation 1.0.3 → 1.0.4

package/src/resources/submodules/appium/packages/driver-test-support/README.md

@@ -0,0 +1,103 @@
+# @appium/driver-test-support
+
+> Testing utilities for [Appium](https://appium.io) drivers
+
+This package is for driver authors to help test their drivers.
+
+[Mocha](https://mochajs.org) is the supported test framework.
+
+## Usage
+
+### For E2E Tests
+
+The `driverE2ETestSuite` method creates a Mocha test suite which makes HTTP requests to an in-memory server leveraging your driver.
+
+Note that this method must be run within a _suite callback_—not a _test callback_.
+
+```js
+import {driverE2ETestSuite} from '@appium/driver-test-support';
+
+const defaultW3CCapabilities = {
+  // some capabilities
+};
+
+describe('MyDriverClass', function() {
+  driverE2ETestSuite(MyDriverClass, defaultW3CCapabilities);
+
+  describe('more tests', function() {
+    // ...
+  });
+});
+```
+
+### For Unit Tests
+
+The `driverUnitTestSuite` method creates a Mocha test suite which performs assertions on an isolated instance of your driver.
+
+Note that this method must be run within a _suite callback_—not a _test callback_.
+
+```js
+import {driverUnitTestSuite} from '@appium/driver-test-support';
+
+const defaultW3CCapabilities = {
+  // some capabilities
+};
+
+describe('MyDriverClass', function() {
+  driverUnitTestSuite(MyDriverClass, defaultW3CCapabilities);
+
+  describe('more tests', function() {
+    // ...
+  });
+});
+```
+
+### Helpers
+
+These are just some helpers (mainly for E2E tests):
+
+```js
+import {TEST_HOST, getTestPort, createAppiumURL} from '@appium/driver-test-support';
+import assert from 'node:assert';
+
+describe('TEST_HOST', function() {
+  it('should be localhost', function() {
+    assert.strictEqual(TEST_HOST, '127.0.0.1');
+  });
+});
+
+describe('getTestPort()', function() {
+  it('should get a free test port', async function() {
+    const port = await getTestPort();
+    assert.ok(port > 0);
+  });
+});
+
+describe('createAppiumURL()', function() {
+  const urlFor = createAppiumURL(TEST_HOST, 31337);
+
+  it('should create a "new session" URL', function() {
+    assert.strictEqual(urlFor('', 'session'), `http://${TEST_HOST}:31337/session`);
+  });
+
+  it('should create a URL for a session command', function() {
+    const sessionId = '12345';
+    assert.strictEqual(
+      urlFor(sessionId, 'moocow'),
+      `http://${TEST_HOST}:31337/session/${sessionId}/moocow`
+    );
+  });
+});
+```
+
+## Installation
+
+`appium` and `mocha` are peer dependencies.
+
+```bash
+npm install appium mocha @appium/driver-test-support --save-dev
+```
+
+## License
+
+Apache-2.0

package/src/resources/submodules/appium/packages/eslint-config-appium-ts/CHANGELOG.md

@@ -0,0 +1,256 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.2.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.2.1...@appium/eslint-config-appium-ts@3.2.2) (2026-05-31)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [3.2.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.2.0...@appium/eslint-config-appium-ts@3.2.1) (2026-05-06)
+
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** set new ESLint 10 rules to 'warn' ([#22251](https://github.com/appium/appium/issues/22251)) ([98a1735](https://github.com/appium/appium/commit/98a1735913bcc02be7574156e0f13e1d05fcb87f))
+
+
+
+## [3.2.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.1.0...@appium/eslint-config-appium-ts@3.2.0) (2026-05-06)
+
+
+### Features
+
+* **eslint-config-appium-ts:** Add rule to warn if a type is not imported properly ([#22226](https://github.com/appium/appium/issues/22226)) ([bde5bd5](https://github.com/appium/appium/commit/bde5bd57f4b64bacf6750338e9c9e88ae3cebea1))
+* **eslint-config-appium-ts:** support ESLint 10 ([#22236](https://github.com/appium/appium/issues/22236)) ([4849ad0](https://github.com/appium/appium/commit/4849ad015d331a91dc7c013dda151ee432870293))
+
+
+
+## [3.1.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.0.2...@appium/eslint-config-appium-ts@3.1.0) (2026-04-23)
+
+
+### Features
+
+* **eslint-config-appium-ts:** Add new rules ([#22164](https://github.com/appium/appium/issues/22164)) ([a929cd6](https://github.com/appium/appium/commit/a929cd6024e7312877037e348d57cee054e4875e))
+
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** Suppress lint warnings ([#22190](https://github.com/appium/appium/issues/22190)) ([6476197](https://github.com/appium/appium/commit/6476197bfffcfbfb1d8819ebd13fd0a54de1bca6))
+
+
+
+## [3.0.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.0.1...@appium/eslint-config-appium-ts@3.0.2) (2026-04-09)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [3.0.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@3.0.0...@appium/eslint-config-appium-ts@3.0.1) (2026-03-08)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [3.0.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.5...@appium/eslint-config-appium-ts@3.0.0) (2026-01-26)
+
+
+### ⚠ BREAKING CHANGES
+
+* **eslint-config-appium-ts:** modernize ESLint config (#21781)
+
+### Features
+
+* **eslint-config-appium-ts:** add unicorn/prefer-node-protocol with warn ([#21864](https://github.com/appium/appium/issues/21864)) ([77c9b58](https://github.com/appium/appium/commit/77c9b5898907d7380276d5982c7e175d10440c73))
+* **eslint-config-appium-ts:** modernize ESLint config ([#21781](https://github.com/appium/appium/issues/21781)) ([b0b219a](https://github.com/appium/appium/commit/b0b219aa019d893bf30e90203a8265625777c47f))
+
+
+
+## [2.0.5](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.4...@appium/eslint-config-appium-ts@2.0.5) (2025-12-04)
+
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** update eslint-plugin-mocha to v11 ([#21722](https://github.com/appium/appium/issues/21722)) ([cabe2e5](https://github.com/appium/appium/commit/cabe2e53bc6d7b23cefc80334eb5d0aa89a72d4f))
+
+
+
+## [2.0.4](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.3...@appium/eslint-config-appium-ts@2.0.4) (2025-11-12)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [2.0.3](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.2...@appium/eslint-config-appium-ts@2.0.3) (2025-10-08)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [2.0.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.1...@appium/eslint-config-appium-ts@2.0.2) (2025-09-09)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [2.0.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.0...@appium/eslint-config-appium-ts@2.0.1) (2025-08-20)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [2.0.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@2.0.0-rc.1...@appium/eslint-config-appium-ts@2.0.0) (2025-08-18)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [2.0.0-rc.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@1.0.3...@appium/eslint-config-appium-ts@2.0.0-rc.1) (2025-08-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* set minimum Node.js version to v20.19.0 (#21394)
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** adjust dependency configuration ([#21444](https://github.com/appium/appium/issues/21444)) ([e3f05cf](https://github.com/appium/appium/commit/e3f05cf961310a5bf144cc0bf8e1089c47744493))
+
+
+### Miscellaneous Chores
+
+* set minimum Node.js version to v20.19.0 ([#21394](https://github.com/appium/appium/issues/21394)) ([37e22c4](https://github.com/appium/appium/commit/37e22c4f9c9920cea3f340841ab1b7c60e3147e9))
+
+
+
+## [1.0.4](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@1.0.3...@appium/eslint-config-appium-ts@1.0.4) (2025-04-25)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [1.0.3](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@1.0.2...@appium/eslint-config-appium-ts@1.0.3) (2025-02-19)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [1.0.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@1.0.1...@appium/eslint-config-appium-ts@1.0.2) (2025-01-08)
+
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** add Prettier config, update typescript-eslint imports ([#20887](https://github.com/appium/appium/issues/20887)) ([aad5709](https://github.com/appium/appium/commit/aad57099135a02907b0cd03617c52d7baf248a26))
+
+
+
+## [1.0.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.3.3...@appium/eslint-config-appium-ts@1.0.1) (2025-01-02)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## 1.0.0 [Unreleased]
+
+### ⚠ BREAKING CHANGES
+
+* This module is now ESM-only
+* Only ESLint flat config format is supported
+* Bump minimum ESLint version to v9
+* Rule changes:
+  * `@typescript-eslint/no-var-requires`: 'error' -> 'off'
+  * `import/no-unresolved` is no longer set to 'off' for `*.test-d.ts` files
+  * `no-redeclare`: 1 -> 'off'
+* New rules for all files:
+  * `@typescript-eslint/no-empty-object-type`: 'off'
+  * `@typescript-eslint/no-require-imports`: 'off'
+  * `import/named`: 'warn'
+  * `no-dupe-class-members`: 'off'
+* New rules only for test files:
+  * `@typescript-eslint/no-unused-expressions`: 'off'
+  * `import/no-named-as-default-member`: 'off'
+  * `mocha/consistent-spacing-between-blocks`: 'off'
+  * `mocha/max-top-level-suites`: 'off'
+  * `mocha/no-exports`: 'off'
+  * `mocha/no-setup-in-describe`: 'off'
+  * `mocha/no-skipped-tests`: 'off'
+
+
+
+## [0.3.3](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.3.2...@appium/eslint-config-appium-ts@0.3.3) (2024-04-08)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [0.3.2](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.3.1...@appium/eslint-config-appium-ts@0.3.2) (2023-10-18)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+## [0.3.1](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.3.0...@appium/eslint-config-appium-ts@0.3.1) (2023-04-03)
+
+**Note:** Version bump only for package @appium/eslint-config-appium-ts
+
+
+
+
+
+# [0.3.0](https://github.com/appium/appium/compare/@appium/eslint-config-appium-ts@0.2.0...@appium/eslint-config-appium-ts@0.3.0) (2023-03-28)
+
+
+### Bug Fixes
+
+* **eslint-config-appium-ts:** disable brace-style rule ([409192d](https://github.com/appium/appium/commit/409192d0630244e072534391eb702de063d54d17))
+
+
+* feat(eslint-config-appium-ts)!: enable for JS sources ([43df77f](https://github.com/appium/appium/commit/43df77f6b623462d20d90cb23a2d7577aa0c56de))
+
+
+### BREAKING CHANGES
+
+* This makes `@appium/eslint-config-appium-ts` also apply to JS sources _and_ requires a new peer dependency (`eslint-import-resolver-typescript`). The `main` file is now a `.js` file.  The module is expected to _extend_ `@appium/eslint-config-appium`, not replace it; consumers needn't extend both in their ESLint config.
+
+In the not-too-distant past, `@typescript-eslint/parser` was unable to understand docstrings in `.js` files. Evidently this is no longer true.
+
+I've rewritten and heavily commented the configuration explaining the intent behind everything.
+
+
+
+
+
+# 0.2.0 (2023-03-08)
+
+
+### Features
+
+* **eslint-config-appium-ts:** create new pkg @appium/eslint-config-appium-ts ([dfe02ca](https://github.com/appium/appium/commit/dfe02ca98c73c0cf9863a7c7441d6a1a5d37ac33))

package/src/resources/submodules/appium/packages/eslint-config-appium-ts/README.md

@@ -0,0 +1,47 @@
+# @appium/eslint-config-appium-ts
+
+> Provides a reusable [ESLint](http://eslint.org/) [shared configuration](http://eslint.org/docs/developer-guide/shareable-configs) for [Appium](https://github.com/appium/appium) and Appium-adjacent projects.
+
+[![NPM version](http://img.shields.io/npm/v/@appium/eslint-config-appium-ts.svg)](https://npmjs.org/package/@appium/eslint-config-appium-ts)
+[![Downloads](http://img.shields.io/npm/dm/@appium/eslint-config-appium-ts.svg)](https://npmjs.org/package/@appium/eslint-config-appium-ts)
+
+## Usage
+
+Install the package:
+
+```bash
+npm install @appium/eslint-config-appium-ts --save-dev
+```
+
+Then add it to your `eslint.config.mjs` file:
+
+```js
+import appiumConfig from '@appium/eslint-config-appium-ts';
+import {defineConfig} from 'eslint/config';
+
+export default defineConfig([
+  {
+    extends: [appiumConfig],
+    // add any other config changes 
+  },
+]);
+```
+
+Or for ESLint `< 9.22.0`:
+
+```js
+import appiumConfig from '@appium/eslint-config-appium-ts';
+
+export default [
+  ...appiumConfig,
+  // add any other config changes 
+];
+```
+
+## Notes
+
+- This configuration is intended to be used alongside [Prettier](https://www.npmjs.com/package/prettier).
+
+## License
+
+Copyright © 2023 OpenJS Foundation. Licensed Apache-2.0