# app-file-create
[![NPM][img-npm]][url-npm]
[![Build Status][img-travis]][url-travis]
[![Dependencies][img-david]][url-david]
[![Language][img-javascript]][url-github]
[![License][img-mit]][url-mit]
A package to create files and directory for WeChat and Alipay miniProgram, and also support for other programs to use, [中文](./README.md)
## Install
```bash
npm install app-file-create --save-dev
```
## Options
Name | Type | Default | Description
--- | --- | --- | ---
`root` | String | `process.cwd()` | Output directory
`env` | String | `wechat` | Running environment，`alipay`、`wechat` or empty string
`debug` | Boolean | `false` | Use debug mode, if true will show log info
`replace` | Boolean | `false` | Replace old files
`dirname` | String | `index` | Folder name
`filename` | String | -- | Subfile name，the default filename is the same as `dirname` abolve
`files` | Array | `[`
`fileOption`
`]` | Subfiles Array, `fileOption` is an object，or file extension string
`fileOption.ext` | String | -- | File extension
`fileOption.filename` | String | -- | Filename, the default filename is the same as `options.filename`, or `options.dirname`
`fileOption.template` | String \| Function | -- | File's template, if it is `Function`, the first argument is `args` below
`fileOption.args` | Object | `{}` | The argumant for rending template, if `fileOption.template` is `Function`, `args` will be effective
## Methods
- `config` - config default options, notice: when to use `AppFileCreate([options])`, the options will cover default config
```javascript
const AppFileCreate = require('app-file-create');
const pageRoot = __dirname + '/pages';
AppFileCreate.config({
root: pageRoot,
debug: true
});
```
## Examples
- Create WeChat miniProgram page (微信小程序)
```javascript
AppFileCreate({
dirname: 'wx_page',
files: ['js', 'json', 'wxml', 'wxss']
});
```
- Create Alipay miniProgram page (支付宝小程序)
```javascript
AppFileCreate({
env: 'alipay',
dirname: 'ali_page',
files: [
'js',
'axml',
'acss',
{
ext: 'json',
args: {
title: '个人信息'
}
}
]
});
```
- Create web page
```javascript
AppFileCreate({
env: '',
dirname: 'web_page',
files: [
'js',
{
ext: 'html',
template:
`
`
}
]
});
```
- Create other files, folder name is different from subfile name
```javascript
AppFileCreate({
env: '',
dirname: 'diff_dir_page',
filename: 'child',
files: ['js', 'css']
});
```
- Create other files，subfile name is different
```javascript
AppFileCreate({
env: '',
dirname: 'diff_filename_page',
files: [{
ext: 'js',
filename: 'a'
},{
ext: 'css',
filename: 'b'
}]
});
```
## License
[![license][img-mit]][url-mit]
[url-github]: https://github.com/ChanceYu/app-file-create
[url-npm]: https://www.npmjs.com/package/app-file-create
[url-travis]: https://travis-ci.org/ChanceYu/app-file-create
[url-david]: https://david-dm.org/ChanceYu/app-file-create
[url-mit]: https://opensource.org/licenses/mit-license.php
[img-npm]: https://nodei.co/npm/app-file-create.png?compact=true
[img-travis]: https://travis-ci.org/ChanceYu/app-file-create.svg?branch=master
[img-david]: https://david-dm.org/ChanceYu/app-file-create/status.svg
[img-javascript]: https://img.shields.io/badge/language-JavaScript-brightgreen.svg
[img-mit]: https://img.shields.io/badge/license-MIT-blue.svg