跳到內容

Appium 設定檔

您不必在命令列上傳遞引數給 Appium,而是可以將它們新增到特殊設定檔中。Appium 會在執行時從這個設定檔中讀取值。(請注意,CLI 引數優先於設定檔;如果值同時設定在設定檔和 CLI 引數中,則優先使用 CLI 引數。)

支援的設定檔格式

您可以將您的設定資料儲存在下列類型的檔案中

  • JSON
  • YAML
  • JS(匯出 JS 物件的 JavaScript 檔案)
  • CJS(與上述相同;副檔名是 common JS)

警告

注意:目前不支援 ESM 格式的設定檔。

支援的設定檔位置

設定檔可以命名為任何名稱,但 Appium 會自動偵測並載入下列檔名

  • .appiumrc.json(建議)
  • .appiumrc.yaml
  • .appiumrc.yml
  • .appiumrc.js
  • .appiumrc.cjs
  • appium.config.js
  • appium.config.cjs
  • .appiumrc(被視為 JSON)

此外,如果您的專案使用 Node.js,您可以使用 package.jsonappium 屬性內的儲存設定,它將自動被發現。

Appium 將從目前工作目錄向上搜尋目錄樹,尋找這些檔案之一。如果它到達目前使用者的家目錄或檔案系統根目錄,它將停止尋找。

若要為設定檔指定自訂位置,請使用 appium --config-file /path/to/config/file

設定檔格式

首先,您可能想查看一些範例

格式說明也已提供

用文字說明,設定檔將有一個根 server 屬性,所有引數都是子屬性。對於某些必須在命令列中提供為逗號分隔清單、JSON 字串和/或外部檔案路徑的屬性,這些屬性將採用其「原生」類型。例如,--use-plugins <value> 需要 <value> 為逗號分隔字串或指向分隔檔案的路徑。然而,設定檔只需要一個陣列,例如

{
  "server": {
    "use-plugins": ["my-plugin", "some-other-plugin"]
  }
}

設定擴充功能(驅動程式和外掛程式)

對於driverplugin特定設定,這些設定會分別存在於 server.driverserver.plugin 屬性中。每個驅動程式或外掛程式將有其自己的命名屬性,且它提供的任何特定設定的值都在此屬性中。例如

{
  "server": {
    "driver": {
      "xcuitest": {
        "webkit-debug-proxy-port": 5400
      }
    }
  }
}

注意

上述設定對應於 --driver-xcuitest-webkit-debug-proxy-port CLI 引數。

所有屬性都區分大小寫,且將採用 kebab-case。例如,callback-port 是允許的,但 callbackPort 則不行。