npm 包 organize-raw 使用教程

如果你是前端开发人员或是想学习前端开发，那么你一定知道使用 npm 包的重要性。今天我们要介绍一款非常有用的 npm 包，它就是 organize-raw。

organize-raw 是什么？

organize-raw 是一个可以帮助你在项目开发过程中，自动将源代码进行组织的 npm 包。它可以将你的源代码自动归类到不同的目录下，使得你的项目更加清晰，结构更加合理。

如何使用 organize-raw？

使用 organize-raw 非常简单，我们只需要在终端中运行以下命令即可：

npm install organize-raw --save-dev

然后在 package.json 文件的 scripts 字段中添加以下代码：

{
  "scripts": {
    "organize": "node node_modules/organize-raw/cli.js your-directory"
  }
}

其中 your-directory 是你想要进行目录组织的目录名。

之后我们只需要在终端中运行以下代码即可：

npm run organize

organize-raw 就会自动帮我们组织我们的文件，将它们归类到不同的目录下。

organize-raw 有哪些组织规则？

organize-raw 目前支持以下组织规则：

根据文件类型

organize-raw 可以将你的文件按照文件类型进行组织。例如将所有的 .js 文件归类到一个名为 js 的目录下，将所有的 .css 文件归类到一个名为 css 的目录下。

例如：

your-directory
├── index.js
├── main.css
└── other-file.js

经过 organize-raw 的处理之后，目录中的文件将被自动组织为：

your-directory
├── css
│   └── main.css
├── js
│   ├── index.js
│   └── other-file.js

根据文件名

organize-raw 还可以将你的文件按照文件名进行组织。例如将所有以 index 开头的文件归类到一个名为 index 的目录下，将所有以 main 开头的文件归类到一个名为 main 的目录下。

例如：

your-directory
├── index.js
├── index.html
├── main.css
└── main.js

经过 organize-raw 的处理之后，目录中的文件将被自动组织为：

your-directory
├── index
│   ├── index.js
│   └── index.html
├── main
│   ├── main.css
│   └── main.js

如何配置 organize-raw？

我们可以在 package.json 文件的 scripts 字段中添加以下代码，来对 organize-raw 进行配置：

{
  "scripts": {
    "organize": "node node_modules/organize-raw/cli.js your-directory --type=byFilename"
  }
}

其中 type 参数可以取值为 byType 和 byFilename。如果我们不设置 type 参数，那么 organize-raw 将默认按照 byType 进行组织。

总结

通过本文的介绍，我们学习了如何使用 npm 包 organize-raw，以及它支持的目录组织规则。organize-raw 可以帮助我们自动组织源代码，使得项目更加清晰易懂。在实际的项目中，我们可以结合 organize-raw 的具体组织规则，来为自己的项目进行合理的目录组织，从而提高项目的可维护性和可读性。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005700281e8991b448e7c8b