https://github.com/pspgbhu/template-down
It is useful for creating a template by git clone. It saved the template to local cached folder, and it will execute git pull and cp instead of git clone every time creating template. So it could significantly improve the speed of installing template.
https://github.com/pspgbhu/template-down
clone clone-template download git-cache git-clone template
Last synced: 11 months ago
JSON representation
It is useful for creating a template by git clone. It saved the template to local cached folder, and it will execute git pull and cp instead of git clone every time creating template. So it could significantly improve the speed of installing template.
- Host: GitHub
- URL: https://github.com/pspgbhu/template-down
- Owner: pspgbhu
- Created: 2018-08-28T06:32:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-28T11:00:08.000Z (over 7 years ago)
- Last Synced: 2025-02-21T22:37:36.806Z (12 months ago)
- Topics: clone, clone-template, download, git-cache, git-clone, template
- Language: JavaScript
- Homepage:
- Size: 112 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# template-down
It is useful for creating a template by git clone. It saved the template to local cached folder, and it will execute `git pull` and `cp` instead of `git clone` every time creating template. So it could significantly improve the speed of installing template.
## install
```bash
$ npm install template-down
```
## Usage
```js
const path = require('path');
const os = require('os');
const templateDown = require('template-down');
templateDown({
git: 'pspgbhu/template-down',
target: './project',
cacheDir: path.join(os.homedir(), '.template-down', 'template'),
}).then(() => {
console.log('Generated template success!');
});
```
**templateDown(options)**
- **options.git ``**
The URL of git repository. If this is a github repository, you just input as `"/"`, else must input the whole URL.
- **options.target ``**
Create the template to this folder.
- **options.cacheDir ``**
Default: `path.join(os.homedir(), '.template-down', hash)`(same options.git have same hash).
The template repository will be cached in this folder.
- **options.branch ``**
Default: `'master'`.
The branch of the repository.
- **options.offline ``**
Default: `false`.
If this value is `true`, it would copied files directly to target folder, rather than execute `git pull` before copy files. Must pay attenation to that it dependent on the local cached files, if there are not cached files, it will execute `git clone` before copy. It currently only work with the situation that `options.way` equal to `'git'`
- **options.way ``**
Default: `'git'`.
The way of downloading template. The valid value are `'git'` or `'zip'`. `'git'` means by git clone, `'zip'` means by downloading zip and extracting.
- **options.zip ``**
If `options.way` is `'zip'`, and the value of `options.git` is a whole URL, you must input a zip download URL in this property. If `options.git` is same as `'/'`, you could ignore this item, and it will automatic generated zip download URL.