使用脚本整合指定文件/文件夹，执行定制化 ESLint 命令-阿里云开发者社区

使用脚本整合指定文件/文件夹，执行定制化 ESLint 命令

2023-11-01 56

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 描述了如何通过自定义脚本简化 ESLint 命令的执行。该脚本支持指定文件或文件夹，指定 ESLint 配置文件，附带命令，以及前后置执行命令等功能，极大地提高了代码检查和格式化的效率。

背景

最近面对一个庞大的项目，但是只需要修改某个模块，每次都手搓命令太麻烦了，于是就想着能不能写个脚本来辅助处理这些事情。

解决方案

定制化一键 ESLint，执行文件下载地址：

https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.4.0

Assets

基础使用

以下案例以 macOS 为例，其他系统自行替换对应的文件。

案例 1：指定文件 file1.js 和 file2.js，使用默认的配置。

#!/bin/bash
./eslint-files-mac-darwin-amd64 -files="file1.js,file2.js"

案例 2：指定文件夹 src/views 和 src/components。

#!/bin/bash
./eslint-files-mac-darwin-amd64 -folders="/root/app/src/views,/root/app/src/components"

配合根目录 root 使用指定文件夹：

#!/bin/bash
./eslint-files-mac-darwin-amd64 \
  -folders="src/views,src/components" \
  -root="/root/app/"

案例 3：指定 ESLint 配置文件 custom.eslintrc.js 和命令 --fix。

#!/bin/bash
./eslint-files-mac-darwin-amd64 \
  -folders="/root/app/src/views" \
  -esConf="custom.eslintrc.js" \
  -esCom="--fix"

复杂场景

指定 ESLint 配置文件 custom.eslintrc.js；
指定附带命令 --fix；
指定文件和文件夹；
指定文件后缀；
添加前置和后置执行命令。

#!/bin/bash
./eslint-files-mac-darwin-amd64 \
  -files="file1.js,file2.js" \
  -folders="src/views,src/components" \
  -root="/root/app/" \
  -esConf="custom.eslintrc.js" \
  -esCom="--fix" \
  -ext=".js,.ts,.jsx,.vue,.tsx" \
  -befCom="echo 'Starting format';" \
  -aftCom="echo 'Format completed';"

参数说明

参数	说明	默认	示例	是否必须
`files`	指定文件，多个文件用 `,` 分隔。	-	`file1.js,file2.js`	可选
`folders`	指定文件夹，多个文件夹用 `,` 分隔。	-	`src/views,src/components`	可选
`esConf`	指定 ESLint 配置文件。	-	`custom.eslintrc.js`	可选
`esCom`	指定附带命令。	-	`--fix`	可选
`root`	指定根目录，配合 `folders` 使用。	-	`/root/app/`	可选
`ext`	指定文件后缀。	`.js`	`.js,.ts,.jsx,.vue`	可选
`befCom`	指定前置执行命令。	-	`echo 'Starting format';`	可选
`aftCom`	指定后置执行命令。	-	`echo 'Format completed';`	可选
`filesRang`	指定文件范围，统计处理过和未处理的文件。	-	`/root/app/`	可选