Merge branch 'master' into result-history

Author: mpeyper

.all-contributorsrc

@@ -203,6 +203,15 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "Goldziher",
+      "name": "Na'aman Hirschfeld",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/30733348?v=4",
+      "profile": "https://github.com/Goldziher",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "commitConvention": "none"

.babelrc

@@ -0,0 +1,5 @@
+node_modules
+coverage
+lib
+.docz
+site

.eslintignore

@@ -0,0 +1,10 @@
+{
+  "extends": "./node_modules/kcd-scripts/eslint.js",
+  "rules": {
+    "max-lines-per-function": "off",
+    "no-constant-condition": "off",
+    "no-await-in-loop": "off",
+    "react-hooks/rules-of-hooks": "off",
+    "no-console": "off"
+  }
+}

.eslintrc

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitattributes

@@ -4,7 +4,6 @@ about: "I have a suggestion (and might want to implement myself \U0001F642)!"
 title: ''
 labels: enhancement
 assignees: ''
-
 ---
 
 <!--

.github/ISSUE_TEMPLATE/---feature-request.md

@@ -0,0 +1,8 @@
+# config options: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/enabling-and-disabling-version-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/dependabot.yml

@@ -0,0 +1,96 @@
+name: validate
+on:
+  push:
+    branches:
+      - '+([0-9])?(.{+([0-9]),x}).x'
+      - 'master'
+      - 'main'
+      - 'next'
+      - 'next-major'
+      - 'beta'
+      - 'alpha'
+      - '!all-contributors/**'
+  pull_request: {}
+jobs:
+  main:
+    # ignore all-contributors PRs
+    if: ${{ !contains(github.head_ref, 'all-contributors') }}
+    strategy:
+      matrix:
+        node: [10.13, 12, 14, 15]
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v2
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: 📥 Download deps
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false
+        env:
+          HUSKY_SKIP_INSTALL: true
+
+      - name: ▶️ Run validate script
+        run: npm run validate
+
+      - name: ⬆️ Upload coverage report
+        uses: codecov/codecov-action@v1
+
+  release:
+    needs: main
+    runs-on: ubuntu-latest
+    if:
+      ${{ github.repository == 'testing-library/react-hooks-testing-library' &&
+      contains('refs/heads/master,refs/heads/main,refs/heads/beta,refs/heads/next,refs/heads/alpha',
+      github.ref) && github.event_name == 'push' }}
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v2
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+
+      - name: 📥 Download deps
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false
+        env:
+          HUSKY_SKIP_INSTALL: true
+
+      - name: 🏗 Run build script
+        run: npm run build
+
+      - name: 🚀 Release
+        uses: cycjimmy/semantic-release-action@v2
+        with:
+          semantic_version: 17
+          branches: |
+            [
+              '+([0-9])?(.{+([0-9]),x}).x',
+              'master',
+              'main',
+              'next',
+              'next-major',
+              {name: 'beta', prerelease: true},
+              {name: 'alpha', prerelease: true}
+            ]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/validate.yml

@@ -0,0 +1 @@
+module.exports = require('kcd-scripts/husky')

.huskyrc.js

@@ -1 +1,2 @@
 package-lock=false
+legacy-peer-deps=true

.npmrc

@@ -0,0 +1,5 @@
+node_modules
+coverage
+lib
+.docz
+site

.prettierignore

@@ -0,0 +1,8 @@
+module.exports = {
+  printWidth: 100,
+  semi: false,
+  singleQuote: true,
+  arrowParens: 'always',
+  proseWrap: 'always',
+  trailingComma: 'none'
+}

.prettierrc.js

@@ -0,0 +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).

.travis.yml

@@ -49,10 +49,10 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
-the project team at [email protected]. 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.
+the project team at [email protected]. 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.
 
 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 members of the project's leadership.

CHANGELOG.md

@@ -29,7 +29,8 @@ Please make sure to run the tests before you commit your changes. You can do so
 
 ### Update Typings
 
-The TypeScript type definitions can be found in the [DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks).
+The TypeScript type definitions can be found in the
+[DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks).
 
 ## Help needed
 

CODE_OF_CONDUCT.md

