Swift Package Index

Teapot

https://github.com/bannzai/teapot.git


Compatibility

  • 1.0.3 and master
    5.3
    5.2
    5.1
    5.0
    4.2
  • 1.0.3 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS

swift5.0 Platform License

Teapot

Teapot is command line tool writen by Swift.
It can be execute your shell command for each file, when file modified.

Required

Swift 5.0 or later. And it require to run on macOS.

Install

Using mint.

$ mint install bannzai/Teapot

Usage

First, Teapot necessary configuration file named teapot.yml. Teapot can prepare teapot.yml to under the current directory via $ teapot setup.

$ teapot setup
🍵 Teapot setup completion. You can edit ./teapot.yml 🍵

This will generate the following file:

source:
- build/*
- Sources/*.*
- Sources/Teapot/*.*
ignore:
- ".git"
- ".gitignore"
- tests/*
execute: 
- ls -la __FILE__
- echo $HOME
  • source is target file of listen to changing.
  • ignore is ignored target file of listen to changing.
  • execute is exec shell command for changed target file.
  • __FILE__ is mark of changed file. So, It is replaced when file changed.

Next, Teapot can be execute your shell command for each file when file modified for it according to teapot.yml configuration.

$ teapot start
🍵 Teapot start 🍵

For example, when you edit some file, teapot display result of $ ls -la to changed file.

LICENSE

Teapot is released under the MIT license. See LICENSE for details.

Header logo is released CC BY-NC 4.0 license. Original design by noainoue.