resin-lint中文文档|resin-lint js中文教程|解析

npm npmdoc 2年前 (2022-01-02) 1303次浏览

resin-lint中文文档|resin-lint js中文教程|解析

安装命令:npm i resin-lint

resin-lint

resin-lint基于棉绒coffeelint
coffeescope2tslint漂亮检测基于Resin.io编码规范的风格的错误。

概述

resin-lint使用 Resin 的coffeelint.json,tslint.json.prettierrc如果一个coffeelint.jsontslint.json在待LINTED项目目录中找到或者其父母随后的规则发现它会使用默认合并resin-lint的。另一种覆盖默认resin-lint规则的方法是使用-f参数指定配置文件

打字稿

默认情况下,只会对.coffee文件进行 linted。.ts.tsx文件可以通过使用--typescript参数来检查。

更漂亮

您可以将更漂亮的配置文件从./config/.prettierrc. 您可以使用--no-prettier参数禁用更漂亮的格式检查

用法

您可以将此模块用作:

  1. 一个独立的项目,通过安装它npm install -g resin-lint
kostas@macbook:~/resin/test$ resin-lint src/
  ✓ src/test.coffee

  ✓ Ok! » 0 errors and 0 warnings in 1 file
  1. 在开发依赖package.json具有npm install --save-dev resin-lint然后您可以在构建/测试过程中使用该模块:
package.json
------------
...
"scripts": {
  "lint": "resin-lint src/ && echo \"Done!\""
},
...

kostas@macbook:~/resin/test$ npm run lint

> test@1.0.0 lint /Users/kostas/resin/test
> resin-lint src/ && echo "Done!"

  ✓ src/test.coffee

  ✓ Ok! » 0 errors and 0 warnings in 1 file

  Done!

  1. 开发依赖项,将由您的 IDE/编辑器 coffeelint/tslint/prettier 获取。

在您的项目根目录中手动创建这些配置文件:

tslint.json

// if using prettier in your project
{
    "extends": [
        "resin-lint/config/tslint-prettier.json"
    ]
}
 
// plain TypeScript
{
    "extends": [
        "resin-lint/config/tslint.json"
    ]
}

对于咖啡林创建 coffeelint.json

{
    "extends": [
        "resin-lint/config/coffeelint.json"
    ]
}

对于更漂亮的配置创建 .prettierrc.js

const fs = require('fs');
 
module.exports = JSON.parse(fs.readFileSync('./node_modules/resin-lint/config/.prettierrc', 'utf8'));

支持

如果您遇到任何问题,请在 GitHub 上提出问题,Resin.io 团队将很乐意提供帮助。

测试

通过执行以下操作运行测试套件:

$ npm install && npm test

贡献

在提交 PR 之前,请确保您包含测试,并且npm run lint在没有警告的情况下运行。

执照

该项目在 Apache 2.0 许可下获得许可。

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:resin-lint中文文档|resin-lint js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}