@@ -1,3 +1,26 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [react-hooks-testing-library](#react-hooks-testing-library)
+  - [The problem](#the-problem)
+  - [The solution](#the-solution)
+  - [When to use this library](#when-to-use-this-library)
+  - [When not to use this library](#when-not-to-use-this-library)
+  - [Example](#example)
+    - [`useCounter.js`](#usecounterjs)
+    - [`useCounter.test.js`](#usecountertestjs)
+  - [Installation](#installation)
+    - [Peer Dependencies](#peer-dependencies)
+  - [API](#api)
+  - [Contributors](#contributors)
+  - [Issues](#issues)
+    - [🐛 Bugs](#-bugs)
+    - [💡 Feature Requests](#-feature-requests)
+    - [❓ Questions](#-questions)
+  - [LICENSE](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 <div align="center">
   <h1>react-hooks-testing-library</h1>
 
@@ -6,7 +29,7 @@
     height="80"
     width="80"
     alt="ram"
-    src="https://raw.githubusercontent.com/testing-library/react-hooks-testing-library/master/other/ram.png"
+    src="https://raw.githubusercontent.com/testing-library/react-hooks-testing-library/master/public/ram.png"
   />
 </a>
 
@@ -20,8 +43,7 @@
 <hr />
 
 <!-- prettier-ignore-start -->
-
-[![Build Status](https://img.shields.io/travis/testing-library/react-hooks-testing-library.svg?style=flat-square)](https://travis-ci.org/testing-library/react-hooks-testing-library)
+[![Build Status](https://img.shields.io/github/workflow/status/testing-library/react-hooks-testing-library/validate?logo=github&style=flat-square)](https://github.com/testing-library/react-hooks-testing-library/actions?query=workflow%3Avalidate)
 [![codecov](https://img.shields.io/codecov/c/github/testing-library/react-hooks-testing-library.svg?style=flat-square)](https://codecov.io/gh/testing-library/react-hooks-testing-library)
 [![version](https://img.shields.io/npm/v/@testing-library/react-hooks.svg?style=flat-square)](https://www.npmjs.com/package/@testing-library/react-hooks)
 [![downloads](https://img.shields.io/npm/dm/@testing-library/react-hooks.svg?style=flat-square)](http://www.npmtrends.com/@testing-library/react-hooks)
@@ -166,6 +188,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://keiya01.github.io/portfolio"><img src="https://avatars1.githubusercontent.com/u/34934510?v=4?s=100" width="100px;" alt=""/><br /><sub><b>keiya sasaki</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=keiya01" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://huchen.dev/"><img src="https://avatars3.githubusercontent.com/u/2078389?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hu Chen</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=huchenme" title="Code">💻</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=huchenme" title="Documentation">📖</a> <a href="#example-huchenme" title="Examples">💡</a></td>
     <td align="center"><a href="https://github.com/joshuaellis"><img src="https://avatars0.githubusercontent.com/u/37798644?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Josh</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=joshuaellis" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Goldziher"><img src="https://avatars1.githubusercontent.com/u/30733348?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Na'aman Hirschfeld</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=Goldziher" title="Code">💻</a></td>
   </tr>
 </table>
 

CONTRIBUTING.md

@@ -236,9 +236,9 @@ function waitForValueToChange(selector: function(): any, options?: {
 }): Promise<void>
 ```
 
-Returns a `Promise` that resolves if the value returned from the provided selector changes. It is 
-expected that the [`result` of `renderHook`](/reference/api#result) will be used to select the 
-value for comparison.
+Returns a `Promise` that resolves if the value returned from the provided selector changes. It is
+expected that the [`result` of `renderHook`](/reference/api#result) will be used to select the value
+for comparison.
 
 #### `interval`
 

README.md

@@ -11,7 +11,7 @@ route: '/'
       height="80"
       width="80"
       alt="ram"
-      src="https://raw.githubusercontent.com/mpeyper/react-hooks-testing-library/master/other/ram.png"
+      src="https://raw.githubusercontent.com/mpeyper/react-hooks-testing-library/master/public/ram.png"
     />
   </a>
 

docs/api-reference.md

@@ -3,7 +3,7 @@ export default {
   files: '**/*.{md,mdx}',
   src: 'docs',
   dest: 'site',
-  public: './other',
+  public: './public',
   ignore: ['CODE_OF_CONDUCT.md', 'CONTRIBUTING.md', 'LICENSE.md'],
   htmlContext: {
     favicon: '/public/ram.png'

docs/introduction.md

@@ -0,0 +1,6 @@
+const { jest: jestConfig } = require('kcd-scripts/config')
+
+module.exports = Object.assign(jestConfig, {
+  roots: ['<rootDir>/src', '<rootDir>/test'],
+  testMatch: ['<rootDir>/test/*.js']
+})

doczrc.js

@@ -0,0 +1,78 @@
+# Maintaining
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+**Table of Contents**
+
+- [Code of Conduct](#code-of-conduct)
+- [Issues](#issues)
+- [Pull Requests](#pull-requests)
+- [Release](#release)
+- [Thanks!](#thanks)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+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.
+
+## 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.
+
+Once it's determined that a code change is necessary, point people to
+[makeapullrequest.com](https://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.
+
+## 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.
+
+When we receive a pull request, a GitHub Action is kicked off automatically (see the
+`.github/workflows/validate.yml` for what runs in the Action). We avoid merging anything that breaks
+the GitHub Action.
+
+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.
+
+## Release
+
+Our releases are automatic. They happen whenever code lands into `main`. A GitHub Action 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...
+
+## Thanks!
+
+Thank you so much for helping to maintain this project!
+
+<!-- prettier-ignore-start -->
+[commit]: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
+<!-- prettier-ignore-end -->