open-index/open-npm huggingface dataset:
npm package: @kythuen/webpack-builder-utils
Description: Utilities for webpack-builder
Author: Kythuen
Latest version: 3.0.7

# @kythuen/webpack-builder-utils

> [`webpack-builder-utils`](https://gitee.com/Kythuen/webpack-builder-utils)是为`webpack-builder`项目提供的工具库。所有与打包相关的通用工具函数都可以增加到此仓库中。

当前版本号：`1.1.0`

仓库地址：[码云Gitee](https://gitee.com/Kythuen/webpack-builder-utils)

### 使用方法

#### 安装

```shell
yarn add -D @kythuen/webpack-builder-utils
```

#### 使用

```js
const { Log, Types, FileHelper } = require('@kythuen/webpack-builder-utils')

Log.done('打印成功日志')

const isObject = Types.isPlainObject({a: 1})

FileHelper.loadFileSync(...)

```



### 仓库模块介绍

#### Log

*控制台打印日志，用于日志的统一化。*

现支持的日志类型有：`log`，`info`，`done`，`warn`，`error`

**函数使用方法**:  Log**[function] ([message]，[tag])**

**参数说明**：

- *message*：日志内容
- *tag*：日志的副标签

**返回值**：无返回

**使用方法举例**：

```js
Log.done('完成'，'tag标签')
```



#### Types

*常用变量类型的判断。*

现支持的判断的类型有：`isString`，`isNumber`，`isArray`，`isPlainObject`，`isFunction`，`isUndefined`、`isNull`

**函数使用方法**： Types**[function] ([value])**

**参数说明**：

- *value*：要判断的变量

**返回值**：布尔值

**使用方法举例**：

```js
const isObject = Types.isPlainObject({a:1})
```



#### FileHelper

*常用文件操作集合。*

现支持的操作有：`loadFileSync`

**函数使用方法**： FileHelper**[function] ([filePath])**

**参数说明**：

- *filePath*：要加载的文件的路径，相对工作目录的相对路径或者绝对路径

**返回值**：文件加载的结果，包含**加载状态**：`status`和**文件内容**：`data`

**返回值说明**：

- `status === 0`： 加载文件成功
- `status === -1`： 加载文件异常，未找到文件
- `status === -2`： 加载文件异常，找到文件但文件格式不对（*此文件应该导出一个对象或一个返回对象的函数*）

**使用方法举例**：

```js
const content = FileHelper.loadFileSync(filePath)
```


### 规划功能

- **FileHelper**中的`loadFileSync`函数，只能加载CommonJS规范的JavaScript文件。后面可能修改函数名为类似`FileHelper.commonjs.loadJSFileSync`。
- **FileHelper**中补充`loadFile`函数：异步加载JavaScript函数。


### 代码提交
使用前请先安装提交相关的开发依赖，全局或局部安装
```
yarn add -D commitizen cz-conventional-changelog conventional-changelog-cli replace standard-version
```