# node-utils

**Repository Path**: agile-development-system/node-utils

## Basic Information

- **Project Name**: node-utils
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-13
- **Last Updated**: 2021-12-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <img src="https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/logos/light/1.png" alt="logo">
</p>

# @agds/node-utils

**版本** ：1.0.18

agds系统内部node工具函数库

## 快速开始

### 安装

```bash
npm i @agds/node-utils
```

### 引入

```js
const utils = require('@agds/node-utils');
const { ConvName, FastPath, FastFs, Notice, PresetUtils, GitUtils, NpmUtils, CmdUtils } = utils;
```

### 导出

```js
module.exports = { ConvName, FastPath, FastFs, Notice, PresetUtils, GitUtils };
```

## 代码演示

```js
const { expect, test, describe } = require('@jest/globals');
const { ConvName, FastFs, FastPath, Notice, PresetUtils, CmdUtils, GitUtils, NpmUtils } = require('@agds/node-utils');
const path = require('path');
const fs = require('fs-extra');
describe('ConvName', () => {
    test('ConvName.initName', () => {
        const convName = ConvName.initName('ConvName-test');
        expect(convName).toMatchObject({
            lineName: 'conv-name-test',
            humpName: 'ConvNameTest',
            lowerHumpName: 'convNameTest',
        });
    });
    test('class ConvName', () => {
        const convName = new ConvName('ConvName-test');
        expect(convName).toMatchObject({
            lineName: 'conv-name-test',
            humpName: 'ConvNameTest',
            lowerHumpName: 'convNameTest',
        });
    });
    test('ConvName.toLine', () => {
        const name = ConvName.toLine('ConvName-test');
        expect(name).toBe('conv-name-test');
    });
    test('ConvName.toLowerHump', () => {
        const name = ConvName.toLowerHump('ConvName-test');
        expect(name).toBe('convNameTest');
    });
    test('ConvName.toUpperHump', () => {
        const name = ConvName.toUpperHump('ConvName-test');
        expect(name).toBe('ConvNameTest');
    });
});

const testText = 'Test';
describe('FastFs', () => {
    test('FastFs.writeFile', async () => {
        const pathName = path.join(__dirname, '.temp/FastFs.writeFile.test');
        await FastFs.writeFile(pathName, testText);
        expect(fs.readFileSync(pathName, { encoding: 'utf-8' })).toBe(testText);
    });
    test('FastFs.writeFileSync', () => {
        const pathName = path.join(__dirname, '.temp/FastFs.writeFileSync.test');
        FastFs.writeFileSync(pathName, testText);
        expect(fs.readFileSync(pathName, { encoding: 'utf-8' })).toBe(testText);
    });
    const statPathName = path.join(__dirname, '../__mock__/index.js');
    const statFalsePathName = path.join(__dirname, '../__mock__/index.jst');

    test('FastFs.getPathStat', async () => {
        const res = await FastFs.getPathStat(statPathName);
        expect(res).toBe(true);
    });
    test('FastFs.getPathStat false', async () => {
        const res = await FastFs.getPathStat(statFalsePathName);
        expect(res).toBe(false);
    });
    test('FastFs.getPathStatSync', () => {
        const res = FastFs.getPathStatSync(statPathName);
        expect(res).toBe(true);
    });
    test('FastFs.getPathStatSync false', () => {
        const res = FastFs.getPathStatSync(statFalsePathName);
        expect(res).toBe(false);
    });
    const obj = {
        a: 'a',
        b: 1,
    };
    test('FastFs.writeJsonFormat&FastFs.readJson', async () => {
        const pathName = path.join(__dirname, '.temp/FastFs.writeJsonFormat.json');
        await FastFs.writeJsonFormat(pathName, obj);
        expect(await FastFs.readJson(pathName)).toMatchObject(obj);
    });
    test('FastFs.writeJsonFormatSync&FastFs.readJsonSync', () => {
        const pathName = path.join(__dirname, '.temp/FastFs.writeJsonFormatSync.json');
        FastFs.writeJsonFormatSync(pathName, obj);
        expect(FastFs.readJsonSync(pathName)).toMatchObject(obj);
    });
    const json = require('../__mock__/json.json');
    const jsonPathName = path.join(__dirname, '../__mock__/json.json');
    test('FastFs.readJson', async () => {
        const res = await FastFs.readJson(jsonPathName);
        expect(res).toMatchObject(json);
    });
    test('FastFs.readJsonSync', () => {
        const res = FastFs.readJsonSync(jsonPathName);
        expect(res).toMatchObject(json);
    });
    test('FastFs parseJson error', () => {
        const jsonPathName = path.join(__dirname, '../__mock__/index.js');
        try {
            FastFs.readJsonSync(jsonPathName);
        } catch (error) {
            expect(error.message).toMatch(jsonPathName);
        }
    });
    test('FastFs.sortDependencies', () => {
        FastFs.sortDependencies(path.join(__dirname, '../__mock__/test-package.json'));
        expect(true).toBe(true);
    });
});

describe('FastPath', () => {
    test('FastPath.getCwdPath', () => {
        const res = FastPath.getCwdPath('package.json');
        expect(typeof res === 'string').toBe(true);
    });
    test('FastPath.getHomePath', () => {
        const res = FastPath.getHomePath('cache');
        expect(typeof res === 'string').toBe(true);
    });
    test('FastPath.getagdsHomePath', () => {
        const res = FastPath.getAgdsHomePath('cache');
        expect(typeof res === 'string').toBe(true);
    });
    test('FastPath.convPath', () => {
        const res = FastPath.convPath(__dirname, 'cache');
        expect(typeof res === 'string').toBe(true);
    });
    test('FastPath.convPath root', () => {
        const res = FastPath.convPath(__dirname, '/cache');
        expect(typeof res === 'string').toBe(true);
    });
});
describe('Notice', () => {
    const onConsoleOut = (logMethod, cb, out) => new Promise(resolve => {
        const log = console[logMethod];
        console[logMethod] = function () {
            // log.apply(console, arguments);
            cb.apply(null, arguments);
            resolve();
            console[logMethod] = log;
        };
        out();
    });
    test('Notice.success', () => {
        return onConsoleOut('log', (res) => {
            expect(JSON.stringify(res)).toBe('"\\u001b[42m\\u001b[30m SUCCESS \\u001b[39m\\u001b[49m\\u001b[32m 成功信息\\u001b[39m"');
        }, () => Notice.success('成功信息'));
    });
    test('Notice.error', () => {
        return onConsoleOut('error', (res) => {
            expect(JSON.stringify(res)).toBe('"\\u001b[41m ERROR \\u001b[49m\\u001b[31m 错误信息\\u001b[39m"');
        }, () => Notice.error('错误信息'));
    });
    test('Notice.warn', () => {
        return onConsoleOut('warn', (res) => {
            expect(JSON.stringify(res)).toBe('"\\u001b[43m\\u001b[30m WARN \\u001b[39m\\u001b[49m\\u001b[33m 警告信息\\u001b[39m"');
        }, () => Notice.warn('警告信息'));
    });
    test('Notice.info', () => {
        return onConsoleOut('info', (res) => {
            expect(JSON.stringify(res)).toBe('"\\u001b[44m\\u001b[30m INFO \\u001b[39m\\u001b[49m\\u001b[36m 普通信息\\u001b[39m"');
        }, () => Notice.info('普通信息'));
    });
    test('Notice.getStr', () => {
        const res = Notice.getStr('info', '普通信息颜色文字');
        expect(JSON.stringify(res)).toBe('"\\u001b[36m普通信息颜色文字\\u001b[39m"');
    });
    test('Notice.getBoldStr', () => {
        const res = Notice.getBoldStr('blue', '普通信息颜色文字');
        expect(JSON.stringify(res)).toBe('"\\u001b[1m\\u001b[34m普通信息颜色文字\\u001b[39m\\u001b[22m"');
    });
});

describe('PresetUtils', () => {
    const config = {
        presets: [{
            e: 'e',
            b: ['b'],
            c: 'c',
        }],
        a: 'a',
        c: 'd',
        b: [
            'a',
            'c',
        ],
        modify: (_config) => {
            delete _config.c;
        },
    };
    test('PresetUtils.getDeepPreset', async () => {
        const res = await PresetUtils.getDeepPreset(config);
        expect(res).toMatchObject([
            { e: 'e', b: ['b'], c: 'c' },
            { presets: [{ e: 'e', b: ['b'], c: 'c' }], a: 'a', c: 'd', b: ['a', 'c'] },
        ]);
    });
    test('PresetUtils.getDeepPresetMerge', async () => {
        const res = await PresetUtils.getDeepPresetMerge(config);
        expect(res).toMatchObject({ a: 'a', b: ['b', 'a', 'c'], c: 'd', e: 'e' });
    });
    test('PresetUtils.getDeepPresetMergeAndModify', async () => {
        const res = await PresetUtils.getDeepPresetMergeAndModify(config);
        expect(res).toMatchObject({ a: 'a', b: ['b', 'a', 'c'], e: 'e' });
    });
});

describe('CmdUtils', () => {

    test('CmdUtils.runCommand', () => {
        return CmdUtils.runCommand('cat', [path.join(__dirname, '../__mock__/test-package.json')]).then(() => {
            expect(true).toBe(true);
        });
    });
    test('CmdUtils.runCommand error', () => {
        return CmdUtils.runCommand('aaa').catch((e) => {
            expect(e.message).toMatch('aaa' + '执行失败');
        });
    });
});

describe('GitUtils', () => {
    test('GitUtils.getUser', () => {
        const user = GitUtils.getUser();
        expect(Object.values(user).map(v => typeof v).join(' ')).toBe(new Array(3).fill('string').join(' '));
    });
});

describe('NpmUtils', () => {
    const packageName = '@agds/node-utils';
    const version = '1.0.14';
    test('NpmUtils.getRegistry', () => {
        const res = NpmUtils.getRegistry();
        expect(typeof res).toBe('string');
    });
});
```

