Tatami

Tatami is command line tool for making folder structure.

Getting started

npm install -g tatami

1. Create Tatamifile

tatami init

tatami init create Tatamifile in current directory.

2. Edit Tatamifile

3. Run tatami

tatami run

tatami run parses Tatamifile, make folder structure.

Learn Tatamifile DSL in 30 seconds

• Tatami parses indent.

//This is Sample Tatami file
server/
	server.js
public/
	img/
	index.html
	dist/
		main.css
	src/
		main.scss
gulpfile.js
README.md

• In above case, 'tatami run' result is...

% tree .
.
├── README.md
├── Tatamifile
├── gulpfile.js
├── public
│   ├── dist
│   │   └── main.css
│   ├── img
│   ├── index.html
│   └── src
│       └── main.scss
└── server
    └── server.js
5 directories, 7 files

• In case of "Directory", after directory name, attach "/".

directory/ -> 'directory'

• When word includes extension or no extension, tatami recognizes "File".

Makefile -> 'file'
README.md -> 'file'

• "Comment" is allowed only oneline comment, begin "//"

// This is Comment -> 'comment'

tatami parses by oneline, at this stage only one line comment is allowed.

Other command

tatami rollback

tatami rollback parses Tatamifile, rollback before tatami run.

tatami path

tatami path output path to result parsing Tatamifile.

Link

page: http://tommykishi.github.io/tatami/ npm:

Lisense

MIT