# charlike [![NPM version](https://img.shields.io/npm/v/charlike.svg?style=flat)](https://www.npmjs.com/package/charlike) [![NPM downloads](https://img.shields.io/npm/dm/charlike.svg?style=flat)](https://npmjs.org/package/charlike) [![npm total downloads][downloads-img]][downloads-url] > Small, fast, simple and streaming project scaffolder for myself, but not only. Supports hundreds of template engines through the @JSTransformers API or if you want custom `render` function passed through options [![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![linux build status][travis-img]][travis-url] [![windows build status][appveyor-img]][appveyor-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] You might also be interested in [charlike-cli](https://github.com/tunnckocore/charlike-cli#readme). ## Table of Contents - [Install](#install) - [Usage](#usage) - [API](#api) * [charlike](#charlike) - [Related](#related) - [Contributing](#contributing) - [Building docs](#building-docs) - [Running tests](#running-tests) - [Author](#author) - [Logo](#logo) - [License](#license) _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ ## Install Install with [npm](https://www.npmjs.com/) ``` $ npm install charlike --save ``` or install using [yarn](https://yarnpkg.com) ``` $ yarn add charlike ``` ## Usage > For more use-cases see the [tests](test.js) ```js const charlike = require('charlike') ``` ## API ### [charlike](index.js#L64) > Scaffolds project with `name` and `desc` by creating folder with `name` to some folder. By default it generates folder with `name` to current working directory (or `options.cwd`). You can also define what _"templates"_ files to be used by passing `options.templates`, by default it uses [./templates](./templates) folder from this repository root. **Params** * `` **{String}**: project name * `` **{String}**: project description * `[options]` **{Object}**: use `options.locals` to pass more context to template files, use `options.engine` for different template engine to be used in template files, or pass `options.render` function to use your favorite engine * `returns` **{Promise}**: if successful, resolved promise with absolute path to the project **Example** ```js const charlike = require('charlike') const opts = { cwd: '/home/charlike/code', templates: '/home/charlike/config/.jsproject', locals: { foo: 'bar', // some helper toUpperCase: (val) => val.toUpperCase() } } charlike('my-awesome-project', 'some cool description here', opts) .then((dest) => console.log(`Project generated to ${dest}`)) .catch((err) => console.error(`Error occures: ${err.message}; Sorry!`)) ``` ## Related - [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more") - [each-promise](https://www.npmjs.com/package/each-promise): Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start… [more](https://github.com/tunnckocore/each-promise#readme) | [homepage](https://github.com/tunnckocore/each-promise#readme "Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start, beforeEach, afterEach, finish)") - [j140](https://www.npmjs.com/package/j140): Template engine in 140 bytes, by @jed Schmidt. Support helpers, partials and pre-compiled templates. For nodejs and the browser. Browserify-ready. | [homepage](https://github.com/tunnckocore/j140#readme "Template engine in 140 bytes, by @jed Schmidt. Support helpers, partials and pre-compiled templates. For nodejs and the browser. Browserify-ready.") - [jstransformer](https://www.npmjs.com/package/jstransformer): Normalize the API of any jstransformer | [homepage](https://github.com/jstransformers/jstransformer#readme "Normalize the API of any jstransformer") - [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.") - [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.") ## Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/charlike/issues/new). Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards. If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too. **In short:** If you want to contribute to that project, please follow these things 1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section. 2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section. 3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy. 4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy. Thanks a lot! :) ## Building docs Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that ``` $ npm install verbose/verb#dev verb-generate-readme --global && verb ``` _Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._ ## Running tests Clone repository and run the following in that cloned directory ``` $ npm install && npm test ``` ## Author **Charlike Mike Reagent** + [github/tunnckoCore](https://github.com/tunnckoCore) + [twitter/tunnckoCore](http://twitter.com/tunnckoCore) + [codementor/tunnckoCore](https://codementor.io/tunnckoCore) ## Logo The logo is [Monster Icon](http://thenounproject.com/term/moster/63928/) by [Christian Mohr](http://www.thenounproject.com/mom-digital). Released under the [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/us/) license. ## License Copyright © 2016, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 30, 2016._ _Project scaffolded using [charlike][] cli._ [always-done]: https://github.com/hybridables/always-done [async-done]: https://github.com/gulpjs/async-done [base]: https://github.com/node-base/base [commitizen]: https://github.com/commitizen/cz-cli [dezalgo]: https://github.com/npm/dezalgo [once]: https://github.com/isaacs/once [standard-version]: https://github.com/conventional-changelog/standard-version [verb-generate-readme]: https://github.com/verbose/verb-generate-readme [verb]: https://github.com/verbose/verb [downloads-url]: https://www.npmjs.com/package/charlike [downloads-img]: https://img.shields.io/npm/dt/charlike.svg [codeclimate-url]: https://codeclimate.com/github/tunnckoCore/charlike [codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/charlike.svg [travis-url]: https://travis-ci.org/tunnckoCore/charlike [travis-img]: https://img.shields.io/travis/tunnckoCore/charlike/master.svg?label=linux [appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/charlike [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/charlike/master.svg?label=windows [coveralls-url]: https://coveralls.io/r/tunnckoCore/charlike [coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/charlike.svg [david-url]: https://david-dm.org/tunnckoCore/charlike [david-img]: https://img.shields.io/david/tunnckoCore/charlike.svg [standard-url]: https://github.com/feross/standard [standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [charlike]: https://github.com/tunnckocore/charlike