## API文档

<a name="module_nodeUtils"></a>

### nodeUtils

<a name="module_nodeUtils.CmdParser"></a>

#### nodeUtils.CmdParser

基于`commander.js`封装的命令行解析工具库

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.CmdParser.optionParseByConfig"></a>

##### CmdParser.optionParseByConfig(program, config)

基于config配置Command实例

**性质**: [<code>CmdParser</code>](#module_nodeUtils.CmdParser)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| program | <code>Command</code> | command实例 |
| config | [<code>CmdConfig</code>](#module_nodeUtils.CmdParser.optionParseByConfig_alias_CmdConfig) | 命令行解析配置 |


<a name="module_nodeUtils.CmdParser.optionParseByConfig_alias_CmdConfig"></a>

###### CmdConfig : <code>object</code>

命令行解析配置

**性质**: [<code>optionParseByConfig</code>](#module_nodeUtils.CmdParser.optionParseByConfig)的类型声明

**属性**

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| cmd | <code>string</code> | 作为插件时为子命令名称，单独使用时`agds-<cmd>`为命令行程序名称 |
| desc | <code>string</code> | 描述 |
| alias | <code>string</code> | 此命令的别名，只在插件调用时有效 |
| opts | [<code>Array.&lt;OptConfig&gt;</code>](#module_nodeUtils.CmdParser.optionParseByConfig_alias_OptConfig) | option配置项描述 |
| args | [<code>Array.&lt;ArgConfig&gt;</code>](#module_nodeUtils.CmdParser.optionParseByConfig_alias_ArgConfig) | option配置项描述 |


<a name="module_nodeUtils.CmdParser.optionParseByConfig_alias_OptConfig"></a>

###### OptConfig : <code>object</code>

命令行option解析配置

**性质**: [<code>optionParseByConfig</code>](#module_nodeUtils.CmdParser.optionParseByConfig)的类型声明

**属性**

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| opt | <code>string</code> | option字段配置 |
| desc | <code>string</code> | 描述 |
| default | <code>string</code> \| <code>boolean</code> | 默认值 |
| required | <code>boolean</code> | 是否是必填参数 |


<a name="module_nodeUtils.CmdParser.optionParseByConfig_alias_ArgConfig"></a>

###### ArgConfig : <code>object</code>

命令行option解析配置

**性质**: [<code>optionParseByConfig</code>](#module_nodeUtils.CmdParser.optionParseByConfig)的类型声明

**属性**

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| arg | <code>string</code> | option字段配置 |
| desc | <code>string</code> | 描述 |
| default | <code>string</code> \| <code>boolean</code> | 默认值 |


<a name="module_nodeUtils.CmdParser.cmdParser"></a>

##### CmdParser.cmdParser(options) ⇒ <code>Command</code>

基于配置文件的命令行解析器

**性质**: [<code>CmdParser</code>](#module_nodeUtils.CmdParser)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| options | <code>object</code> | 函数参数 |
| options.root | <code>string</code> | 当前命令行npm包根目录 |
| [options.isCore] | <code>boolean</code> | 是否是@agds/cli调用 |
| [options.cmd] | <code>string</code> | 命令名称，命令调用必填 |


<a name="module_nodeUtils.CmdUtils"></a>

#### nodeUtils.CmdUtils

运行命令行的工具集

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.CmdUtils.installDependencies"></a>

##### CmdUtils.installDependencies(options, prod, [executable]) ⇒ <code>Promise.&lt;void&gt;</code>

在项目中执行 `npm install`

**性质**: [<code>CmdUtils</code>](#module_nodeUtils.CmdUtils)的静态方法

| 参数 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| options | <code>module:child\_process~SpawnOptions</code> |  | spawn函数的选项参数 |
| prod | <code>boolean</code> |  | 是否只下载生产依赖 |
| [executable] | <code>&#x27;npm&#x27;</code> \| <code>&#x27;yarn&#x27;</code> \| <code>string</code> | <code>npm</code> | 依赖下载工具，可选值：'npm','yarn'或其他node包管理命令 |


<a name="module_nodeUtils.CmdUtils.runCommand"></a>

##### CmdUtils.runCommand(cmd, args, options) ⇒ <code>Promise.&lt;void&gt;</code>

生成一个子进程并运行指定的命令
默认情况下，运行在CWD和'inherit'的stdio
选项与node的child_process.spawn相同

**性质**: [<code>CmdUtils</code>](#module_nodeUtils.CmdUtils)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| cmd | <code>string</code> | 命令 |
| args | <code>Array.&lt;string&gt;</code> | 参数数组 |
| options | <code>module:child\_process~SpawnOptions</code> | spawn函数的选项参数 |


<a name="module_nodeUtils.ConvName"></a>

#### nodeUtils.ConvName

名称处理工具类，命名格式转换

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="new_module_nodeUtils.ConvName_new"></a>

##### new ConvName(name)

获取三种名称转换结果的集合

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>stirng</code> | 名称文本 |


<a name="module_nodeUtils.ConvName+lineName"></a>

##### convName.lineName : <code>string</code>

横杠名称

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的instance属性

<a name="module_nodeUtils.ConvName+humpName"></a>

##### convName.humpName : <code>string</code>

大驼峰名称

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的instance属性

<a name="module_nodeUtils.ConvName+lowerHumpName"></a>

##### convName.lowerHumpName : <code>string</code>

小驼峰名称

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的instance属性

<a name="module_nodeUtils.ConvName.toUpperHump"></a>

##### ConvName.toUpperHump(name) ⇒ <code>string</code>

横杠转大驼峰

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>string</code> | 名称文本 |


<a name="module_nodeUtils.ConvName.toLowerHump"></a>

##### ConvName.toLowerHump(name) ⇒ <code>string</code>

横杠转小驼峰

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>string</code> | 名称文本 |


<a name="module_nodeUtils.ConvName.toLine"></a>

##### ConvName.toLine(name) ⇒ <code>string</code>

驼峰转换横杠

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>string</code> | 名称文本 |


<a name="module_nodeUtils.ConvName.initName"></a>

##### ConvName.initName(name) ⇒ <code>ConvName</code>

获取驼峰和横杠名称

**性质**: [<code>ConvName</code>](#module_nodeUtils.ConvName)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>string</code> | 名称文本 |


<a name="module_nodeUtils.FastFs"></a>

#### nodeUtils.FastFs

文件系统操作类，集合了几个使用频率较高的文件操作函数

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.FastFs.writeFile"></a>

##### FastFs.writeFile(filename, data) ⇒ <code>Promise.&lt;void&gt;</code>

异步写入数据，不存在的路径自动创建

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| filename | <code>fs.PathLike</code> | 文件名 |
| data | <code>object</code> | 写入的数据（对象） |


<a name="module_nodeUtils.FastFs.writeFileSync"></a>

##### FastFs.writeFileSync(filename, data) ⇒ <code>void</code>

同步写入数据，不存在的路径自动创建

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| filename | <code>fs.PathLike</code> | 文件名 |
| data | <code>object</code> | 写入的数据（对象） |


<a name="module_nodeUtils.FastFs.getPathStat"></a>

##### FastFs.getPathStat(path) ⇒ <code>Promise.&lt;boolean&gt;</code>

异步获取路径是否存在

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| path | <code>fs.PathLike</code> | 路径 |


<a name="module_nodeUtils.FastFs.getPathStatSync"></a>

##### FastFs.getPathStatSync(path) ⇒ <code>boolean</code>

同步获取路径是否存在

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| path | <code>fs.PathLike</code> | 路径 |


<a name="module_nodeUtils.FastFs.writeJsonFormat"></a>

##### FastFs.writeJsonFormat(filename, data, [space]) ⇒ <code>Promise</code>

异步写入符合.json格式的json文件

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| filename | <code>fs.PathLike</code> |  | 文件路径 |
| data | <code>any</code> |  | 需要写入的数据 |
| [space] | <code>string</code> \| <code>number</code> | <code>2</code> | 指定缩进用的空白字符串 |


<a name="module_nodeUtils.FastFs.writeJsonFormatSync"></a>

##### FastFs.writeJsonFormatSync(filename, data, [space]) ⇒ <code>void</code>

同步写入符合.json格式的json文件

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| filename | <code>fs.PathLike</code> |  | 文件路径 |
| data | <code>any</code> |  | 需要写入的数据 |
| [space] | <code>string</code> \| <code>number</code> | <code>2</code> | 指定缩进用的空白字符串 |


<a name="module_nodeUtils.FastFs.readJson"></a>

##### FastFs.readJson(filename) ⇒ <code>Promise.&lt;object&gt;</code>

异步读取json文件

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| filename | <code>fs.PathLike</code> | json文件路径 |


<a name="module_nodeUtils.FastFs.readJsonSync"></a>

##### FastFs.readJsonSync(filename) ⇒ <code>object</code>

同步读取json文件

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| filename | <code>fs.PathLike</code> | json文件路径 |


<a name="module_nodeUtils.FastFs.sortDependencies"></a>

##### FastFs.sortDependencies(packageJsonFile)

对packageJson的依赖对象进行key的排序

**性质**: [<code>FastFs</code>](#module_nodeUtils.FastFs)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| packageJsonFile | <code>string</code> | packageJson文件绝对路径 |


<a name="module_nodeUtils.FastPath"></a>

#### nodeUtils.FastPath

路径工具类，快速获取各类node常用路径，每个方法要求路径都不是绝对路径
如果是绝对路径，就按照绝对路径拼接

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.FastPath.getCwdPath"></a>

##### FastPath.getCwdPath(...paths) ⇒ <code>string</code>

获取运行目录加路径的绝对路径

**性质**: [<code>FastPath</code>](#module_nodeUtils.FastPath)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| ...paths | <code>string</code> | 路径 |


<a name="module_nodeUtils.FastPath.getHomePath"></a>

##### FastPath.getHomePath(...paths) ⇒ <code>string</code>

获取用户目录加路径的绝对路径

**性质**: [<code>FastPath</code>](#module_nodeUtils.FastPath)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| ...paths | <code>string</code> | 路径 |


<a name="module_nodeUtils.FastPath.getAgdsHomePath"></a>

##### FastPath.getAgdsHomePath(...paths) ⇒ <code>string</code>

获取用户目录加路径的绝对路径

**性质**: [<code>FastPath</code>](#module_nodeUtils.FastPath)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| ...paths | <code>string</code> | 路径 |


<a name="module_nodeUtils.FastPath.convPath"></a>

##### FastPath.convPath(basePath, paths) ⇒ <code>string</code>

基于基础路径拼接追加路径，如果追加路径数组第一个路径是绝对路径，忽略基础路径直接拼接返回<br/>
是其他函数的依赖函数

**性质**: [<code>FastPath</code>](#module_nodeUtils.FastPath)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| basePath | <code>string</code> | 基础路径 |
| paths | <code>Array.&lt;string&gt;</code> | 追加路径数组 |


<a name="module_nodeUtils.GitUtils"></a>

#### nodeUtils.GitUtils

Git工具集合

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.GitUtils.gcHasMsg"></a>

##### GitUtils.gcHasMsg() ⇒ <code>boolean</code>

判断`git commit`是否传入`-m`参数
配合`yorkie`使用，不支持识别husky

**性质**: [<code>GitUtils</code>](#module_nodeUtils.GitUtils)的静态方法

<a name="module_nodeUtils.GitUtils.getUser"></a>

##### GitUtils.getUser() ⇒ [<code>UserObj</code>](#module_nodeUtils.GitUtils.getUser_alias_UserObj)

获取当前git用户名称

**性质**: [<code>GitUtils</code>](#module_nodeUtils.GitUtils)的静态方法
**返回值**: [<code>UserObj</code>](#module_nodeUtils.GitUtils.getUser_alias_UserObj) - git用户名对象

<a name="module_nodeUtils.GitUtils.getUser_alias_UserObj"></a>

###### UserObj : <code>object</code>

git用户名对象

**性质**: [<code>getUser</code>](#module_nodeUtils.GitUtils.getUser)的类型声明

**属性**

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| name | <code>string</code> | 名字 |
| email | <code>string</code> | 电子邮箱 |
| all | <code>string</code> | {name}<{email}> |


<a name="module_nodeUtils.Notice"></a>

#### nodeUtils.Notice

基于chalk封装的控制台输出静态函数类

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.Notice_alias_ChalkType"></a>

##### ChalkType : <code>&#x27;success&#x27;</code> \| <code>&#x27;error&#x27;</code> \| <code>&#x27;warn&#x27;</code> \| <code>&#x27;info&#x27;</code> \| <code>string</code>

chalk类型以及别名

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的类型声明

<a name="module_nodeUtils.Notice.success"></a>

##### Notice.success(msg) ⇒ <code>void</code>

控制台输出成功信息

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| msg | <code>string</code> | 成功信息 |


<a name="module_nodeUtils.Notice.error"></a>

##### Notice.error(msg) ⇒ <code>void</code>

控制台输出错误信息

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| msg | <code>string</code> | 错误信息文本 |


<a name="module_nodeUtils.Notice.warn"></a>

##### Notice.warn(msg) ⇒ <code>void</code>

控制台输出警告信息

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| msg | <code>string</code> | 警告信息文本 |


<a name="module_nodeUtils.Notice.info"></a>

##### Notice.info(msg) ⇒ <code>void</code>

控制台输出信息

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| msg | <code>string</code> | 信息文本 |


<a name="module_nodeUtils.Notice.getStr"></a>

##### Notice.getStr(type, msg) ⇒ <code>chalk</code>

获取各种颜色的字体

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| type | [<code>ChalkType</code>](#module_nodeUtils.Notice_alias_ChalkType) | chalk类型 |
| msg | <code>string</code> | 文本 |


<a name="module_nodeUtils.Notice.getBoldStr"></a>

##### Notice.getBoldStr(type, msg) ⇒ <code>chalk</code>

获取各种颜色的粗体字体

**性质**: [<code>Notice</code>](#module_nodeUtils.Notice)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| type | [<code>ChalkType</code>](#module_nodeUtils.Notice_alias_ChalkType) | chalk类型 |
| msg | <code>string</code> | 文本 |


<a name="module_nodeUtils.NpmUtils"></a>

#### nodeUtils.NpmUtils

npm工具集合

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.NpmUtils.getRegistry"></a>

##### NpmUtils.getRegistry() ⇒ <code>string</code>

获取当前项目的npm镜像地址

**性质**: [<code>NpmUtils</code>](#module_nodeUtils.NpmUtils)的静态方法

<a name="module_nodeUtils.NpmUtils.getPackageInfo"></a>

##### NpmUtils.getPackageInfo(packageName, [version]) ⇒ <code>Promise</code>

获取npm包的所有版本的所有信息

**性质**: [<code>NpmUtils</code>](#module_nodeUtils.NpmUtils)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| packageName | <code>string</code> | 包名 |
| [version] | <code>string</code> | 版本或tag |


<a name="module_nodeUtils.NpmUtils.getPackageInfoWithVersion"></a>

##### NpmUtils.getPackageInfoWithVersion(packageName, [version]) ⇒ <code>Promise</code>

获取指定版本包信息

**性质**: [<code>NpmUtils</code>](#module_nodeUtils.NpmUtils)的静态方法
**返回值**: <code>Promise</code> - 对应版本包信息

| 参数 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| packageName | <code>string</code> |  | 包名 |
| [version] | <code>string</code> | <code>&quot;latest&quot;</code> | 版本或者版本tag |


<a name="module_nodeUtils.NpmUtils.downloadPackage"></a>

##### NpmUtils.downloadPackage(options) ⇒ <code>string</code>

下载npm包到本地

**性质**: [<code>NpmUtils</code>](#module_nodeUtils.NpmUtils)的静态方法
**返回值**: <code>string</code> - 包下载的本地路径

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| options | <code>object</code> | 下载配置 |
| options.outputDir | <code>string</code> | 输出目录 |
| options.packageName | <code>string</code> | 包名 |
| [options.version] | <code>string</code> | 版本或者版本tag |
| [options.autoInstall] | <code>boolean</code> \| [<code>InstallOption</code>](#module_nodeUtils.NpmUtils.downloadPackage_alias_InstallOption) | 自动下载npm包依赖或者自动下载配置 |


<a name="module_nodeUtils.NpmUtils.downloadPackage_alias_InstallOption"></a>

###### InstallOption : <code>object</code>

下载配置

**性质**: [<code>downloadPackage</code>](#module_nodeUtils.NpmUtils.downloadPackage)的类型声明

**属性**

| 属性 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| [prod] | <code>boolean</code> | <code>true</code> | 是否只下载生产依赖 |


<a name="module_nodeUtils.PresetUtils"></a>

#### nodeUtils.PresetUtils

支持presets预设的配置生成工具

**性质**: [<code>nodeUtils</code>](#module_nodeUtils)的静态class

<a name="module_nodeUtils.PresetUtils_alias_Config"></a>

##### Config : <code>object</code>

支持preset的配置对象

**性质**: [<code>PresetUtils</code>](#module_nodeUtils.PresetUtils)的类型声明

**属性**

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| presets | [<code>Array.&lt;Config&gt;</code>](#module_nodeUtils.PresetUtils_alias_Config) | 预设配置数组 |
| modify | [<code>ConfigModify</code>](#module_nodeUtils.PresetUtils_alias_ConfigModify) | 将默认配置和preset合并后生成的config再次处理的钩子 |


<a name="module_nodeUtils.PresetUtils_alias_ConfigModify"></a>

##### ConfigModify ⇒ [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config)

**性质**: [<code>PresetUtils</code>](#module_nodeUtils.PresetUtils)的类型声明

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| config | [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config) | 将默认配置和preset合并后生成的config |


<a name="module_nodeUtils.PresetUtils.getDeepPreset"></a>

##### PresetUtils.getDeepPreset(config) ⇒ <code>Promise.&lt;Array.&lt;Config&gt;&gt;</code>

递归获取配置对象presets数组，返回一维数组

**性质**: [<code>PresetUtils</code>](#module_nodeUtils.PresetUtils)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| config | [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config) | 配置对象 |


<a name="module_nodeUtils.PresetUtils.getDeepPresetMerge"></a>

##### PresetUtils.getDeepPresetMerge(config) ⇒ [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config)

递归获取配置对象presets数组，并使用merge合并

**性质**: [<code>PresetUtils</code>](#module_nodeUtils.PresetUtils)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| config | [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config) | 配置对象 |


<a name="module_nodeUtils.PresetUtils.getDeepPresetMergeAndModify"></a>

##### PresetUtils.getDeepPresetMergeAndModify(config) ⇒ [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config)

递归获取配置对象presets数组，并使用merge合并，最后调用`config.modify`函数

**性质**: [<code>PresetUtils</code>](#module_nodeUtils.PresetUtils)的静态方法

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| config | [<code>Config</code>](#module_nodeUtils.PresetUtils_alias_Config) | 配置对象 |



<a name="cliUsages"></a>

## 命令行使用文档

```
Usage: agds-gc-has-msg [options]

判断git commit命令是否传入-m参数

Options:
  -v,--version  查看版本号
  -h, --help    查看帮助信息

配合git hooks【prepare-commit-msg】和【commitizen】使用，避免git commit已经传入-m参数时调用commitizen界面

文档查看：git@gitee.com:agile-development-system/node-utils
@agds/node-utils@1.0.16 /Users/jinyang/code/ads/node-utils/node_modules/@agds/node-utils
```

#### 如何使用

> 在`package.json`下的`gitHooks['prepare-commit-msg']`下配合commitizen使用，git生命周期插件必须是**yorkie**

```diff
"gitHooks": {
+    "prepare-commit-msg": "agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"
},
```

<a name="license"></a>

## 许可证

[MIT License](https://gitee.com/agile-development-system/node-utils/blob/master/LICENSE)
Copyright (c) 2021 锦阳

<a name="donate"></a>

## 请维护者喝杯咖啡

<img src="https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/alipay.jpeg" width="209px" >
<img src="https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/wechatpay.jpeg" width="237px" >


<a name="dingtalk"></a>

## 加入钉钉群讨论或加入开发

<img src="https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/dingtalk.jpeg" width="188px" >