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

Flat ESLint support #12679

Merged
merged 2 commits into from Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/eslint-plugin-wdio/docs/rules/no-debug.md
@@ -1,6 +1,6 @@
# Disallow browser.debug() in tests (wdio/no-debug)

`browser.debug()` statements are only useful for debuggging tests and should not be committed into the codebase.
`browser.debug()` statements are only useful for debugging tests and should not be committed into the codebase.

## Rule Details

Expand Down
19 changes: 9 additions & 10 deletions packages/eslint-plugin-wdio/package.json
Expand Up @@ -5,19 +5,18 @@
"author": "Christian Bromann <mail@bromann.dev>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio",
"license": "MIT",
"type": "module",
"main": "./cjs/index.js",
"module": "./build/index.js",
"types": "./build/index.d.ts",
"exports": {
".": [
{
"types": "./build/index.d.ts",
"import": "./build/index.js",
"require": "./cjs/index.js"
},
"./cjs/index.js"
]
"import": {
"types": "./build/index.d.ts",
"default": "./build/index.js"
},
"require": {
"types": "./build/index.d.ts",
"default": "./cjs/index.js"
}
},
"typeScriptVersion": "3.8.3",
"engines": {
Expand All @@ -40,6 +39,6 @@
},
"devDependencies": {
"@types/estree": "^1.0.1",
"eslint": "^8.10.0"
"eslint": "^9.0.0"
}
}
67 changes: 44 additions & 23 deletions packages/eslint-plugin-wdio/src/index.ts
Expand Up @@ -2,31 +2,52 @@ import awaitExpect from './rules/await-expect.js'
import noDebug from './rules/no-debug.js'
import noPause from './rules/no-pause.js'

const rules = {
'await-expect': awaitExpect,
'no-debug': noDebug,
'no-pause': noPause
const sharedGlobals = {
$: false,
$$: false,
browser: false,
driver: false,
expect: false,
multiremotebrowser: false,
} as const

const sharedConfig = {
rules: {
'wdio/await-expect': 'error',
'wdio/no-debug': 'error',
'wdio/no-pause': 'error',
},
} as const

const index = {
configs: {},
rules: {
'await-expect': awaitExpect,
'no-debug': noDebug,
'no-pause': noPause,
},
}

const legacyConfig = {
...sharedConfig,
globals: sharedGlobals,
plugins: ['wdio'],
}

const configs = {
recommended: {
globals: {
$: false,
$$: false,
browser: false,
driver: false,
expect: false,
multiremotebrowser: false,
},
rules: {
'wdio/await-expect': 'error',
'wdio/no-debug': 'error',
'wdio/no-pause': 'error',
}
}
const flatConfig = {
...sharedConfig,
languageOptions: {
globals: sharedGlobals,
},
plugins: {
wdio: index,
},
}

export {
rules,
configs,
export = {
...index,
configs: {
'flat/recommended': flatConfig,
recommended: legacyConfig,
},
}