New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

wdio-eslinter-service

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

wdio-eslinter-service - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

src/config/eslintrc-conf-unresolved-only.js
src/eslint-unresolved-error-handler.js
src/eslint-unresolved-npx-runner.js
src/eslint-unresolved-runner.js
test/eslint-unresolved-runner.spec.js
test/file-with-bad-import.js

11

package.json
{
"name": "wdio-eslinter-service",
"version": "0.0.3",
"version": "0.0.4",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "mocha test/**.spec.js"
},

@@ -25,4 +25,11 @@ "keywords": [

"@wdio/logger": "^7.5.3",
"chai": "^4.3.6",
"mocha": "^9.2.1",
"webdriverio": "^7.5.7"
},
"dependencies": {
"eslint": "^8.11.0",
"eslint-import-resolver-custom-alias": "^1.3.0",
"eslint-plugin-import": "^2.25.4"
}
}

114

README.md

@@ -9,2 +9,3 @@ # wdio-eslinter-service

The recommended configuration is to use the unresolved runner to just check missing imports, but if desired, you can also configure the service to run the eslinter in your project using the npm or yarn runner, or by passing in a flag that tells the system to use your .eslintrc configuration as well.

@@ -19,15 +20,107 @@ ## Installation

If you don't already have eslint installed and configured, you'll need to install it and configure it in your project:
### Quick Start - Check for missing or unresolved imports only
By default, this minimal configuration, the "unresolved" runner, checks for unresolved require imports and throws an error if unresolved imports are found. The service then stops execution. You can customize .eslintrc.js to perform more checks using the "npm" or "yarn" runners, if desired. See [eslint](https://www.npmjs.com/package/eslint) for more details.
If you don't have an `.eslintrc.js` configuration in your project, then wdio-eslinter-service can be configured to use a default one which just checks for missing imports before running the tests. This is handy so that you find out about incorrect imports sooner rather than later. To configure this, add the following eslinter configuration to your services array (assuming you already are using the chromedriver service; otherwise, leave that part out):
**wdio.conf.js:**
```
services: ['chromedriver', [
'eslinter',
{
runnerType: 'unresolved'
}
]],
```
At this point, start running the tests, and if there is a missing or incorrect import, WebdriverIO will log it and immediately terminate the test run:
```
$ npx wdio
```
#### Optional - if using module-alias
If you're using the [module-alias](https://www.npmjs.com/package/module-alias) module, which lets you configure aliases to replace relative paths, you'll need to pass that into the eslinter configuration using the eslint-import-resolver-custom-alias plugin. Below is an example:
```
services: ['chromedriver', [
'eslinter',
{
runnerType: 'unresolved',
eslintOverride: {
"settings": {
"import/resolver": {
"eslint-import-resolver-custom-alias": {
"alias": {
"@utils": "./utils",
"@specs": "./test-sync/specs",
"@pageobjects": "./test-sync/pageobjects",
"@": "./"
}
}
}
}
}
}
]],
```
Install the plugin in your project:
```
$ npm i eslint-import-resolver-custom-alias
```
Run the tests and verify the system will find incorrect imports that use module aliases:
```
$ npx wdio
```
#### Experimental - Use along with an existing eslintrc configuration in your project
To also have the eslinter service use an existing eslintrc configuration in your project, set `includeProjectEslintrc` to true in the wdio.conf.js configuration services array.
I've experienced problems with conflicting plugins. If your project eslint setup is also looking for unresolved imports, then this may not work and may require adjustments to your .eslintrc.js. This is not recommended at this time.
### Advanced Alternatives - Using the npm and yarn runners
The npm and yarn runners help give you additional control over running an existing eslinter setup in your project. With this configuration, you can define extra commands to run in the run-scripts section in your package.json:
Inside your `package.json`, add this entry to your run scripts:
```json
{
"scripts": {
"eslint": "eslint ."
}
}
```
**NOTE: Adding eslint to the package.json is required for the service to function when using the npm or yarn runners.**
If you don't already have eslint installed and configured, you'll need to install it and configure it in your project, as well as any plugins you're using, such as eslint-plugin-import:
```
$ npm i eslint eslint-plugin-import
```
Put `.eslintrc.js` in the root of your Node.js project:
If you're using eslint-import-resolver-custom-alias plugin to map module aliases to their real paths, then you'll need to install it as well:
```
$ npm i eslint-import-resolver-custom-alias
```
You'll also need to create an `.eslintrc.js` file, if you don't already have one of the eslintrc configuration files in your project. Here is a basic setup to just look for unresolved imports, and you can expand this configuration to validate other code quality checks before running tests:
```
// .eslintrc.js
module.exports = {
"parserOptions": {
"ecmaVersion": 2018
"ecmaVersion": 2022
},

@@ -50,17 +143,2 @@ "plugins": [

By default, this minimal configuration checks for unresolved require imports and throws an error if unresolved imports are found. The service then stops execution. You can customize .eslintrc.js to perform more checks, if desired. See [eslint](https://www.npmjs.com/package/eslint) for more details.
Inside your `package.json`, add this entry to your run scripts:
```json
{
"scripts": {
"eslint": "eslint ."
}
}
```
**NOTE: Adding eslint to the package.json is required for the service to function.**
Lastly, add the `eslinter` service to the services array in `wdio.conf.js`:

@@ -67,0 +145,0 @@

4

src/eslint-npm-runner.js

@@ -5,6 +5,6 @@ // eslint-npm-runner.js

module.exports = function (scriptName) {
module.exports = function (opts) {
return new Promise((resolve, reject) => {
const npmCmd = process.platform.match('^win') !== null ? 'npm.cmd' : 'npm';
const eslint = spawn(npmCmd, ['run', scriptName, '--silent'], { stdio: "inherit" });
const eslint = spawn(npmCmd, ['run', opts.scriptName, '--silent'], { stdio: "inherit" });

@@ -11,0 +11,0 @@ eslint.on('close', (code) => {

4

src/eslint-yarn-runner.js

@@ -5,6 +5,6 @@ // eslint-yarn-runner.js

module.exports = function (scriptName) {
module.exports = function (opts) {
return new Promise((resolve, reject) => {
const yarnCmd = process.platform.match('^win') !== null ? 'yarn.cmd' : 'yarn';
const eslint = spawn(yarnCmd, ['run', '--silent', scriptName], { stdio: "inherit" });
const eslint = spawn(yarnCmd, ['run', '--silent', opts.scriptName], { stdio: "inherit" });

@@ -11,0 +11,0 @@ eslint.on('close', (code) => {

23

src/launcher.js

@@ -12,2 +12,4 @@ const wdioLogger = require('@wdio/logger').default

this.options.scriptName = 'eslint';
if(!this.options.includeProjectEslintrc)
this.options.includeProjectEslintrc = false;
logger.warn(`initialize wdio-eslinter-service using ${this.options.runnerType} runner.`)

@@ -20,3 +22,3 @@ }

const runEslint = require(`./eslint-${this.options.runnerType}-runner`)
return runEslint(this.options.scriptName).then((code) => {
return runEslint(this.options).then((code) => {
logger.info('eslint checks passed...')

@@ -28,3 +30,7 @@ resolve()

}).catch((err) => {
logger.error('SEVERE: Code contains eslint errors or eslint not installed. Exiting...')
const type = this.options.runnerType
if(customErrorHandlerExists(type))
handleErrorsWithErrorHandler(type, err)
else
logger.error('SEVERE: Code contains eslint errors or eslint not installed. Exiting...')
process.exit(1)

@@ -35,2 +41,15 @@ })

const fs = require('fs')
function customErrorHandlerExists(type) {
const eslintErrorHandlerFile = `eslint-${type}-error-handler.js`
return fs.existsSync(`node_modules/wdio-eslinter-service/src/${eslintErrorHandlerFile}`)
}
function handleErrorsWithErrorHandler(type, err) {
const eslintErrorHandlerFile = `eslint-${type}-error-handler.js`
const eslintErrorHandler = require(`./${eslintErrorHandlerFile}`)
eslintErrorHandler.handleError(err)
}
module.exports = EslintLauncherService;
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc