Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/howardroark/pollinate

Template your base files and generate new projects from Git(Hub).
https://github.com/howardroark/pollinate

boilerplate cli generator git github nunjucks parsing project scaffolding schema skeleton templates yeoman

Last synced: 2 months ago
JSON representation

Template your base files and generate new projects from Git(Hub).

Awesome Lists containing this project

README 

        
# ![Pollinate](https://raw.githubusercontent.com/howardroark/pollinate/develop/media/readme.png)



Generate a new project directly from Git(Hub) using a simple schema.



[![npm version](https://badge.fury.io/js/pollinate.svg)](https://badge.fury.io/js/pollinate)  [![Build Status](https://travis-ci.org/howardroark/pollinate.svg?branch=develop)](https://travis-ci.org/howardroark/pollinate) [![Dependency Status](https://david-dm.org/howardroark/pollinate.svg)](https://david-dm.org/howardroark/pollinate)



## What?



It is a command that takes a templated tree of files and generates them for new

projects using data defined by a simple schema. The data can define an output

`name`, files to `discard`, files to `parse` with the data, and files to `move`

or rename. The template can supply the default data, and that data can be

extended for each project.  You can throw in any other data you'd like to be

passed to the template context as well.



All templates are parsed with [Nunjucks](http://mozilla.github.io/nunjucks/) aka

[Jinja](http://jinja.pocoo.org/) and [Twig](http://twig.sensiolabs.org/).



## Why?



When starting new projects the quickest way is often to just copy the last project and

fiddle with it until it works. This can introduce many unwanted issues, like having one

client's name appear in place of the other's. This project's goal is to offer an elegant

and efficient way of working with a base set of files that can be understood by looking

at a single example.



## Install



```

$ npm install -g pollinate

```



## An example



```

$ pollinate howardroark/webapp --name newproject --image alpine --description="A thing that does something."

```

[Skip to more examples...](#more-options)



##### The GitHub sourced template



```

.

├── PROJECT-README

├── README.md

├── Dockerfile

├── project-name

└── template.json

```



###### `template.json` (optional)



```

{

  // Core schema

  "name": "webapp",

  "parse": [

    "PROJECT-README",

    "Dockerfile"

  ],

  "discard": [

    "README.md",

    "template.json"

  ],

  "move": [

    { "PROJECT-README": "README.md" },

    { "project-name": "{{ name }}.txt" }

  ],

  // Custom defaults

  "image": "debian",

  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."

}

```



You can omit any or all of `discard`, `parse` and `move`. 



###### `PROJECT-README`



```

# {{ name }}



{{ description }}

```



###### `Dockerfile`



```

FROM {{ image }}

```



##### The project data



```

{

  "name": "newproject",

  "image": "alpine",

  "description": "A thing that does something."

}

```



##### The data after extending and parsing



```

{

  "name": "newproject",

  "parse": [

    "Dockerfile",

    "PROJECT-README"

  ],

  "discard": [

    "README.md",

    "template.json"

  ],

  "move": [

    { "PROJECT-README": "README.md" },

    { "project-name": "newproject.txt" }

  ],

  "image": "alpine",

  "description": "A thing that does something."

}

```



##### The result



```

.

└── newproject

   ├── README.md

   ├── newproject.txt

   └── Dockerfile

```



###### `README.md`



```

# newproject



A thing that does something.

```



###### `Dockerfile`



```

FROM alpine

```



## More options



You can specify template files as a local directory (.git will be removed)

```

$ pollinate ./template --name newproject --image ubuntu

```



You can use any Git url (.git will be removed)

```

$ pollinate https://github.com/howardroark/webapp.git --name newproject --image ubuntu

```



You can pass project data as a file

```

$ pollinate howardroark/webapp data.json

```



You can pass project data as a JSON string

```

$ pollinate howardroark/webapp '{"name":"newproject","image":"alpine","description":"A thing that does a thing."}'

```



You can pass project data as a JSON endpoint

```

$ pollinate howardroark/webapp https://example.com/json/data

```



You can generate from the default data in the template

```

$ pollinate howardroark/webapp

```



You can override data as CLI options

```

$ pollinate howardroark/webapp data.json --name=alternate --image=ubuntu

```



You can specify a command to run on completion

```

{

  "complete": "git init {{ name }}"

}

```



You can supply user specific data each time with a `~/.pollen` defaults file



```

{

  "api_key":"secret"

}

```



You can preserve the commit history from the skeleton project with the `--keep-history` CLI option or:



```

{

  keepHistory: true

}

```



## Filters



You can supply custom [Nunjucks `filter`](https://mozilla.github.io/nunjucks/templating.html#filters) functions (files must be included within template)



```

{

  "filters": {

    "markdown": "filters/markdown.js"

  }

}

```



##### `filters/markdown.js`



```

var markdownParser = function() { ... }



module.exports = function(markdownText) {

  var html = markdownParser(markdownText)

  return '
'+html+'
'

}

```



## Parse



All `parse` paths are first passed to [globby](https://github.com/sindresorhus/globby)



```

{

  "parse": ["*"]

}

```

```

{

  "parse": [

    "*",

    "!templates"

  ]

}

```



## Merge



You can specify `.json` files to merge



#### `package.json`

```json

{

  "name": "@howardroark/webapp",

  "version": "1.0.0",

  "description": "project for testing pollinate with merge",

  "main": "index.js",

  "repository": {

    "type": "git",

    "url": "git+https://github.com/howardroark/webapp.git"

  },

  "author": "Andy Edwards",

  "license": "ISC",

  "bugs": {

    "url": "https://github.com/howardroark/webapp/issues"

  },

  "homepage": "https://github.com/howardroark/webapp#readme",

  "dependencies": {

    "lodash": "^4.17.4"

  }

}

```



#### `PROJECT-package.json`

```json

{

  "name": "@{{ organization }}/{{ name }}",

  "version": "1.0.0",

  "description": "{{ description }}",

  "repository": {

    "type": "git",

    "url": "git+https://github.com/{{ organization }}/{{ name }}.git"

  },

  "author": "{{ author }}",

  "bugs": {

    "url": "https://github.com/{{ organization }}/{{ name }}/issues"

  },

  "homepage": "https://github.com/{{ organization }}/{{ name }}#readme",

}

```



#### `template.json`

```json

{

  "name": "webapp",

  "description": "project for testing pollinate with merge",

  "organization": "howardroark",

  "author": "Andy Edwards",

  "parse": [

    "PROJECT-package.json"

  ],

  "merge": [

    ["package.json", "PROJECT-package.json"]

  ],

  "discard": [

    "PROJECT-package.json"

  ]

}

```



#### command

```

pollinate howardroark/webapp#merge-test --name myapp --description 'my new app' --organization myorg --author Me

```



This will overwrite `package.json` with the contents of `package.json` and `PROJECT-package.json` merged with

`lodash.merge`.  This is useful when you want to keep template variables out of `package.json`, since they would cause

certain `npm` commands to fail.



#### Resulting `package.json`

```json

{

  "name": "@myorg/myapp",

  "version": "1.0.0",

  "description": "my new app",

  "main": "index.js",

  "repository": {

    "type": "git",

    "url": "git+https://github.com/myorg/myapp.git"

  },

  "author": "Me",

  "license": "ISC",

  "bugs": {

    "url": "https://github.com/myorg/myapp/issues"

  },

  "homepage": "https://github.com/myorg/myapp#readme",

  "dependencies": {

    "lodash": "^4.17.4"

  }

}

```



### Thanks



- [@binhood](https://dribbble.com/binhood) for the fantastic work on the logo!

- [@jedwards1211](https://github.com/jedwards1211) for the handy object `merge` option :)

- [@ben657](https://github.com/ben657) for refactoring a bunch of stuff :o



[0]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square

[1]: https://nodejs.org/api/documentation.html#documentation_stability_index