Skip to content

Commit f0495f6

Browse files
author
Kent C. Dodds
committed
WIP: init
0 parents  commit f0495f6

35 files changed

+1060
-0
lines changed

Diff for: ‎.all-contributorsrc

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"projectName": "kcd-scripts",
3+
"projectOwner": "kentcdodds",
4+
"files": [
5+
"README.md"
6+
],
7+
"imageSize": 100,
8+
"commit": false,
9+
"contributors": [
10+
{
11+
"login": "kentcdodds",
12+
"name": "Kent C. Dodds",
13+
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3",
14+
"profile": "https://kentcdodds.com",
15+
"contributions": [
16+
"code",
17+
"doc",
18+
"infra",
19+
"test"
20+
]
21+
}
22+
]
23+
}

Diff for: ‎.babelrc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"presets": [
3+
["env", {
4+
"targets": {
5+
"node": "4.5"
6+
}
7+
}]
8+
],
9+
"plugins": [
10+
"transform-class-properties",
11+
"transform-object-rest-spread"
12+
]
13+
}

Diff for: ‎.eslintignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
coverage
3+
dist

Diff for: ‎.eslintrc

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"extends": [
3+
"kentcdodds",
4+
"kentcdodds/jest",
5+
"kentcdodds/prettier"
6+
],
7+
"rules": {
8+
// stuff I haven't gotten around to updating in my config
9+
"no-unused-vars": ["error", { "argsIgnorePattern": "^_", "varsIgnorePattern": "^ignored" }],
10+
"func-style": "off",
11+
"no-process-exit": "off",
12+
"import/no-dynamic-require": "off",
13+
14+
// prettier does this for us
15+
"max-len": "off",
16+
"semi": "off",
17+
"quotes": "off",
18+
"comma-dangle": "off",
19+
"no-console": "off",
20+
"indent": "off",
21+
"babel/object-curly-spacing": "off"
22+
}
23+
}

Diff for: ‎.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* text=auto
2+
*.js text eol=lf

Diff for: ‎.github/ISSUE_TEMPLATE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
3+
Please make sure that you are familiar with and follow the Code of Conduct for
4+
this project (found in the CODE_OF_CONDUCT.md file).
5+
6+
Please fill out this template with all the relevant information so we can
7+
understand what's going on and fix the issue.
8+
9+
I'll probably ask you to submit the fix (after giving some direction). If you've
10+
never done that before, that's great! Check this free short video tutorial to
11+
learn how: http://kcd.im/pull-request
12+
-->
13+
14+
- `kcd-scripts` version:
15+
- `node` version:
16+
- `npm` (or `yarn`) version:
17+
18+
Relevant code or config
19+
20+
```javascript
21+
22+
```
23+
24+
What you did:
25+
26+
27+
28+
What happened:
29+
30+
<!-- Please provide the full error message/screenshots/anything -->
31+
32+
Reproduction repository:
33+
34+
<!--
35+
If possible, please create a repository that reproduces the issue with the
36+
minimal amount of code possible.
37+
-->
38+
39+
Problem description:
40+
41+
42+
43+
Suggested solution:

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
3+
4+
Please make sure that you are familiar with and follow the Code of Conduct for
5+
this project (found in the CODE_OF_CONDUCT.md file).
6+
7+
Also, please make sure you're familiar with and follow the instructions in the
8+
contributing guidelines (found in the CONTRIBUTING.md file).
9+
10+
If you're new to contributing to open source projects, you might find this free
11+
video course helpful: http://kcd.im/pull-request
12+
13+
Please fill out the information below to expedite the review and (hopefully)
14+
merge of your pull request!
15+
-->
16+
17+
<!-- What changes are being made? (What feature/bug is being fixed here?) -->
18+
**What**:
19+
20+
<!-- Why are these changes necessary? -->
21+
**Why**:
22+
23+
<!-- How were these changes implemented? -->
24+
**How**:
25+
26+
<!-- Have you done all of these things? -->
27+
**Checklist**:
28+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
29+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
30+
- [ ] Documentation
31+
- [ ] Tests
32+
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
33+
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
34+
35+
<!-- feel free to add additional comments -->

