https://github.com/ulivz/kopee
A high-level interface for succinct files coping
https://github.com/ulivz/kopee
Last synced: 3 months ago
JSON representation
A high-level interface for succinct files coping
- Host: GitHub
- URL: https://github.com/ulivz/kopee
- Owner: ulivz
- Created: 2022-01-13T15:58:59.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T08:33:37.000Z (over 2 years ago)
- Last Synced: 2025-07-01T07:17:39.596Z (4 months ago)
- Language: TypeScript
- Size: 330 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
kopee
kopee is a high-level interface for succinct files coping, with 100% test coverage as guarantee.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Install](#install)
- [API](#api)
- [`cp()`](#cp)
- [Usage](#usage)
- [Copy all files](#copy-all-files)
- [Copy partial files](#copy-partial-files)
- [Override files](#override-files)
- [Transform files.](#transform-files)
- [Rename files](#rename-files)
- [Rename \& transform files](#rename--transform-files)
- [Do not write to disk](#do-not-write-to-disk)
- [Write to symtem tmp](#write-to-symtem-tmp)
- [Contributing](#contributing)
- [License](#license)
## Features
- Copy all or partial files.
- Overriding files with glob patterns.
- Default content.
- Transform files with glob patterns.
- Rename files with glob patterns.
- Do not write to disk.
- Write to symtem temporary disk.
- Full TypeScript support.
## Install
```bash
npm i kopee --save
```
## API
### `cp()`
- **Type**: `(opts: ICopyOptions) => Promise`
Source code of types：
- [ICopyOptions](https://github.com/ulivz/copy/blob/master/src/interface.ts#L83)。
- [ICopyStream](https://github.com/ulivz/copy/blob/master/src/index.ts#L32)。
## Usage
```bash
const { cp } = require('kopee')
```
### Copy all files
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
});
```
which is equivalent to:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: ["**"],
});
```
and:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
},
});
```
### Copy partial files
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: ["package.json"],
});
```
glob patterns is also supported:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: [
"**/*.ts", // Only copy all *.js files.
],
});
```
### Override files
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
"package.json": {
override: '{ "name": "kopee" }',
},
},
});
```
which is equivalent to:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
// package.json will be replaced with new content.
"package.json": '{ "name": "kopee" }',
},
});
```
overriding function is also supported:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
"package.json": {
override: (filename, content) => {
// return new content
},
},
},
});
```
which is equivalent to:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
"package.json": (filename, content) => {
// return new content
},
},
});
```
Note that if the source files don't exists, the overriding result will be used as the default content.
You can enable the `disableOverride` flag to disable the overriding behaviors but only keep the behavior of using as default content.
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
disableOverride: true,
files: {
"**": true,
// This content will be used as the default content when "package.json" doesn't exist.
"package.json": "{}",
},
});
```
### Transform files.
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
// Add banner in the front of all *.ts files.
"**/*.ts": { transform: (content) => `${BANNER}\n${content}` },
},
});
```
### Rename files
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
"package.json": { rename: "config.json" },
},
});
```
renaming function is also supported:
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": {
rename: (filename) => `lib/${filename}`,
},
},
});
```
### Rename & transform files
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
files: {
"**": true,
"package.json": {
rename: "package.json",
transform: (content) => `${BANNER}\n${content}`,
},
},
});
```
### Do not write to disk
```js
cp({
src: "/path/to/source/dir",
dist: "/path/to/output/dir",
write: false,
});
```
### Write to symtem tmp
```js
import { TEMP } from "kopee";
const stream = await cp({
src: "/path/to/source/dir",
dist: TEMP,
write: false,
debug: true,
});
// Get temp path with stream.destBaseDir.
```
For other usage, please refer to [unit tests](./__tests__)
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
Copyright (c) 2021-present, ULIVZ.