Skip to content

Commit ad768aa

Browse files
committed
Merge branch 'pollinate'
2 parents b3fc2fd + d2e5a40 commit ad768aa

File tree

8 files changed

+112
-7
lines changed

8 files changed

+112
-7
lines changed

.travis.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,8 @@ before_script:
1212
- npm prune
1313
script:
1414
- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
15-
15+
after_success:
16+
- npm run semantic-release
17+
branches:
18+
except:
19+
- /^v\d+\.\d+\.\d+$/

PROJECT-LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016-present {{ author }}
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

PROJECT-README

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# {{ name }}
2+
3+
[![Build Status](https://travis-ci.org/{{ organization }}/{{ name }}.svg?branch=master)](https://travis-ci.org/{{ organization }}/{{ name }})
4+
[![Coverage Status](https://coveralls.io/repos/github/{{ organization }}/{{ name }}/badge.svg?branch=master)](https://coveralls.io/github/{{ organization }}/{{ name }}?branch=master)
5+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
6+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
7+
8+
{{ description }}
9+
10+
## Usage
11+
12+
```sh
13+
npm install --save {% if scope %}@{{ scope }}/{% endif %}{{ name }}
14+
```
15+

PROJECT-package.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"name": "{% if scope %}@{{ scope }}/{% endif %}{{ name }}",
3+
"version": "0.0.0-development",
4+
"description": "{{ description }}",
5+
"repository": {
6+
"type": "git",
7+
"url": "https://github.com/{{ organization }}/{{ name }}.git"
8+
},
9+
"author": "{{ author }}",
10+
"bugs": {
11+
"url": "https://github.com/{{ organization }}/{{ name }}/issues"
12+
},
13+
"homepage": "https://github.com/{{ organization }}/{{ name }}#readme"
14+
}
15+

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,21 @@
22

33
[![Build Status](https://travis-ci.org/jedwards1211/es2015-library-skeleton.svg?branch=master)](https://travis-ci.org/jedwards1211/es2015-library-skeleton)
44
[![Coverage Status](https://coveralls.io/repos/github/jedwards1211/es2015-library-skeleton/badge.svg?branch=master)](https://coveralls.io/github/jedwards1211/es2015-library-skeleton?branch=master)
5+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
56
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
67

78
This is my personal skeleton for creating an ES2015 library npm package. You are welcome to use it.
89

10+
## Quick start
11+
12+
```sh
13+
# this PR of mine will hopefully be merged soon
14+
npm i -g howardroark/pollinate#keep-history
15+
pollinate https://github.com/jedwards1211/es2015-library-skeleton.git#pollinate --name <package name> --author <your name> --organization <github organization> --description <package description>
16+
cd <package name>
17+
npm i
18+
```
19+
920
## Tools used
1021

1122
* babel 6
@@ -18,9 +29,8 @@ This is my personal skeleton for creating an ES2015 library npm package. You ar
1829
* eslint-watch
1930
* flow
2031
* flow-watch
21-
* husky
22-
* commitmsg: uses validate-commit-msg
23-
* precommit: runs lint and flow
24-
* prepush: runs test
32+
* pre-commit (runs eslnt and flow)
33+
* semantic-release
2534
* Travis CI
2635
* Coveralls
36+

complete.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/usr/bin/env bash
2+
set -e
3+
4+
git remote rename origin skeleton
5+
git branch -D master
6+
git checkout -b master
7+
rm complete.sh
8+
git add --all .
9+
git commit -n -m 'pollinate project'
10+

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "es2015-library-skeleton",
33
"version": "0.0.0-development",
4-
"description": "my personal skeleton for ES2015 library NPM packages",
4+
"description": "my personal ES2015 library project skeleton",
55
"main": "lib/index.js",
66
"scripts": {
77
"lint": "eslint src test",
@@ -19,7 +19,8 @@
1919
"precommit": "npm run lint && flow",
2020
"prepush": "npm test",
2121
"prepublish": "npm run lint && flow && npm test && npm run build && npm run copy-flow-files",
22-
"open:coverage": "open coverage/lcov-report/index.html"
22+
"open:coverage": "open coverage/lcov-report/index.html",
23+
"semantic-release": "semantic-release pre && npm publish && semantic-release post"
2324
},
2425
"config": {
2526
"mocha": "--compilers js:babel-core/register ./test/**/*.js",
@@ -76,6 +77,7 @@
7677
"mocha": "^3.2.0",
7778
"nyc": "^10.1.2",
7879
"rimraf": "^2.6.0",
80+
"semantic-release": "^6.3.6",
7981
"validate-commit-msg": "^2.11.1"
8082
},
8183
"dependencies": {}

template.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"organization": "jedwards1211",
3+
"scope": "",
4+
"name": "es2015-library-skeleton",
5+
"description": "my personal skeleton for ES2015 library NPM packages",
6+
"author": "Andy Edwards",
7+
"parse": [
8+
"PROJECT-README",
9+
"PROJECT-LICENSE",
10+
"PROJECT-package.json"
11+
],
12+
"merge": [
13+
["package.json", "PROJECT-package.json"]
14+
],
15+
"discard": [
16+
"README.md",
17+
"LICENSE.md",
18+
"PROJECT-package.json",
19+
"template.json"
20+
],
21+
"move": [
22+
{ "PROJECT-README": "README.md" },
23+
{ "PROJECT-LICENSE": "LICENSE.md" }
24+
],
25+
"complete": "cd {{ name }} && ./complete.sh"
26+
}
27+

0 commit comments

Comments
 (0)