1.0.7 • Published 4 months ago
app-lib-trans-storage v1.0.7
app-lib-trans-storage
文本文件转换存储
一、背景介绍
使用exec执行文件的时候 文件往往是静态文件 然而在上方使用的时候 就会丢失静态文件
针对一些静态文件的组件 在使用该组件的工程或者组件中，由于动态加载(require(var))等方式进行加载后 在webpack不能在打包范围,导致使用的组件进行bundle打包的时候，该文件已经不存在了，导致异常情况。
期望转换可编译的文本进行统一的打包处理。
二、功能描述
- 将文件转换为json文件进行存储。
- 第一次使用的时候 自动转换为文件,便捷使用。
- 后续直接requireJSON引用JSON进行操作文件即可
三、注意事项
四、使用案列
代码逻辑 1. 开发阶段编译 2. 使用首次阶段引入生成文件 3. 直接使用或者获取路
五、todo列表
六、API
Functions
filesToJson(filePaths, storagePath) ⇒ array
将文件转换为JSON进行存储
Kind: global function
Returns: array - 返回文件读取的JSON内容
- example
filesToJson([path.resolve(__dirname,`./b.ps1`),path.resolve(__dirname,`./a.ps1`)]
| Param | Type | Default | Description |
|---|---|---|---|
| filePaths | array | 多个文件转换了路径 | |
| storagePath | string | "'./static/store.json'" | 存储的文件路径名称 一般为json 便捷处理 |
pathToFile(storagePath, basePath) ⇒ array
存储文件转换为文件
Kind: global function
Returns: array - 所有存储的文件路径
| Param | Type | Default | Description |
|---|---|---|---|
| storagePath | string | "'./static/store.json'" | 存储文件位置 |
| basePath | string | "'./static/'" | 每个文件存储路径 |
jsonToFile(fileDatas, basePath, isForce) ⇒ array
存储文件转换为文件
Kind: global function
Returns: array - 所有存储的文件路径
| Param | Type | Default | Description |
|---|---|---|---|
| fileDatas | array | '[]' | 存储数据 |
| basePath | string | "'./static/'" | 每个文件存储路径 |
| isForce | boolean | false | 是否强制写入 默认false |
buildDirFiles(buildDirPath, storagePath)
构建文件夹
- 注意 所有文件路径是平级 不支持嵌套
Kind: global function
| Param | Type | Default | Description |
|---|---|---|---|
| buildDirPath | string | "src/trans-static" | 构建的文件夹路径 |
| storagePath | string | "./static/store.json" | 存储路径 |
七、发布日志
- 2023-11-03 11-42-34-发布组件
- 2023-11-03 09-08-49-日志调整
- 2023-11-02 09-07-57-升级nodejs
- 2023-11-01 08-12-34-去掉日志
- 2023-10-31 11-53-21-添加目录文件自动扫描到json
- 2023-10-31 11-07-40-添加文本转换组件
- 2023-10-31 11-04-31-添加文本转换组件
1.0.7
4 months ago