npm

Need private packages and team management tools?Check out npm Orgs. »

kiss-cli

0.4.5 • Public • Published

#️⃣ 🔧 KISS

You could have need KISS if

  • You are a developer
  • You are a developer in a team of developers
  • You share templates with your team (Back/Front)
  • You are bored of copying/pasting script content to create new script files
  • ... 💋

KISS allows you to create your own snippets for a context and share these with your project's teammates. A single command line can generate single or multiple files from these templates.

🍝 a Dev story telling (A.K.A. The Example)

What we usually do

# ...(creating a new file) 
# ...(looking for a base file) 
# ...(copying existing content) 
# ...(pasting existing content into the new file) 
# ...(checking for unused code) 
# ...(removing all unused code) 
# ...(re-checking if you have forgotten something) 
# ...(re-checking cause you probably forgot something) 
# ...(adding some new code) 

🍪 ...and how you can do with your own defined templates

# A simple ExpressJS server from default templates 
kiss ./myserver/index.server ./myserver/public/index.html

🍿 Try it!

  • KISS must be installed globally
  • To add new types, create templates in a folder named .kiss at the root directory of your project beside of your package.json file
  • Templates files must be named <type>.<extension>
  • Kiss priorize templates in (project)/.kiss > /User/home/.kiss > (global)node_modules/.kiss
npm install -g kiss-cli
mkdir myproject && cd myproject
kiss ./src/nav.<type> ./src/btn1.<type2> ./src/btn2.<type2>

Options

Generate multiple files based on the same template

kiss <type> <relative/path/to/myfile.ext> [<r/p/t/myfile.ext> ...]

Generate multiple files based on differents templates

kiss <relative/path/to/myfile.type> [<r/p/t/myfile.type> ...]

Show available types

kiss *

Defaults available types/templates

  • html HTML minimal ready page
  • gulpfile Gulpfile
  • mocha Simple Mocha test file
  • server Simple ExpressJS server
  • React
    • redux A Redux connected pure component
    • dumb Dump component

History

  • v0.3.9
    • update documentation
  • v0.3.4
    • 🚀 Release version
  • v0.3.1
    • Refactor all the things in ES6
    • Removing Angular, AMD, Grunt... Templates
    • Adding React Templates
  • v0.2.0
    • Generate files by types extension
  • v0.1.41
    • Remove --debug option
    • Remove commander as cli parser
  • v0.1.40
    • Manage dotfiles
  • v0.1.34
    • Custom templates in your home folder
    • Custom templates in your project folder
    • project folder > home folder > kiss folder
  • v0.1.24
    • Fix install 'npm install -g kiss-cli'

About

This file generator was motivated by the famous French Bonaldi's Effect:
It's totally unnecessary and therefore strictly indispensable!
But it's also a great concept of the play La Cantatrice chauve by Eugène Ionesco :)

Issues

  • Overwrite an existing file without prompts
  • Not so Asynchronous
  • Files permissions
  • Units Tests...
  • 🍎 tested only

MIT License NPM version NPM downloads Build Coverage

install

npm i kiss-cli

Downloadsweekly downloads

40

version

0.4.5

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability