runfile

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #go #golang #machine-learning #rust #macos #awesome #cli #kubernetes #security #ios #openai

(★ 24)

A minimal alternative for GNU Makefile.

runfile Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# runfile

[![NPM version](https://img.shields.io/npm/v/runfile.svg?style=flat-square)](https://www.npmjs.com/package/runfile)
[![NPM download](https://img.shields.io/npm/dm/runfile.svg?style=flat-square)](https://www.npmjs.com/package/runfile)

🚧 A minimal alternative for GNU Makefile. You can use [Shell commands](https://github.com/shelljs/shelljs#command-reference), External tools in your OS directly and synchronously with Runfile.

Additionally it's brought with built-in ES2015 support through Babel.

![preview](http://ww4.sinaimg.cn/large/a15b4afegw1exec8v5mlyj20gc0a9gnt.jpg)

## Install

```bash
npm install -g runfile
```

## Example

An example `Runfile`

```javascript
task('clean', () => {
  rm('-rf', 'testFolder')
  rm('-rf', 'testSource')
})

// or run external tools
task('deploy', () => {
  var message = argv._[1] || 'update'
  exec('git add -A')
  exec(`git commit -m "${message}"`)
  exec('git push origin master')
})

task('default', ['clean', 'deploy'])

// alia `run path` to external command `echo $PATH`
// to print your $PATH info in console
// a short-hand for one-line task
alias('path', 'echo $PATH')
// or a sequence of commands
alias('async', [
  'echo Hi',
  'sleep 1',
  'echo After 1s'
])
```

then in your favorite terminal:

```bash
run clean
run deploy
```

**Run tasks synchronously**

```javascript
task('timeout', (callback) => {
  setTimeout(() => {
    console.log('timeout')
    callback()
  }, 3000)
})

task('log', ['timeout'], () => {
  console.log(argv)
})

task('default', ['log'])

// then `run`
```

**Run non-block synchronous task**

Besides `exec()` and built-in shell commands, [`async/await`](https://github.com/tc39/ecmascript-asyncawait) also allows you to write async code in sync way (looks like).

```javascript
import fs from 'fs'

function readFile (name) {
  return new Promise(function (resolve, reject) {
    fs.readFile(name, 'utf-8', function (err, data) {
      if (err) {
        reject(err)
      }
      resolve(data)
    })
  })
}

task('async', async () => {
  let data = await readFile('Runfile')
  console.log(data)
})
```

**Trigger a task by hand**

```javascript
task('emit', () => {
  emit('deploy')
})
```

**Running Node executable inside `./node_modules/.bin`**

```javascript
// just a short-hand for `./node_modules/.bin/webpack`
task('webpack', () => {
  const webpack = npm('webpack --hot --inline')
  if (process.platform === 'win32') {
    exec(`set NODE_ENV=development && ${webpack}`)
  } else {
    exec('NODE_ENV=development ${webpack}')
  }
})
```

**Run task from global Runfile**

Sometimes you repeat some common operations so you will always need a `Runfile` stored globally to access from anywhere.

```javascript
// find task `git` in `~\.runfile\Runfile`
run git -g
// alias
run :git
```

## License

MIT.

runfile

runfile Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

runfile

runfile Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README