npm 包 gg-linter 使用教程

阅读时长 3 分钟读完

简介

gg-linter 是一款基于 eslint 和 prettier 的前端代码静态检查工具,能够帮助开发者在编写代码过程中检查语法、格式等问题,提高代码质量,代码质量的提高能够提高代码可维护性,降低维护成本。

安装

通过 npm 进行安装:

配置

在项目中新建 .eslintrc.prettierrc 文件,并配置相关规则:

.eslintrc

-- -------------------- ---- -------
-
  ---------- -----------------------
  ---------------- -
    -------------- --
    ------------- ---------
    --------------- -
      ------ ----
    -
  --
  ------ -
    ---------- -----
    ------- -----
    ------ ----
  --
  ---------- ----------
  -------- --
-

.prettierrc

使用

在开发过程中,可以通过 npm script 进行使用:

  • lint:检查项目中的代码,如果有错误则输出。可以加入 --quiet 参数,只输出 error 级别的消息。
  • lint-fix:查找项目中的错误,并尝试自动修复。

示例代码

-- -------------------- ---- -------
------ ----- ---- -------
------ --------- ---- ------------

---
 - ------ -------- ----- --
 - ------ -------- ------- --
 --
-------- ----------- -
  ----- - ------ ------- - - -----
  ------ -
    ---- -----------------
      ---- -------------------------------------
      ---- -------------------------------------
    ------
  -
-

-------------- - -
  ------ ----------------------------
  -------- ---------------------------
-

------ ------- ----

以上代码是使用 gg-linter 进行检查后的示例代码,包括了 propTypes 的检查、ES lint 的检查以及 prettier 的格式化等,代码质量大大提高。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005589d81e8991b448d5e28

纠错
反馈