-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BREAKING: Remove support for old node versions + Support for greenkeeper
- Insert greenkeeper-badge if the greenkeeper badge, if if would show "enabled"
- Loading branch information
Showing
15 changed files
with
191 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{{#if (hasCoveralls)~}} | ||
[![Coverage Status](https://img.shields.io/coveralls/{{githubRepo}}.svg)](https://coveralls.io/r/{{githubRepo}}) | ||
{{/if}} | ||
{{~/if}} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{{#if (hasGreenkeeper)~}} | ||
[![Greenkeeper badge](https://badges.greenkeeper.io/{{githubRepo}}.svg)](https://greenkeeper.io/) | ||
{{/if}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
{{>badge/npm.md}} | ||
{{>badge/travis.md}} | ||
{{>badge/appveyor.md}} | ||
{{>badge/coveralls.md}} | ||
{{>badge/coveralls.md}} | ||
{{>badge/greenkeeper.md}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
test/fixtures/scenarios/with-greenkeeper/expected/CONTRIBUTING.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
## Contributing | ||
|
||
Contributions and feedback are always welcome. The expected procedure is the following: | ||
|
||
### Bugs, Features and Feedback | ||
|
||
* Please, create github issues for **feature-requests**, **bug reports**. | ||
* Feel free to open issues for **questions and problems you have**, even if they are not bugs | ||
or feature requests. | ||
* You may even open an issue just to say you like the project. | ||
* For small changes, such as **typo and formatting corrections**, you can immediately | ||
create a pull-request. You can use the github web-interface, but keep in mind that most of the documentation | ||
is created with Thought, so you should change the template in the `.thought` directory or change the default | ||
templates in [the thought project](https://github.com/nknapp/thought/tree/master/handlebars). | ||
* If you have an idea for a **new feature** that you would like to implement, please **open an issue** first and ask | ||
for feedback. Maybe someone else has a similar problem and different ideas. | ||
* If you encounter a bug you can submit a **pull-request for a failing unit test**, you should then also open an issue | ||
for the bug. | ||
* Before making a pull-request, make sure that you commit corresponds to the coding-style. You can do this by | ||
running `npm test`. | ||
|
||
**People submitting relevant contributions will be granted commit access to the repository.** | ||
|
||
|
||
### Coding style | ||
|
||
[![standard][standard-image]][standard-url] | ||
|
||
This repository uses [`standard`][standard-url] to maintain code style and consistency, | ||
and to avoid style arguments. You can run `npm run format` to apply the coding-style, but | ||
you may need to fix some things manually. Make sure to use the latest version of `standard`. | ||
|
||
|
||
### Installing & Testing | ||
|
||
You can fork and clone the repo from github. Run | ||
|
||
* Run `npm install` to install all the dependencies needed to build and run the project. | ||
* Run `npm test` to run unit tests and validate the `standard` coding-style. | ||
|
||
It is intentional to don't have `standard`, `thought`, `istanbul` and `coveralls` in the devDependencies. | ||
`standard` is a rather large package which you would not want to have copied into the `node_modules`-folder | ||
of each of your projects. | ||
|
||
Instead, the `pretest`- and `preformat`-scripts ensure that `standard` and `thought` are installed globally. | ||
If you are not allowed to install packages globally, please raise an issue, so that we can try to find a solution. | ||
|
||
|
||
### About this text | ||
|
||
This text is part of the [Thought](https://github.com/nknapp/thought)-project. If you have any suggestions or wishes | ||
to change the text, please raise an issue there for discussion. | ||
|
||
[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg | ||
[standard-url]: https://github.com/feross/standard |
48 changes: 48 additions & 0 deletions
48
test/fixtures/scenarios/with-greenkeeper/expected/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# simple-project | ||
|
||
[![NPM version](https://badge.fury.io/js/simple-project.svg)](http://badge.fury.io/js/simple-project) | ||
[![Travis Build Status](https://travis-ci.org/bootprint/bootprint.svg?branch=master)](https://travis-ci.org/bootprint/bootprint) | ||
[![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint.svg)](https://coveralls.io/r/bootprint/bootprint) | ||
[![Greenkeeper badge](https://badges.greenkeeper.io/bootprint/bootprint.svg)](https://greenkeeper.io/) | ||
|
||
> | ||
|
||
# Installation | ||
|
||
``` | ||
npm install simple-project | ||
``` | ||
|
||
|
||
## API-reference | ||
|
||
<a name="thought"></a> | ||
|
||
## thought(options) | ||
Execute Thought in the current directory | ||
|
||
**Kind**: global function | ||
**Api**: public | ||
|
||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| options | <code>object</code> | | | ||
| [options.cwd] | <code>string</code> | the working directory to use as project root | | ||
| [options.addToGit] | <code>boolean</code> | add created files to git | | ||
|
||
|
||
|
||
|
||
## License | ||
|
||
`simple-project` is published under the ISC-license. | ||
See []() for details. | ||
|
||
## Release-Notes | ||
|
||
For release notes, see [CHANGELOG.md](CHANGELOG.md) | ||
|
||
## Contributing guidelines | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md). |
18 changes: 18 additions & 0 deletions
18
test/fixtures/scenarios/with-greenkeeper/expected/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{ | ||
"name": "simple-project", | ||
"version": "1.0.0", | ||
"description": "", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/bootprint/bootprint.git" | ||
}, | ||
"author": "", | ||
"license": "ISC", | ||
"devDependencies": { | ||
"fs-walker": "^1.0.0" | ||
} | ||
} |
18 changes: 18 additions & 0 deletions
18
test/fixtures/scenarios/with-greenkeeper/input/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{ | ||
"name": "simple-project", | ||
"version": "1.0.0", | ||
"description": "", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/bootprint/bootprint.git" | ||
}, | ||
"author": "", | ||
"license": "ISC", | ||
"devDependencies": { | ||
"fs-walker": "^1.0.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters