https://github.com/x-mod/dir
dir ops helper
https://github.com/x-mod/dir
Last synced: 5 months ago
JSON representation
dir ops helper
- Host: GitHub
- URL: https://github.com/x-mod/dir
- Owner: x-mod
- License: mit
- Created: 2020-09-17T09:20:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-18T13:12:49.000Z (almost 4 years ago)
- Last Synced: 2023-07-27T22:48:45.419Z (almost 3 years ago)
- Language: Go
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dir
workdir util package.
中文参考: [Go 工作目录](https://mbox.dev/dev/go/x-mod/packages/workdir/)
## Quick Start
````go
import "github.com/x-mod/dir"
//初始化
workdir := dir.New(
dir.Root("/path/to/workdir"), // 默认工作目录 .
dir.Folder("config"), // 增加子文件夹 config
dir.Folder("logs"), // 增加子文件夹 logs
)
if err := workdir.Open(); err != nil {
return err
}
//常规操作
//判断子目录是否存在
//func (d *Dir) DirExists(elems ...string) (bool, error)
exist, err := workdir.DirExists("logs", "20220515") // 判断 [root]/logs/20220515
//判断文件是否存在
//func (d *Dir) Exists(elems ...string) (bool, error)
exist, err := workdir.Exists("logs", "20220515","info.log") // 判断 [root]/logs/20220515/info.log
//获取目录内的文件名
// func (d *Dir) Files(elems ...string) ([]string, error)
files, err := workdir.Files("config")
//获取目录内的子文件夹
// func (d *Dir) Folders(elems ...string) ([]string, error)
folders, err := workdir.Folders("logs")
//判断文件夹是否为空
// func (d *Dir) IsEmpty(elems ...string) (bool, error)
empty, err := workdir.IsEmpty("config")
//创建子目录
//func (d *Dir) Mkdir(elems ...string) (string, error)
pathname, err := workdir.Mkdir("logs", "20220515", "errors") // 创建 [root]/logs/20220515/errors/
//获取绝对路径
//func (d *Dir) Path(elems ...string) string
abspath := workdir.Path("logs", "20220515","info.log") // abs[root]/logs/20220515/info.log
//删除文件夹
//func (d *Dir) Remove(elems ...string) error
workdir.Remove("configs")
//删除非空文件夹
//func (d *Dir) RemoveAll(elems ...string) error
workdir.RemoveAll("logs")
````
## Embed Resource
in `main.go`:
```go
package main
import (
"github.com/x-mod/dir"
)
//go:embed embed/config/*
var embeddir embed.FS
func main() {
dir.EmbedFS = embeddir //全局设置内嵌
...
}
```
then copy embed files to the workdir directory:
```go
import "github.com/x-mod/dir"
//初始化工作目录
workdir := dir.New(
dir.Root("/path/to/workdir"), // 默认工作目录 .
dir.Folder("config"), // 增加子文件夹 config
)
if err := workdir.Open(); err != nil {
return err
}
//将内嵌资源复制到 config 子目录
if err := workdir.EmbedSkip(1, "embed"); err != nil {
return fmt.Errorf("workdir embed: %w", err)
}
```