realglobe-inc / pon-task-fs

Pon task for file system

pon-task-fs

Pon task for file system

Installation

$ npm install pon-task-fs --save

Usage

'use strict'

const pon = require('pon')
const { mkdir } = require('pon-task-fs')

async function tryExample () {
  let run = pon({
    'fs:mkdir': mkdir([
      'doc',
      'example',
      'lib',
      'test',
      'tmp'
    ])
  })

  run('fs:*')
}

tryExample()

Signatures

chmod(permissions, options) -> function

Define task

Param	type	Description
permissions	Object.<string, string>	File pattern and permissions
options	Object	Optional settings

concat(src, dest, options) -> function

Concat multiple file into one

Param	type	Description
src	string|string[]
dest	function
options	Object	Optional settings

cp(linkages, options) -> function

Define task

Param	type	Description
linkages	Object.<string, string>	Directory copy ruling
options	Object	Optional settings
options.force	boolean	Force create
options.ignore	string[]	Ignore patterns to copy

define(options) -> function

Define task

Param	type	Description
options	Object	Optional settings
options.mkdir	Array	Options for mkdir

del(Patterns, options) -> function

Define task

Param	type	Description
Patterns	string|string[]	File pattern to delete
options	Object	Optional settings

mkdir(dirnames, options) -> function

Define task

Param	type	Description
dirnames	string[]	Directory name to make
options	Object	Optional settings

symlink(linkages, options) -> function

Define symlink task

Param	type	Description
linkages	Object.<string, string>	File link ruling
options	Object	Optional settings
options.force	boolean	Force create
options.preferDir	boolean	Create directory if source path does'nt exist

write(filename, content, options) -> function

Define task

Param	type	Description
filename	string	File name write
content	string|Buffer|function	Content or content creator function
options	Object	Optional settings

License

This software is released under the Apache-2.0 License.

Links

• Pon
• Realglobe, Inc.