Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Mar 5, 2016
1 parent 8d6e4bb commit dfefabd
Show file tree
Hide file tree
Showing 19 changed files with 644 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

[Read the Contributing Guide](http://js-data.io/docs/contributing).

## Support

[Find out how to Get Support](http://js-data.io/docs/support).

## Community

[Explore the Community](http://js-data.io/docs/community).

### Have write access?

To cut a release:

1. Checkout master
1. Bump version in `package.json` appropriately
1. Run `npm run release`
1. Update `CHANGELOG.md` appropriately
1. Commit and push changes, including the `dist/` folder
1. Make a GitHub release
- set tag name to version
- set release name to version
- set release body to changelog entry for the version
1. `npm publish .`
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
(delete this line) GitHub Issues are NOT for support questions.
(delete this line) GitHub Issues ARE for bug reports, feature requests, and other issues.
(delete this line) Find out how to Get Support here: http://js-data.io/docs/support.

<your detailed, discussable, actionable, and helpful text goes here>

Thanks!
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)

- [ ] - `npm test` succeeds
- [ ] - Pull request has been squashed into 1 commit
- [ ] - I did NOT commit changes to `dist/`
- [ ] - Code coverage does not decrease (if any source code was changed)
- [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
- [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
coverage
doc
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
coverage
doc
8 changes: 8 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This is the official list of js-data-repo-tools project authors.
#
# This file is controlled by scripts/authors.js
#
# Names are formatted as:
# # commits Name or Organization <email address>
# The email address is not required for organizations.
Jason Dobry <[email protected]>
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
##### 0.1.0 - 06 March 2016

Initial release

Supported scripts: authors, changelog, lint, updates
5 changes: 5 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# People who have contributed to the js-data-repo-tools project.
#
# Names should be added to this file as:
# [commit count] Name <email address>
1 Jason Dobry <[email protected]>
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 js-data-repo-tools project authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="96" height="96" />

# js-data-repo-tools

[![Slack Status][sl_b]][sl_l]
[![npm version][npm_b]][npm_l]
[![npm downloads][dn_b]][dn_l]

Common utility scripts used by js-data repositories.

Refer to the `package.json` files of the various js-data adapter repositories to
see this tool in action.

## Table of contents

* [Quick start](#quick-start)
* [Community](#community)
* [Support](#support)
* [Contributing](#contributing)
* [License](#license)

## Quick Start
Install into a repository: `npm i --save-dev js-data-repo-tools`

And update your scripts in `package.json`:

```js
"scripts": {
"lint": "repo-tools lint src/index.js test/**/*.js"
}
```

Or install globally: `npm i -g js-data-repo-tools`

And use on the commandline:

```
repo-tools lint
```

## Community

[Explore the Community](http://js-data.io/docs/community).

## Support

[Find out how to Get Support](http://js-data.io/docs/support).

## Contributing

[Read the Contributing Guide](http://js-data.io/docs/contributing).

## License

The MIT License (MIT)

Copyright (c) 2016 js-data-repo-tools project authors

* [LICENSE](https://github.com/js-data/js-data-repo-tools/blob/master/LICENSE)
* [AUTHORS](https://github.com/js-data/js-data-repo-tools/blob/master/AUTHORS)
* [CONTRIBUTORS](https://github.com/js-data/js-data-repo-tools/blob/master/CONTRIBUTORS)

[sl_b]: http://slack.js-data.io/badge.svg
[sl_l]: http://slack.js-data.io
[npm_b]: https://img.shields.io/npm/v/js-data-repo-tools.svg?style=flat
[npm_l]: https://www.npmjs.org/package/js-data-repo-tools
[dn_b]: https://img.shields.io/npm/dm/js-data-repo-tools.svg?style=flat
[dn_l]: https://www.npmjs.org/package/js-data-repo-tools
9 changes: 9 additions & 0 deletions bin/repo-tools
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/usr/bin/env node

var repoTools = require('../src/cli')

repoTools.parse(process.argv)

if (!repoTools.args.length) {
repoTools.help()
}
38 changes: 38 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"name": "js-data-repo-tools",
"description": "Common utility scripts used by js-data repositories.",
"version": "0.1.0",
"homepage": "https://github.com/js-data/js-data-repo-tools",
"repository": {
"type": "git",
"url": "https://github.com/js-data/js-data-repo-tools.git"
},
"author": "js-data-repo-tools project authors",
"license": "MIT",
"main": "./src/api/index.js",
"bin": {
"repo-tools": "./bin/repo-tools"
},
"keywords": [
"js-data",
"jsdata",
"repo",
"tools"
],
"standard": {
"parser": "babel-eslint"
},
"scripts": {
"lint": "node . lint",
"test": "npm run lint && node . changelog && node . updates && node . authors",
"release": "npm test"
},
"dependencies": {
"babel-eslint": "5.0.0",
"bluebird": "3.3.3",
"commander": "2.9.0",
"lodash": "4.6.1",
"npm-check-updates": "2.5.8",
"standard": "6.0.7"
}
}
Loading

0 comments on commit dfefabd

Please sign in to comment.