diff --git a/.all-contributorsrc b/.all-contributorsrc index 46e6d806..893db34a 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,11 +1,15 @@ { "projectName": "kcd-scripts", "projectOwner": "kentcdodds", + "imageSize": 100, + "commit": false, + "contributorsPerLine": 7, + "repoHost": "https://github.com", + "repoType": "github", + "skipCi": false, "files": [ "README.md" ], - "imageSize": 100, - "commit": false, "contributors": [ { "login": "kentcdodds", @@ -181,9 +185,5 @@ "code" ] } - ], - "repoType": "github", - "contributorsPerLine": 7, - "repoHost": "https://github.com", - "skipCi": true + ] } diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ddd7e738..fa9abbee 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -36,6 +36,7 @@ merge of your pull request! - [ ] Documentation - [ ] Tests -- [ ] Ready to be merged +- [ ] Ready to be merged + diff --git a/.gitignore b/.gitignore index 09048d22..8e0c70cb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,7 @@ node_modules coverage dist -.opt-in -.opt-out .DS_Store -.eslintcache # these cause more harm than good # when working with contributors diff --git a/.prettierignore b/.prettierignore index 30117ea2..9c628283 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,3 @@ -package.json node_modules -dist coverage +dist diff --git a/CHANGELOG.md b/CHANGELOG.md index 06d221aa..2a675299 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # CHANGELOG -The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release). -You can see it on the [releases page](../../releases). +The changelog is automatically updated using +[semantic-release](https://github.com/semantic-release/semantic-release). You +can see it on the [releases page](../../releases). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63356964..c7daeb12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,65 +2,36 @@ Thanks for being willing to contribute! -**Working on your first Pull Request?** You can learn how from this _free_ series -[How to Contribute to an Open Source Project on GitHub][egghead] +**Working on your first Pull Request?** You can learn how from this _free_ +series [How to Contribute to an Open Source Project on GitHub][egghead] ## Project setup -1. Fork and clone the repo -2. `$ npm install` to install dependencies -3. `$ npm run validate` to validate you've got it working -4. Create a branch for your PR +1. Fork and clone the repo +2. `$ npm install` to install dependencies +3. `$ npm run validate` to validate you've got it working +4. Create a branch for your PR > Tip: Keep your `master` branch pointing at the original repository and make > pull requests from branches on your fork. To do this, run: > > ``` -> git remote add upstream https://github.com/kentcdodds/kcd-scripts.git +> git remote add upstream https://github.com/kentcdodds/kcd-scripts > git fetch upstream > git branch --set-upstream-to=upstream/master master > ``` > -> This will add the original repository as a "remote" called "upstream," -> Then fetch the git information from that remote, then set your local `master` -> branch to use the upstream master branch whenever you run `git pull`. -> Then you can make all of your pull request branches based on this `master` -> branch. Whenever you want to update your version of `master`, do a regular -> `git pull`. +> This will add the original repository as a "remote" called "upstream," Then +> fetch the git information from that remote, then set your local `master` +> branch to use the upstream master branch whenever you run `git pull`. Then you +> can make all of your pull request branches based on this `master` branch. +> Whenever you want to update your version of `master`, do a regular `git pull`. ## Committing and Pushing changes -This project uses [`semantic-release`][semantic-release] to do automatic -releases and generate a changelog based on the commit history. So we follow -[a convention][convention] for commit messages. You don't have to follow this -convention if you don't want to. Just know that when we merge your commit, we'll -probably use "Squash and Merge" so we can change the commit message :) - Please make sure to run the tests before you commit your changes. You can run -`npm run test:update` which will update any snapshots that need updating. -Make sure to include those changes (if they exist) in your commit. - -### opt in/out of git hooks - -There are git hooks set up with this project that are automatically installed -when you install dependencies. They're really handy, but are turned off by -default (so as to not hinder new contributors). You can opt into these by -creating a file called `.opt-in` at the root of the project and putting this -inside: - -``` -pre-commit -``` - -One of the things that the git hooks does is automatically format the files you -change. It does this by reformating the entire file and running `git add` on -the file after. This breaks workflows where you're trying to commit portions of -the file only. You can always run your commit with `--no-verify`, but if this -is a bummer to your workflow, you can add an `.opt-out` file with the contents: - -``` -autoformat -``` +`npm run test:update` which will update any snapshots that need updating. Make +sure to include those changes (if they exist) in your commit. ## Help needed @@ -69,7 +40,7 @@ Please checkout the [the open issues][issues] Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks! + [egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github -[semantic-release]: https://npmjs.com/package/semantic-release -[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md [issues]: https://github.com/kentcdodds/kcd-scripts/issues + diff --git a/README.md b/README.md index 25dcaee6..8c5ccf69 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,21 @@

