一大波更新
parent
4c949fadd7
commit
5453b999be
10
History.md
10
History.md
|
@ -1,4 +1,12 @@
|
||||||
# 1.2.1 / 2020-01-02
|
# 1.3.0 / 2020-01-08
|
||||||
|
* [A] 增加chown()方法
|
||||||
|
* [A] cp()和 mv()支持对目录进行操作
|
||||||
|
* [U] 优化异常处理, 友好的输出, 不终止代码往下执行
|
||||||
|
* [U] 支持新版本node使用新API
|
||||||
|
* [U] rm()方法自动识别目录,不再需要提供第2个参数
|
||||||
|
|
||||||
|
|
||||||
|
# 1.2.2 / 2020-01-02
|
||||||
* [F] 修复改回同步时回调未移除, 导致在node v12.10报错的bug
|
* [F] 修复改回同步时回调未移除, 导致在node v12.10报错的bug
|
||||||
|
|
||||||
|
|
||||||
|
|
25
Readme.md
25
Readme.md
|
@ -3,28 +3,37 @@
|
||||||
# iofs
|
# iofs
|
||||||
> `iofs`是一个基于原生`fs`模块封装的工具, 旨在提供更加方便实用一些常用的API方法(同步), API习惯参考了`bash shell`, 习惯用命令行的朋友, 可能会比较亲切。
|
> `iofs`是一个基于原生`fs`模块封装的工具, 旨在提供更加方便实用一些常用的API方法(同步), API习惯参考了`bash shell`, 习惯用命令行的朋友, 可能会比较亲切。
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
[Change Logs](./History.md)
|
||||||
|
|
||||||
|
|
||||||
## 属性
|
## 属性
|
||||||
|
|
||||||
### origin
|
- origin
|
||||||
> 返回原生的`fs`模块对象, 方便调用一些未封装的额外功能
|
> 返回原生的`fs`模块对象, 方便调用一些未封装的额外功能
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## APIs
|
## APIs
|
||||||
|
|
||||||
### .cat(file)
|
- .cat()
|
||||||
- file `<String>` 文件路径
|
|
||||||
|
|
||||||
> 读取文件, 返回一个`Buffer对象`
|
> 读取文件, 返回一个`Buffer对象`
|
||||||
|
|
||||||
|
| 参数 | 类型 | 是否必须 | 说明 |
|
||||||
|
| :--: | :--: | :--: | -- |
|
||||||
|
| file | `<String>` | 是 | 要读取的文件路径 |
|
||||||
|
|
||||||
|
|
||||||
### .ls(path, recursion)
|
|
||||||
- path `<String>`
|
|
||||||
- recursion `<Boolean>`
|
|
||||||
|
|
||||||
|
|
||||||
|
- .ls()
|
||||||
> 列出指定目录下的所有文件&目录, 不包括 '.' and '..'. 结果返回一个数组.
|
> 列出指定目录下的所有文件&目录, 不包括 '.' and '..'. 结果返回一个数组.
|
||||||
> 如果参数`recursion`设为ture, 则会递归遍历所有子目录.
|
|
||||||
|
| 参数 | 类型 | 是否必须 | 说明 |
|
||||||
|
| :--: | :--: | :--: | -- |
|
||||||
|
| path | `<String>` | 是 | 要读取的目录 |
|
||||||
|
| recursive | `<String>` | 否 | 是否递归读取 |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### echo(data, file[, append][, encode])
|
### echo(data, file[, append][, encode])
|
||||||
|
|
122
index.js
122
index.js
|
@ -9,6 +9,11 @@
|
||||||
const FS = require('fs')
|
const FS = require('fs')
|
||||||
const PATH = require('path')
|
const PATH = require('path')
|
||||||
|
|
||||||
|
const VERSION = +process.versions.node
|
||||||
|
.split('.')
|
||||||
|
.slice(0, 2)
|
||||||
|
.join('.')
|
||||||
|
|
||||||
const Iofs = {
|
const Iofs = {
|
||||||
origin: FS,
|
origin: FS,
|
||||||
|
|
||||||
|
@ -31,10 +36,10 @@ const Iofs = {
|
||||||
/**
|
/**
|
||||||
* [ls 读取整个目录(不遍历子目录)]
|
* [ls 读取整个目录(不遍历子目录)]
|
||||||
* @param {string} dir [目标路径]
|
* @param {string} dir [目标路径]
|
||||||
* @param {boolean} recursion [是否递归遍历子目录]
|
* @param {boolean} recursive [是否递归遍历子目录]
|
||||||
* @return {array} [返回目标目录所有文件名和子目录名, 不包括'.'和'..']
|
* @return {array} [返回目标目录所有文件名和子目录名, 不包括'.'和'..']
|
||||||
*/
|
*/
|
||||||
ls(dir, recursion) {
|
ls(dir, recursive) {
|
||||||
try {
|
try {
|
||||||
var list = FS.readdirSync(dir)
|
var list = FS.readdirSync(dir)
|
||||||
|
|
||||||
|
@ -42,7 +47,7 @@ const Iofs = {
|
||||||
list[i] = PATH.resolve(dir, it)
|
list[i] = PATH.resolve(dir, it)
|
||||||
})
|
})
|
||||||
|
|
||||||
if (recursion) {
|
if (recursive) {
|
||||||
var tmp = list.concat()
|
var tmp = list.concat()
|
||||||
tmp.forEach(it => {
|
tmp.forEach(it => {
|
||||||
if (this.isdir(it)) {
|
if (this.isdir(it)) {
|
||||||
|
@ -52,9 +57,7 @@ const Iofs = {
|
||||||
}
|
}
|
||||||
return list
|
return list
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
if (err) {
|
console.error(err)
|
||||||
console.error(err + '')
|
|
||||||
}
|
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -87,20 +90,43 @@ const Iofs = {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
if (!!append) {
|
if (!!append) {
|
||||||
FS.appendFileSync(file, data, opt)
|
FS.appendFileSync(file, data, opt)
|
||||||
} else {
|
} else {
|
||||||
FS.writeFileSync(file, data, opt)
|
FS.writeFileSync(file, data, opt)
|
||||||
}
|
}
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
//修改权限
|
//修改权限
|
||||||
chmod(path, mode) {
|
chmod(path, mode) {
|
||||||
|
try {
|
||||||
FS.chmodSync(path, mode)
|
FS.chmodSync(path, mode)
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
//修改所属用户
|
||||||
|
chown(path, uid, gid) {
|
||||||
|
try {
|
||||||
|
FS.chownSync(path, uid, gid)
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [mv 移动文件,兼具重命名功能]
|
* [mv 移动文件&目录,兼具重命名功能]
|
||||||
* @param {String} origin [原路径/原名]
|
* @param {String} origin [原路径/原名]
|
||||||
* @param {String} target [目标路径/新名]
|
* @param {String} target [目标路径/新名]
|
||||||
*/
|
*/
|
||||||
|
@ -110,20 +136,36 @@ const Iofs = {
|
||||||
this.mkdir(updir)
|
this.mkdir(updir)
|
||||||
}
|
}
|
||||||
|
|
||||||
FS.rename(origin, target, err => {
|
try {
|
||||||
if (err) {
|
FS.renameSync(origin, target)
|
||||||
var rs = FS.createReadStream(origin)
|
} catch (err) {
|
||||||
var ws = FS.createWriteStream(target)
|
if (~err.message.indexOf('cross-device')) {
|
||||||
|
if (this.cp(origin, target)) {
|
||||||
rs.pipe(ws)
|
return this.rm(origin)
|
||||||
rs.on('end', err => {
|
}
|
||||||
this.rm(origin)
|
return false
|
||||||
})
|
}
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
})
|
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [cp 复制文件&目录]
|
||||||
|
* @param {String} origin [原路径]
|
||||||
|
* @param {String} target [目标路径]
|
||||||
|
*/
|
||||||
cp(origin, target) {
|
cp(origin, target) {
|
||||||
|
try {
|
||||||
|
// 如果是目录, 则递归操作
|
||||||
|
if (this.isdir(origin)) {
|
||||||
|
this.mkdir(target)
|
||||||
|
var list = this.ls(origin)
|
||||||
|
list.forEach(val => {
|
||||||
|
let name = PATH.parse(val).base
|
||||||
|
this.cp(val, PATH.join(target, name))
|
||||||
|
})
|
||||||
|
} else {
|
||||||
var updir = PATH.parse(target).dir
|
var updir = PATH.parse(target).dir
|
||||||
if (!this.isdir(updir)) {
|
if (!this.isdir(updir)) {
|
||||||
this.mkdir(updir)
|
this.mkdir(updir)
|
||||||
|
@ -131,25 +173,38 @@ const Iofs = {
|
||||||
|
|
||||||
var rs = FS.createReadStream(origin)
|
var rs = FS.createReadStream(origin)
|
||||||
var ws = FS.createWriteStream(target)
|
var ws = FS.createWriteStream(target)
|
||||||
|
|
||||||
rs.pipe(ws)
|
rs.pipe(ws)
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [rm 删除文件/目录]
|
* [rm 删除文件/目录]
|
||||||
* @param {[type]} origin [源文件/目录路径]
|
* @param {[type]} origin [源文件/目录路径]
|
||||||
* @param {[type]} recursion [是否递归删除,若删除目录,此值须为true]
|
|
||||||
*/
|
*/
|
||||||
rm(origin, recursion) {
|
rm(origin) {
|
||||||
if (recursion) {
|
try {
|
||||||
|
if (this.isdir(origin)) {
|
||||||
|
if (VERSION > 12.1) {
|
||||||
|
FS.rmdirSync(origin, { recursive: true })
|
||||||
|
} else {
|
||||||
var list = this.ls(origin)
|
var list = this.ls(origin)
|
||||||
list.forEach(it => {
|
list.forEach(it => this.rm(it))
|
||||||
this.rm(it, this.isdir(it))
|
|
||||||
})
|
|
||||||
FS.rmdirSync(origin)
|
FS.rmdirSync(origin)
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
FS.unlinkSync(origin)
|
FS.unlinkSync(origin)
|
||||||
}
|
}
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -160,6 +215,7 @@ const Iofs = {
|
||||||
try {
|
try {
|
||||||
return FS.statSync(path)
|
return FS.statSync(path)
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -172,6 +228,7 @@ const Iofs = {
|
||||||
try {
|
try {
|
||||||
return this.stat(path).isDirectory()
|
return this.stat(path).isDirectory()
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -179,11 +236,17 @@ const Iofs = {
|
||||||
/**
|
/**
|
||||||
* [mkdir 新建目录]
|
* [mkdir 新建目录]
|
||||||
* @param {String} dir [目标路径]
|
* @param {String} dir [目标路径]
|
||||||
|
* @param {Number} mode [目录权限, node v10.12起支持]
|
||||||
*/
|
*/
|
||||||
mkdir(dir) {
|
mkdir(dir, mode = 0o755) {
|
||||||
|
try {
|
||||||
|
if (VERSION > 10.12) {
|
||||||
|
FS.mkdirSync(dir, { recursive: true, mode: mode })
|
||||||
|
} else {
|
||||||
var updir = PATH.parse(dir).dir
|
var updir = PATH.parse(dir).dir
|
||||||
if (!updir) {
|
if (!updir) {
|
||||||
return
|
console.error('Wrong dir path')
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!this.isdir(updir)) {
|
if (!this.isdir(updir)) {
|
||||||
|
@ -191,6 +254,13 @@ const Iofs = {
|
||||||
}
|
}
|
||||||
|
|
||||||
FS.mkdirSync(dir)
|
FS.mkdirSync(dir)
|
||||||
|
this.chmod(dir, mode)
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "iofs",
|
"name": "iofs",
|
||||||
"version": "1.2.2",
|
"version": "1.3.0",
|
||||||
"description": "Base on native fs module, for easy using.",
|
"description": "Base on native fs module, for easy using.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|
Loading…
Reference in New Issue