# jianmu-runner-eslint

**Repository Path**: jianmu-runners/jianmu-runner-eslint

## Basic Information

- **Project Name**: jianmu-runner-eslint
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-11
- **Last Updated**: 2022-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# jianmu-runner-eslint

#### 介绍

本节点的功能是对前端代码进行eslint检测检测，并进行格式错误的自动修正。默认配置支持以下文件的检测：
- JavaScript文件（.js）
- html文件（.html）
- Vue文件（.vue）
- React文件（.jsx）
用户可以将eslint的自定义配置文件作为节点参数传入，来实现更多的功能扩展。但是需要注意，部分扩展需要对package.json进行同步更新，安装相关依赖，保证拓展功能的正常执行。

####  输入参数

```
 files: 需要进行eslint格式化的代码文件的路径列表，一共两种：例：第一种（文件列表）：'["test1.js" , "test2.js" ]'。第二种（目录）："/root/*"。
 config_path: eslint配置文件，如".eslintrc.js"。若缺省，则采用默认配置
```

#### 输出参数

```
 file_total: 有效识别的文件总数
 file_error: 存在错误的文件数
 file_fixed: 成功修复所有错误的文件数（eslint支持自动修复格式错误）
 file_need_fixed_byhand: 待手动修复错误的文件数（存在逻辑错误，eslint无法自动修复，只能手动修复）
```

#### 构建docker镜像

```
# 创建docker镜像
docker build -t jianmudev/jianmu-runner-eslint:${version} -f dockerfile/Dockerfile .

# 上传docker镜像
docker push jianmudev/jianmu-runner-eslint:${version}
```

#### 用法

```
docker run --rm \
  -e JIANMU_FILES=xxx \
  -e JIANMU_CONFIG_PATH=xxx \
  jianmudev/jianmu-runner-eslint:${version}
```