mirror of
https://github.com/appium/appium.git
synced 2026-10-22 16:54:52 +08:00
Edgars Eglītis
5070a34739
* docs: update universal-xml-plugin readme * chore: fix line lengths * docs: update relaxed-caps-plugin readme * docs: update images-plugin readme * docs: update fake-plugin readme * docs: add readme for execute-driver-plugin * docs: update base-plugin readme * docs: update test-support readme * docs: update support readme * docs: update opencv readme * docs: update fake-driver readme * docs: update docutils readme * docs: update doctor readme * docs: update base-driver readme * docs: fix badge for base-driver * docs: slightly improve base-driver/plugin readme * docs: fix title for eslint-config-appium-ts * docs: add badges for non-prerelease packages * docs: update appium readme * docs: update some readme links * chore: address review comments
@appium/eslint-config-appium-ts
Provides a reusable ESLint shared configuration for Appium and Appium-adjacent projects (for TypeScript)
Motivation
If your package has no TypeScript sources, you don't need this. However, if your package does have TypeScript sources, you can't lint those files without this.
Usage
Install the package with npm v8 or newer:
npm install @appium/eslint-config-appium-ts --save-dev
And then, in your .eslintrc file, extend the configuration:
{
"extends": "@appium/eslint-config-appium-ts"
}
Peer Dependencies
This config requires the following packages be installed (as peer dependencies) in your project. See the package.json for the required versions.
- eslint
- eslint-config-prettier
- eslint-plugin-import
- eslint-plugin-mocha
- eslint-plugin-promise
- @appium/eslint-config-appium
- @typescript-eslint/eslint-plugin
- @typescript-eslint/parser
Notes
- This configuration is intended to be used alongside Prettier.
License
Copyright © 2023 OpenJS Foundation. Licensed Apache-2.0