CLI toolbox for common scripts for my projects

-
+--- + [![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] [![version][version-badge]][package] -[![downloads][downloads-badge]][npmcharts] +[![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] + [![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors) + [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] - -[![Watch on GitHub][github-watch-badge]][github-watch] -[![Star on GitHub][github-star-badge]][github-star] -[![Tweet][twitter-badge]][twitter] + ## The problem @@ -41,7 +41,10 @@ for linting, testing, building, and more. - [Flow support](#flow-support) - [Inspiration](#inspiration) - [Other Solutions](#other-solutions) -- [Contributors](#contributors) +- [Issues](#issues) + - [🐛 Bugs](#-bugs) + - [💡 Feature Requests](#-feature-requests) +- [Contributors ✨](#contributors-) - [LICENSE](#license) @@ -62,8 +65,8 @@ documenting or testing it super duper well because it's really specific to my needs. You'll find all available scripts in `src/scripts`. This project actually dogfoods itself. If you look in the `package.json`, you'll -find scripts with `node src {scriptName}`. This serves as an example of some -of the things you can do with `kcd-scripts`. +find scripts with `node src {scriptName}`. This serves as an example of some of +the things you can do with `kcd-scripts`. ### Overriding Config @@ -72,8 +75,8 @@ configuration for things and have that plug directly into the way things work with `kcd-scripts`. There are various ways that it works, but basically if you want to have your own config for something, just add the configuration and `kcd-scripts` will use that instead of it's own internal config. In addition, -`kcd-scripts` exposes its configuration so you can use it and override only -the parts of the config you need to. +`kcd-scripts` exposes its configuration so you can use it and override only the +parts of the config you need to. This can be a very helpful way to make editor integration work for tools like ESLint which require project-based ESLint configuration to be present to work. @@ -114,7 +117,10 @@ module.exports = Object.assign(jestConfig, { ### Flow support -If the `flow-bin` is a dependency on the project the `@babel/preset-flow` will automatically get loaded when you use the default babel config that comes with `kcd-scripts`. If you customised your `.babelrc`-file you might need to manually add `@babel/preset-flow` to the `presets`-section. +If the `flow-bin` is a dependency on the project the `@babel/preset-flow` will +automatically get loaded when you use the default babel config that comes with +`kcd-scripts`. If you customised your `.babelrc`-file you might need to manually +add `@babel/preset-flow` to the `presets`-section. ## Inspiration @@ -125,7 +131,25 @@ This is inspired by `react-scripts`. I'm not aware of any, if you are please [make a pull request][prs] and add it here! Again, this is a very specific-to-me solution. -## Contributors +## Issues + +_Looking to contribute? Look for the [Good First Issue][good-first-issue] +label._ + +### 🐛 Bugs + +Please file an issue for bugs, missing documentation, or unexpected behavior. + +[**See Bugs**][bugs] + +### 💡 Feature Requests + +Please file an issue to suggest new features. Vote on feature requests by adding +a 👍. This helps maintainers prioritize what to work on. + +[**See Feature Requests**][requests] + +## Contributors ✨ Thanks goes to these people ([emoji key][emojis]): @@ -161,6 +185,7 @@ Thanks goes to these people ([emoji key][emojis]): + This project follows the [all-contributors][all-contributors] specification. @@ -170,28 +195,24 @@ Contributions of any kind welcome! MIT -[npm]: https://www.npmjs.com/ + +[npm]: https://www.npmjs.com [node]: https://nodejs.org [build-badge]: https://img.shields.io/travis/kentcdodds/kcd-scripts.svg?style=flat-square [build]: https://travis-ci.org/kentcdodds/kcd-scripts -[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/kcd-scripts.svg?style=flat-square -[coverage]: https://codecov.io/github/kentcdodds/kcd-scripts [version-badge]: https://img.shields.io/npm/v/kcd-scripts.svg?style=flat-square [package]: https://www.npmjs.com/package/kcd-scripts [downloads-badge]: https://img.shields.io/npm/dm/kcd-scripts.svg?style=flat-square -[npmcharts]: http://npmcharts.com/compare/kcd-scripts +[npmtrends]: http://www.npmtrends.com/kcd-scripts [license-badge]: https://img.shields.io/npm/l/kcd-scripts.svg?style=flat-square [license]: https://github.com/kentcdodds/kcd-scripts/blob/master/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square [prs]: http://makeapullrequest.com -[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square [coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square [coc]: https://github.com/kentcdodds/kcd-scripts/blob/master/other/CODE_OF_CONDUCT.md -[github-watch-badge]: https://img.shields.io/github/watchers/kentcdodds/kcd-scripts.svg?style=social -[github-watch]: https://github.com/kentcdodds/kcd-scripts/watchers -[github-star-badge]: https://img.shields.io/github/stars/kentcdodds/kcd-scripts.svg?style=social -[github-star]: https://github.com/kentcdodds/kcd-scripts/stargazers -[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20kcd-scripts!%20https://github.com/kentcdodds/kcd-scripts%20%F0%9F%91%8D -[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kentcdodds/kcd-scripts.svg?style=social -[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key -[all-contributors]: https://github.com/kentcdodds/all-contributors +[emojis]: https://github.com/all-contributors/all-contributors#emoji-key +[all-contributors]: https://github.com/all-contributors/all-contributors +[bugs]: https://github.com/kentcdodds/kcd-scripts/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug +[requests]: https://github.com/kentcdodds/kcd-scripts/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement +[good-first-issue]: https://github.com/kentcdodds/kcd-scripts/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22 + diff --git a/other/CODE_OF_CONDUCT.md b/other/CODE_OF_CONDUCT.md index 89dcd555..80a98f60 100644 --- a/other/CODE_OF_CONDUCT.md +++ b/other/CODE_OF_CONDUCT.md @@ -20,9 +20,9 @@ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. +size, disability, ethnicity, gender identity and expression, level of +experience, nationality, personal appearance, race, religion, or sexual identity +and orientation. ## Our Standards @@ -52,11 +52,11 @@ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, +offensive, or harmful. ## Scope @@ -73,8 +73,9 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kent+coc@doddsfamily.us. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +obligated to maintain confidentiality with regard to the reporter of an +incident. Further details of specific enforcement policies may be posted +separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other @@ -82,8 +83,8 @@ members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ diff --git a/other/MAINTAINING.md b/other/MAINTAINING.md index cf87aabe..28f3a502 100644 --- a/other/MAINTAINING.md +++ b/other/MAINTAINING.md @@ -18,60 +18,67 @@ This is documentation for maintainers of this project. ## Code of Conduct -Please review, understand, and be an example of it. Violations of the code of conduct are -taken seriously, even (especially) for maintainers. +Please review, understand, and be an example of it. Violations of the code of +conduct are taken seriously, even (especially) for maintainers. ## Issues -We want to support and build the community. We do that best by helping people learn to solve -their own problems. We have an issue template and hopefully most folks follow it. If it's -not clear what the issue is, invite them to create a minimal reproduction of what they're trying -to accomplish or the bug they think they've found. +We want to support and build the community. We do that best by helping people +learn to solve their own problems. We have an issue template and hopefully most +folks follow it. If it's not clear what the issue is, invite them to create a +minimal reproduction of what they're trying to accomplish or the bug they think +they've found. Once it's determined that a code change is necessary, point people to -[makeapullrequest.com](http://makeapullrequest.com) and invite them to make a pull request. -If they're the one who needs the feature, they're the one who can build it. If they need -some hand holding and you have time to lend a hand, please do so. It's an investment into -another human being, and an investment into a potential maintainer. +[makeapullrequest.com](http://makeapullrequest.com) and invite them to make a +pull request. If they're the one who needs the feature, they're the one who can +build it. If they need some hand holding and you have time to lend a hand, +please do so. It's an investment into another human being, and an investment +into a potential maintainer. -Remember that this is open source, so the code is not yours, it's ours. If someone needs a change -in the codebase, you don't have to make it happen yourself. Commit as much time to the project -as you want/need to. Nobody can ask any more of you than that. +Remember that this is open source, so the code is not yours, it's ours. If +someone needs a change in the codebase, you don't have to make it happen +yourself. Commit as much time to the project as you want/need to. Nobody can ask +any more of you than that. ## Pull Requests -As a maintainer, you're fine to make your branches on the main repo or on your own fork. Either -way is fine. +As a maintainer, you're fine to make your branches on the main repo or on your +own fork. Either way is fine. -When we receive a pull request, a travis build is kicked off automatically (see the `.travis.yml` -for what runs in the travis build). We avoid merging anything that breaks the travis build. +When we receive a pull request, a travis build is kicked off automatically (see +the `.travis.yml` for what runs in the travis build). We avoid merging anything +that breaks the travis build. -Please review PRs and focus on the code rather than the individual. You never know when this is -someone's first ever PR and we want their experience to be as positive as possible, so be -uplifting and constructive. +Please review PRs and focus on the code rather than the individual. You never +know when this is someone's first ever PR and we want their experience to be as +positive as possible, so be uplifting and constructive. When you merge the pull request, 99% of the time you should use the -[Squash and merge](https://help.github.com/articles/merging-a-pull-request/) feature. This keeps -our git history clean, but more importantly, this allows us to make any necessary changes to the -commit message so we release what we want to release. See the next section on Releases for more -about that. +[Squash and merge](https://help.github.com/articles/merging-a-pull-request/) +feature. This keeps our git history clean, but more importantly, this allows us +to make any necessary changes to the commit message so we release what we want +to release. See the next section on Releases for more about that. ## Release -Our releases are automatic. They happen whenever code lands into `master`. A travis build gets -kicked off and if it's successful, a tool called -[`semantic-release`](https://github.com/semantic-release/semantic-release) is used to -automatically publish a new release to npm as well as a changelog to GitHub. It is only able to -determine the version and whether a release is necessary by the git commit messages. With this -in mind, **please brush up on [the commit message convention][commit] which drives our releases.** +Our releases are automatic. They happen whenever code lands into `master`. A +travis build gets kicked off and if it's successful, a tool called +[`semantic-release`](https://github.com/semantic-release/semantic-release) is +used to automatically publish a new release to npm as well as a changelog to +GitHub. It is only able to determine the version and whether a release is +necessary by the git commit messages. With this in mind, **please brush up on +[the commit message convention][commit] which drives our releases.** -> One important note about this: Please make sure that commit messages do NOT contain the words -> "BREAKING CHANGE" in them unless we want to push a major version. I've been burned by this -> more than once where someone will include "BREAKING CHANGE: None" and it will end up releasing -> a new major version. Not a huge deal honestly, but kind of annoying... +> One important note about this: Please make sure that commit messages do NOT +> contain the words "BREAKING CHANGE" in them unless we want to push a major +> version. I've been burned by this more than once where someone will include +> "BREAKING CHANGE: None" and it will end up releasing a new major version. Not +> a huge deal honestly, but kind of annoying... ## Thanks! Thank you so much for helping to maintain this project! -[commit]: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md +[commit]: + https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md diff --git a/other/manual-releases.md b/other/manual-releases.md index dadf7d38..14a145f2 100644 --- a/other/manual-releases.md +++ b/other/manual-releases.md @@ -6,10 +6,11 @@ -This project has an automated release set up. So things are only released when there are -useful changes in the code that justify a release. But sometimes things get messed up one way or another -and we need to trigger the release ourselves. When this happens, simply bump the number below and commit -that with the following commit message based on your needs: +This project has an automated release set up. So things are only released when +there are useful changes in the code that justify a release. But sometimes +things get messed up one way or another and we need to trigger the release +ourselves. When this happens, simply bump the number below and commit that with +the following commit message based on your needs: **Major** diff --git a/package.json b/package.json index d61d233c..d0f54a98 100644 --- a/package.json +++ b/package.json @@ -32,19 +32,19 @@ "license": "MIT", "dependencies": { "@babel/cli": "^7.8.4", - "@babel/core": "^7.8.4", + "@babel/core": "^7.9.0", "@babel/plugin-proposal-class-properties": "^7.8.3", - "@babel/plugin-transform-modules-commonjs": "^7.8.3", - "@babel/plugin-transform-runtime": "^7.8.3", - "@babel/preset-env": "^7.8.4", - "@babel/preset-flow": "^7.8.3", - "@babel/preset-react": "^7.8.3", - "@babel/runtime": "^7.8.4", + "@babel/plugin-transform-modules-commonjs": "^7.9.0", + "@babel/plugin-transform-runtime": "^7.9.0", + "@babel/preset-env": "^7.9.0", + "@babel/preset-flow": "^7.9.0", + "@babel/preset-react": "^7.9.1", + "@babel/runtime": "^7.9.2", "@rollup/plugin-commonjs": "^11.0.2", "@rollup/plugin-json": "^4.0.2", "@rollup/plugin-node-resolve": "^7.1.1", "@rollup/plugin-replace": "^2.3.1", - "@types/jest": "^25.1.3", + "@types/jest": "^25.1.4", "arrify": "^2.0.1", "babel-jest": "^25.1.0", "babel-plugin-macros": "^2.8.0", @@ -52,11 +52,11 @@ "babel-plugin-module-resolver": "^4.0.0", "babel-plugin-transform-inline-environment-variables": "^0.4.3", "babel-plugin-transform-react-remove-prop-types": "^0.4.24", - "browserslist": "^4.8.7", + "browserslist": "^4.10.0", "chalk": "^3.0.0", "concurrently": "^5.1.0", "cosmiconfig": "^6.0.0", - "cross-env": "^7.0.0", + "cross-env": "^7.0.2", "cross-spawn": "^7.0.1", "doctoc": "^1.4.0", "eslint": "^6.8.0", @@ -72,19 +72,19 @@ "lodash.has": "^4.5.2", "lodash.omit": "^4.5.0", "mkdirp": "^1.0.3", - "prettier": "1.19.1", + "prettier": "2.0.1", "read-pkg-up": "^7.0.1", "resolve": "^1.15.1", "rimraf": "^3.0.2", - "rollup": "^1.31.1", - "rollup-plugin-babel": "^4.3.3", + "rollup": "^1.32.1", + "rollup-plugin-babel": "^4.4.0", "rollup-plugin-node-builtins": "^2.1.2", "rollup-plugin-node-globals": "^1.4.0", "rollup-plugin-size-snapshot": "^0.11.0", - "rollup-plugin-terser": "^5.2.0", + "rollup-plugin-terser": "^5.3.0", "semver": "^7.1.3", "which": "^2.0.2", - "yargs-parser": "^17.0.0" + "yargs-parser": "^18.1.1" }, "eslintConfig": { "extends": [ diff --git a/src/index.js b/src/index.js index 5cf0a561..6754c2b2 100755 --- a/src/index.js +++ b/src/index.js @@ -2,10 +2,7 @@ let shouldThrow = false try { - const [major, minor] = process.version - .slice(1) - .split('.') - .map(Number) + const [major, minor] = process.version.slice(1).split('.').map(Number) shouldThrow = require(`${process.cwd()}/package.json`).name === 'kcd-scripts' && (major < 10 || (major === 10 && minor < 18))