Diff for: ‎.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
node_modules
2+
coverage
3+
dist
4+
.opt-in
5+
.opt-out
6+
.DS_Store
7+
.eslintcache
8+
9+
# these cause more harm than good
10+
# when working with contributors
11+
package-lock.json
12+
yarn.lock

Diff for: ‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry=http://registry.npmjs.org/

Diff for: ‎.travis.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
sudo: false
2+
language: node_js
3+
cache:
4+
directories:
5+
- node_modules
6+
notifications:
7+
email: false
8+
node_js:
9+
- '8'
10+
script:
11+
- npm start validate
12+
after_success:
13+
- npx codecov
14+
- npm i -g semantic-release@7 && semantic-release pre && npm publish && semantic-release post
15+
branches:
16+
only:
17+
- master

Diff for: ‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CHANGELOG
2+
3+
The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release).
4+
You can see it on the [releases page](../../releases).

Diff for: ‎CONTRIBUTING.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute!
4+
5+
**Working on your first Pull Request?** You can learn how from this *free* series
6+
[How to Contribute to an Open Source Project on GitHub][egghead]
7+
8+
## Project setup
9+
10+
1. Fork and clone the repo
11+
2. `$ npm install` to install dependencies
12+
3. `$ npm start validate` to validate you've got it working
13+
4. Create a branch for your PR
14+
15+
This project uses [`nps`][nps] and you can run `npm start help` to see what
16+
scripts are available.
17+
18+
> Tip: Keep your `master` branch pointing at the original repository and make
19+
> pull requests from branches on your fork. To do this, run:
20+
>
21+
> ```
22+
> git remote add upstream https://github.com/kentcdodds/kcd-scripts.git
23+
> git fetch upstream
24+
> git branch --set-upstream-to=upstream/master master
25+
> ```
26+
>
27+
> This will add the original repository as a "remote" called "upstream,"
28+
> Then fetch the git information from that remote, then set your local `master`
29+
> branch to use the upstream master branch whenever you run `git pull`.
30+
> Then you can make all of your pull request branches based on this `master`
31+
> branch. Whenever you want to update your version of `master`, do a regular
32+
> `git pull`.
33+
34+
## Add yourself as a contributor
35+
36+
This project follows the [all contributors][all-contributors] specification.
37+
To add yourself to the table of contributors on the README.md, please use the
38+
automated script as part of your PR:
39+
40+
```console
41+
npm start contributors.add
42+
```
43+
44+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
45+
If you've already added yourself to the list and are making
46+
a new type of contribution, you can run it again and select the added
47+
contribution type.
48+
49+
## Committing and Pushing changes
50+
51+
This project uses [`semantic-release`][semantic-release] to do automatic
52+
releases and generate a changelog based on the commit history. So we follow
53+
[a convention][convention] for commit messages. You don't have to follow this
54+
convention if you don't like to. Just know that when we merge your commit, we'll
55+
probably use "Squash and Merge" so we can change the commit message :)
56+
57+
Please make sure to run the tests before you commit your changes. You can run
58+
`npm start test.update` which will update any snapshots that need updating.
59+
Make sure to include those changes (if they exist) in your commit.
60+
61+
### opt into git hooks
62+
63+
There are git hooks set up with this project that are automatically installed
64+
when you install dependencies. They're really handy, but are turned off by
65+
default (so as to not hinder new contributors). You can opt into these by
66+
creating a file called `.opt-in` at the root of the project and putting this
67+
inside:
68+
69+
```
70+
pre-commit
71+
```
72+
73+
## Help needed
74+
75+
Please checkout the [the open issues][issues]
76+
77+
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!
78+
79+
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
80+
[semantic-release]: https://npmjs.com/package/semantic-release
81+
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
82+
[all-contributors]: https://github.com/kentcdodds/all-contributors
83+
[issues]: https://github.com/kentcdodds/kcd-scripts/issues
84+
[nps]: https://github.com/kentcdodds/nps

Diff for: ‎LICENSE

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

