Merge branch '9.2.0-release' into typesctipt-commands

Author: chrisbreiding

content/_changelogs/5.4.0.md

@@ -27,7 +27,7 @@ _Released 10/14/2020_
   [#8624](https://github.com/cypress-io/cypress/issues/8624)
 - When there is a new version of Cypress available, the update modal has a new
   design with 'copy to clipboard' buttons to copy the upgrade commands.
-  Addressed in [#8751](https://github.com/cypress-io/cypress/issues/8751).
+  Addressed in [#8751](https://github.com/cypress-io/cypress/pull/8751).
 - The [Command Log](/guides/core-concepts/test-runner#Command-Log) can be hidden
   by passing the `CYPRESS_NO_COMMAND_LOG=1` environment variable during
   `cypress open` or `cypress run` to be used as a tool to debug performance

content/_changelogs/5.5.0.md

@@ -13,7 +13,7 @@ _Released 10/26/2020_
 **Bugfixes:**
 
 - Updated the Cypress proxy layer to proxy HTTPS traffic from non-AUT origins.
-  Addressed in [#8827](https://github.com/cypress-io/cypress/issues/8827).
+  Addressed in [#8827](https://github.com/cypress-io/cypress/pull/8827).
   - This fixed an issue with [`cy.route2()`](http) where HTTPS requests to a
     non-AUT origin would not be intercepted as expected.
 - [`cy.route2()`](http) now properly handles passing a method as its first

content/_changelogs/6.0.0.md

@@ -62,7 +62,7 @@ deprecations.
   support for `cy.server()` and `cy.route()` will be removed. We encourage you
   to use [cy.intercept()](/api/commands/intercept) instead. See our guide on
   [Migrating `cy.route()` to `cy.intercept()`](/guides/references/migration-guide#Migrating-cy-route-to-cy-intercept).
-  Addressed in [#9185](https://github.com/cypress-io/cypress/issues/9185).
+  Addressed in [#9185](https://github.com/cypress-io/cypress/pull/9185).
 - `experimentalFetchPolyfill` has been deprecated. We encourage you to use
   [cy.intercept()](/api/commands/intercept) to intercept requests using the
   Fetch API instead.

content/_changelogs/6.1.0.md

@@ -35,7 +35,7 @@ _Released 12/07/2020_
   [#8999](https://github.com/cypress-io/cypress/issues/8999).
 - We fixed an issue where HTTP redirects could not be awaited using
   [cy.intercept()](/api/commands/intercept) unless dynamically intercepted.
-  Addressed in [#9097](https://github.com/cypress-io/cypress/issues/9097).
+  Addressed in [#9097](https://github.com/cypress-io/cypress/pull/9097).
 - Tests will no longer hang in certain situations when there's an error in a
   `before()` hook. Fixes
   [#9162](https://github.com/cypress-io/cypress/issues/9162).

content/_changelogs/6.2.0.md

@@ -11,10 +11,10 @@ _Released 12/21/2020_
   [`after:run`](/api/plugins/after-run-api),
   [`before:spec`](/api/plugins/before-spec-api) and
   [`after:spec`](/api/plugins/after-spec-api) docs for more information.
-  Addressed in [#9646](https://github.com/cypress-io/cypress/issues/9646),
-  [#14178](https://github.com/cypress-io/cypress/issues/14178)
-  [#14238](https://github.com/cypress-io/cypress/issues/14238) and
-  [#14263](https://github.com/cypress-io/cypress/issues/14263).
+  Addressed in [#9646](https://github.com/cypress-io/cypress/pull/9646),
+  [#14178](https://github.com/cypress-io/cypress/pull/14178)
+  [#14238](https://github.com/cypress-io/cypress/pull/14238) and
+  [#14263](https://github.com/cypress-io/cypress/pull/14263).
 - The `Timed out retrying` error message now displays the amount of time Cypress
   retried. Addresses [#5781](https://github.com/cypress-io/cypress/issues/5781).
 - The RouteMatcher argument for [cy.intercept()](/api/commands/intercept) has a

content/_changelogs/6.7.0.md

@@ -12,7 +12,7 @@ _Released 3/15/2021_
   [`after:run`](/api/plugins/after-run-api),
   [`before:spec`](/api/plugins/before-spec-api) and
   [`after:spec`](/api/plugins/after-spec-api) docs for more information.
-  Addressed in [#15276](https://github.com/cypress-io/cypress/issues/15276).
+  Addressed in [#15276](https://github.com/cypress-io/cypress/pull/15276).
 - When canceling a run from the Dashboard, previously only parallelized runs
   would cancel correctly. Now all recorded runs will respect cancelation and
   exit early. Addresses
@@ -25,7 +25,7 @@ _Released 3/15/2021_
   upfront. Addressed in
   [#14925](https://github.com/cypress-io/cypress/issues/14925).
 - The full stack trace from errors thrown in the preprocessor are now displayed.
-  Addressed in [#15198](https://github.com/cypress-io/cypress/issues/15198).
+  Addressed in [#15198](https://github.com/cypress-io/cypress/pull/15198).
 - Configuration values which are changed at runtime prior to tests running are
   now properly shown as resolved from the spec code within the Module API to
   indicate where the change originated from. Addresses

content/_changelogs/7.0.0.md

@@ -75,7 +75,7 @@ in more detail and how to change your code to migrate to Cypress 7.0.**
   [`redirectionLimit`](guides/references/configuration#Global) config. Addresses
   [#14445](https://github.com/cypress-io/cypress/issues/14445).
 - The default preprocessor now targets a more modern version of ECMAScript.
-  Addressed in [#15274](https://github.com/cypress-io/cypress/issues/15274).
+  Addressed in [#15274](https://github.com/cypress-io/cypress/pull/15274).
 - We now enable
   [`contextIsolation`](https://www.electronjs.org/docs/tutorial/context-isolation)
   by default in the Electron browser. You can override this option if needed

content/_changelogs/8.3.0.md

@@ -5,7 +5,7 @@ _Released 08/16/2021_
 **Features:**
 
 - The instructions for recording a run have been updated for some users.
-  Addressed in [#17317](https://github.com/cypress-io/cypress/issues/17317).
+  Addressed in [#17317](https://github.com/cypress-io/cypress/pull/17317).
 
 **Performance:**
 

content/api/commands/readfile.md

@@ -46,7 +46,8 @@ supported:
 - `'utf-16le'`
 - `null`
 
-Using `null` explicitly will return the file as a `Buffer`, regardless of file extension.
+Using `null` explicitly will return the file as a `Buffer`, regardless of file
+extension.
 
 **<Icon name="angle-right"></Icon> options** **_(Object)_**
 
@@ -59,7 +60,7 @@ Pass in an options object to change the default behavior of `cy.readFile()`.
 
 ### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
 
-<List><li>`cy.readFile()` yields the contents of the file.</li></List>
+- `cy.readFile()` yields the contents of the file.
 
 ## Examples
 
@@ -195,21 +196,21 @@ cy.readFile('some/nested/path/story.txt').should('eq', 'Once upon a time...')
 
 ### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
 
-<List><li>`cy.readFile()` requires being chained off of
-`cy`.</li><li>`cy.readFile()` requires the file must
-exist.</li><li>`cy.readFile()` requires the file be successfully read from
-disk.</li></List>
+- `cy.readFile()` requires being chained off of `cy`.
+- `cy.readFile()` requires the file must exist.
+- `cy.readFile()` requires the file be successfully read from disk.
 
 ### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
 
-<List><li>`cy.readFile()` will automatically
-[retry](/guides/core-concepts/retry-ability) until all chained assertions have
-passed</li></List>
+- `cy.readFile()` will automatically
+  [retry](/guides/core-concepts/retry-ability) until all chained assertions have
+  passed.
 
 ### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
 
-<List><li>`cy.readFile()` can time out waiting for assertions you've added to
-pass.</li></List>
+- `cy.readFile()` can time out waiting for assertions you've added to pass.
+- `cy.readFile()` can time out when the content being read takes a significant
+  amount of time to encode.
 
 ## Command Log
 
@@ -228,6 +229,14 @@ outputs the following:
 
 <DocsImage src="/img/api/readfile/console-log-shows-content-from-file-formatted-as-javascript.png" alt="Console Log readFile" ></DocsImage>
 
+## History
+
+| Version                                       | Changes                                   |
+| --------------------------------------------- | ----------------------------------------- |
+| [9.0.0](/guides/references/changelog#9-0-0)   | Changed `null` encoding to read as Buffer |
+| [0.17.2](/guides/references/changelog#0-17-2) | Improved error messaging                  |
+| [0.17.1](/guides/references/changelog#0-17-1) | `cy.readFile()` command added             |
+
 ## See also
 
 - [`cy.exec()`](/api/commands/exec)

content/api/commands/writefile.md

@@ -28,7 +28,8 @@ cy.writeFile('menu.json')
 A path to a file within the project root (the directory that contains the
 default `cypress.json`).
 
-**<Icon name="angle-right"></Icon> contents** **_(String, Array, Object or Buffer)_**
+**<Icon name="angle-right"></Icon> contents** **_(String, Array, Object or
+Buffer)_**
 
 The contents to be written to the file.
 
@@ -57,11 +58,12 @@ first encoding it as a string.
 
 Pass in an options object to change the default behavior of `cy.writeFile()`.
 
-| Option     | Default | Description                                                                                         |
-| ---------- | ------- | --------------------------------------------------------------------------------------------------- |
-| `log`      | `true`  | Displays the command in the [Command log](/guides/core-concepts/test-runner#Command-Log)            |
-| `flag`     | `w`     | File system flag as used with [`fs.writeFile`](https://nodejs.org/api/fs.html#fs_file_system_flags) |
-| `encoding` | `utf8`  | The encoding to be used when writing to the file                                                    |
+| Option     | Default                                                              | Description                                                                                         |
+| ---------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `log`      | `true`                                                               | Displays the command in the [Command log](/guides/core-concepts/test-runner#Command-Log)            |
+| `flag`     | `w`                                                                  | File system flag as used with [`fs.writeFile`](https://nodejs.org/api/fs.html#fs_file_system_flags) |
+| `encoding` | `utf8`                                                               | The encoding to be used when writing to the file                                                    |
+| `timeout`  | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.writeFile()` to resolve before [timing out](#Timeouts)                           |
 
 <Alert type="info">
 
@@ -73,8 +75,7 @@ parameter and include encoding there. This is the same behavior as
 
 ### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
 
-<List><li>`cy.writeFile()` yields the value of the <code>contents</code>
-argument.</li></List>
+- `cy.writeFile()` yields `null`.
 
 ## Examples
 
@@ -193,6 +194,7 @@ cy.readFile(filename).then((list) => {
 ### Buffer
 
 #### Write a buffer directly without encoding as a string
+
 ```javascript
 const filename = '/path/to/file.png'
 
@@ -207,7 +209,6 @@ cy.readFile(filename, null).then((obj) => {
 ### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
 
 - `cy.writeFile()` requires being chained off of `cy`.
-
 - `cy.writeFile()` requires the file be successfully written to disk. Anything
   preventing this such as OS permission issues will cause it to fail.
 
@@ -218,15 +219,8 @@ cy.readFile(filename, null).then((obj) => {
 
 ### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
 
-- `cy.writeFile()` should never time out.
-
-<Alert type="warning">
-
-Because `cy.writeFile()` is asynchronous it is technically possible for there to
-be a timeout while talking to the internal Cypress automation APIs. But for
-practical purposes it should never happen.
-
-</Alert>
+- `cy.writeFile()` can time out when the content being written takes a
+  significant amount of time to encode.
 
 ## Command Log
 
@@ -249,6 +243,7 @@ outputs the following:
 
 | Version                                     | Changes                                                  |
 | ------------------------------------------- | -------------------------------------------------------- |
+| [9.2.0](/guides/references/changelog#9-2-0) | Added `timeout` option                                   |
 | [4.0.0](/guides/references/changelog#4-0-0) | `cy.writeFile()` now yields `null` instead of `contents` |
 | [3.1.1](/guides/references/changelog#3-1-1) | Added `flag` option and appending with `a+`              |
 | [1.0.0](/guides/references/changelog#1.0.0) | `cy.writeFile()` command added                           |