mm_config 1.1.4 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,2 +1,102 @@
|
|
|
1
1
|
# mm_config
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
超级美眉配置帮助类，动态同步文件修改配置。
|
|
4
|
+
|
|
5
|
+
## 功能特点
|
|
6
|
+
|
|
7
|
+
- 支持配置文件的动态读取和修改
|
|
8
|
+
- 修改配置后自动同步保存到JSON文件
|
|
9
|
+
- 使用Proxy实现属性监听，操作方便
|
|
10
|
+
- 支持无配置文件时的默认配置创建
|
|
11
|
+
|
|
12
|
+
## 安装
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install mm_config
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## API说明
|
|
19
|
+
|
|
20
|
+
### 配置初始化
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
const conf = require('mm_config');
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* @param {Object} _config 配置对象，可选，不传则从文件读取
|
|
27
|
+
* @param {String} _jsonFile 配置文件路径，可选，不传则使用this.filename
|
|
28
|
+
* @returns {Proxy} 返回配置代理对象
|
|
29
|
+
*/
|
|
30
|
+
const config = conf(_config, _jsonFile);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 参数说明
|
|
34
|
+
|
|
35
|
+
- `_config`: 初始配置对象，可选参数
|
|
36
|
+
- 当传入对象时，将使用该对象作为初始配置
|
|
37
|
+
- 当不传入时，将从配置文件中读取配置
|
|
38
|
+
|
|
39
|
+
- `_jsonFile`: 配置文件路径，可选参数
|
|
40
|
+
- 当传入路径时，将使用该路径作为配置文件
|
|
41
|
+
- 当不传入时，将使用`this.filename`作为配置文件路径
|
|
42
|
+
|
|
43
|
+
## 使用示例
|
|
44
|
+
|
|
45
|
+
### 1. 创建新配置
|
|
46
|
+
|
|
47
|
+
```javascript
|
|
48
|
+
// 创建配置并指定保存路径
|
|
49
|
+
const config = conf({
|
|
50
|
+
name: "demo",
|
|
51
|
+
state: 1
|
|
52
|
+
}, "./config.json");
|
|
53
|
+
|
|
54
|
+
// 修改配置会自动保存到文件
|
|
55
|
+
config.name = "test";
|
|
56
|
+
config.sort = 2;
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 2. 读取现有配置
|
|
60
|
+
|
|
61
|
+
```javascript
|
|
62
|
+
// 设置配置文件路径
|
|
63
|
+
this.filename = "./config.json";
|
|
64
|
+
|
|
65
|
+
// 读取现有配置文件
|
|
66
|
+
const config = conf();
|
|
67
|
+
|
|
68
|
+
// 获取配置
|
|
69
|
+
console.log(config.name);
|
|
70
|
+
|
|
71
|
+
// 修改配置
|
|
72
|
+
config.age = 26;
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 3. 使用默认配置
|
|
76
|
+
|
|
77
|
+
```javascript
|
|
78
|
+
// 使用默认配置，并指定保存路径
|
|
79
|
+
const config = conf({
|
|
80
|
+
name: "default",
|
|
81
|
+
version: "1.0.0"
|
|
82
|
+
}, "./config.json");
|
|
83
|
+
|
|
84
|
+
// 如果配置文件不存在，将使用默认配置并创建文件
|
|
85
|
+
// 如果配置文件存在，将忽略默认配置，使用文件中的配置
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 注意事项
|
|
89
|
+
|
|
90
|
+
1. 配置文件会自动创建和同步
|
|
91
|
+
2. 修改配置对象的属性会自动保存到文件
|
|
92
|
+
3. 确保有文件的写入权限
|
|
93
|
+
4. 配置文件使用UTF-8编码的JSON格式
|
|
94
|
+
|
|
95
|
+
## 依赖
|
|
96
|
+
|
|
97
|
+
- json5: 用于解析JSON
|
|
98
|
+
- mm_expand: 提供文件操作扩展
|
|
99
|
+
|
|
100
|
+
## 许可证
|
|
101
|
+
|
|
102
|
+
ISC License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mm_config",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.5",
|
|
4
4
|
"description": "这是超级美眉配置同步器,用于更改配置同步保存为JSON文件",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
},
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "git+https://
|
|
11
|
+
"url": "git+https://gitee.com/qiuwenwu91/mm_config.git"
|
|
12
12
|
},
|
|
13
13
|
"keywords": [
|
|
14
14
|
"config",
|
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
"author": "邱文武",
|
|
20
20
|
"license": "ISC",
|
|
21
21
|
"bugs": {
|
|
22
|
-
"url": "https://
|
|
22
|
+
"url": "https://gitee.com/qiuwenwu91/mm_config/issues"
|
|
23
23
|
},
|
|
24
|
-
"homepage": "https://
|
|
24
|
+
"homepage": "https://gitee.com/qiuwenwu91/mm_config#readme",
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"json5": "^2.2.3",
|
|
27
|
-
"mm_expand": "^1.
|
|
27
|
+
"mm_expand": "^1.8.3"
|
|
28
28
|
}
|
|
29
29
|
}
|