Diff for: ‎README.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<div align="center">
2+
<h1>kcd-scripts</h1>
3+
4+
<strong>CLI for common scripts for my projects</strong>
5+
</div>
6+
7+
<hr />
8+
9+
[![Build Status][build-badge]][build]
10+
[![Code Coverage][coverage-badge]][coverage]
11+
[![version][version-badge]][package]
12+
[![downloads][downloads-badge]][npmcharts]
13+
[![MIT License][license-badge]][LICENSE]
14+
15+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
16+
[![PRs Welcome][prs-badge]][prs]
17+
[![Code of Conduct][coc-badge]][coc]
18+
19+
[![Watch on GitHub][github-watch-badge]][github-watch]
20+
[![Star on GitHub][github-star-badge]][github-star]
21+
[![Tweet][twitter-badge]][twitter]
22+
23+
## The problem
24+
25+
// TODO
26+
27+
## This solution
28+
29+
// TODO
30+
31+
## Installation
32+
33+
This module is distributed via [npm][npm] which is bundled with [node][node] and
34+
should be installed as one of your project's `devDependencies`:
35+
36+
```
37+
npm install --save-dev kcd-scripts
38+
```
39+
40+
## Usage
41+
42+
// TODO
43+
44+
## Inspiration
45+
46+
// TODO
47+
48+
## Other Solutions
49+
50+
I'm not aware of any, if you are please [make a pull request][prs] and add it
51+
here!
52+
53+
## Contributors
54+
55+
Thanks goes to these people ([emoji key][emojis]):
56+
57+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
58+
| [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub>Kent C. Dodds</sub>](https://kentcdodds.com)<br />[💻](https://github.com/kentcdodds/kcd-scripts/commits?author=kentcdodds) [📖](https://github.com/kentcdodds/kcd-scripts/commits?author=kentcdodds) 🚇 [⚠️](https://github.com/kentcdodds/kcd-scripts/commits?author=kentcdodds) |
59+
| :---: |
60+
<!-- ALL-CONTRIBUTORS-LIST:END -->
61+
62+
This project follows the [all-contributors][all-contributors] specification.
63+
Contributions of any kind welcome!
64+
65+
## LICENSE
66+
67+
MIT
68+
69+
[npm]: https://www.npmjs.com/
70+
[node]: https://nodejs.org
71+
[build-badge]: https://img.shields.io/travis/kentcdodds/kcd-scripts.svg?style=flat-square
72+
[build]: https://travis-ci.org/kentcdodds/kcd-scripts
73+
[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/kcd-scripts.svg?style=flat-square
74+
[coverage]: https://codecov.io/github/kentcdodds/kcd-scripts
75+
[version-badge]: https://img.shields.io/npm/v/kcd-scripts.svg?style=flat-square
76+
[package]: https://www.npmjs.com/package/kcd-scripts
77+
[downloads-badge]: https://img.shields.io/npm/dm/kcd-scripts.svg?style=flat-square
78+
[npmcharts]: http://npmcharts.com/compare/kcd-scripts
79+
[license-badge]: https://img.shields.io/npm/l/kcd-scripts.svg?style=flat-square
80+
[license]: https://github.com/kentcdodds/kcd-scripts/blob/master/LICENSE
81+
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
82+
[prs]: http://makeapullrequest.com
83+
[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square
84+
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
85+
[coc]: https://github.com/kentcdodds/kcd-scripts/blob/master/other/CODE_OF_CONDUCT.md
86+
[github-watch-badge]: https://img.shields.io/github/watchers/kentcdodds/kcd-scripts.svg?style=social
87+
[github-watch]: https://github.com/kentcdodds/kcd-scripts/watchers
88+
[github-star-badge]: https://img.shields.io/github/stars/kentcdodds/kcd-scripts.svg?style=social
89+
[github-star]: https://github.com/kentcdodds/kcd-scripts/stargazers
90+
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20kcd-scripts!%20https://github.com/kentcdodds/kcd-scripts%20%F0%9F%91%8D
91+
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kentcdodds/kcd-scripts.svg?style=social
92+
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
93+
[all-contributors]: https://github.com/kentcdodds/all-contributors

Diff for: ‎jest.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./src/config/jest.config')

Diff for: ‎kcd.config.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
const path = require('path')
2+
3+
module.exports = {
4+
eslint: {
5+
extends: [path.join(__dirname, './.eslintrc')],
6+
},
7+
jest: {
8+
coverageThreshold: {},
9+
},
10+
}

0 commit comments

Comments
 (0)