npm 包 remark-lint-no-file-name-mixed-case 使用教程

阅读时长 4 分钟读完

简介

remark-lint-no-file-name-mixed-case 是一个用于 remark 的 lint 插件,它可以检查文件名是否符合指定的大小写规范。

安装

你可以通过 npm 进行安装:

使用

首先,在你的 markdown 文件中添加文件名:

然后,运行 Remark CLI:

如果没有错误信息输出,则表示文件名符合指定的大小写规范。

配置选项

该插件提供了两个配置选项:

  • case: 可选值为 "lower""upper",默认为 "lower"。表示文件名应该使用哪种大小写。
  • ignore: 可以是正则表达式或字符串数组。如果文件名匹配 ignore,则不会被检查。

例如,以下配置将忽略所有以 _ 开头的文件名:

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

---------
  --------------
  ----------
  ------------------------- - ------- ---- --
  ----------- ------ ---------- ----- -- -
    ----------------- -- --- ------ --------
  --
展开代码

示例代码

以下是一个用于检查所有 markdown 文件的脚本:

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

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

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

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

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

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

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

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

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

---------------------- -- -
  --------------------------
  ---------------
--
展开代码

以上就是 remark-lint-no-file-name-mixed-case 的使用教程。它可以帮助你规范文件名大小写,避免因为大小写问题导致的错误。

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

纠错
反馈

纠错反馈