# mv-move-module-dependencies

**Repository Path**: memory_s/mv-move-module-dependencies

## Basic Information

- **Project Name**: mv-move-module-dependencies
- **Description**: 一款可以约束eslint以及prettier的sdk
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-07-21
- **Last Updated**: 2024-12-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @mtool/move-module-dependencies

#### 介绍

一款通过配置化，在项目中移动文件功代码功能文件并安装相应依赖的工具

#### 安装

```sh
(npm|yarn|pnpm) install @mtool/move-module-dependencies
```

#### 使用说明

安装后，在项目根目录下新建move.js后，采用nodejs执行此文件即可，详见下方示例

#### 贡献

1.  Fork 本仓库
2.  新建 feat/xxx 分支
3.  Push代码，并提交 Merge Request, 作者欢迎各位为此开源工具贡献一份力量~

#### 示例

```js
// 1. 在项目根目录下新建 move.js 文件

// 2. move.js
const MoveModuleDependencies = require('@mtool/move-module-dependencies');

const move = new MoveModuleDependencies();
move.startWorker({
    dependencies: {  // package.json 依赖，按照标准的package.json 内容来传入即可(非必填)
        devDependencies: {
            "lodash": "^1.0.0"
        },
        dependencies: {
            "lodash": "^1.0.0"
        }
    }
    config: {
        rootPath: '/path';  // 在移动完成文件后，会根据上面的 dependencies 参数来安装依赖，安装依赖的路径，默认为执行命令的工作目录(非必填)
        moveFilePath: [    // 需要移动的文件或者目录
            { origin: '/xxx/xxx/xxx', dest: '/xxx/xxx/xx' },
            { origin: '/xxx/xxx/x.txt', dest: '/xxx/xxx/x.txt' }
        ]
        packageJsonTabWidth: 4; // package.json 的空格缩进值，安装依赖后，会对package.json的文件进行代码格式化并新增script 参数，默认为 4 个空格(非必填)
        coverIgnore: {
            file: ['aaa.txt'];  // 设置当移动的文件存在冲突时，哪些文件忽略跳过，默认会覆盖。(只能是文件，不支持目录)
        };
    };
});
```