From fdc916a5a097a61c0b7d36f4a06cae96285166b7 Mon Sep 17 00:00:00 2001 From: Joe Haddad <timer150@gmail.com> Date: Fri, 21 Sep 2018 10:02:08 -0400 Subject: [PATCH] Cache identifier follow up (#5055) * Tweak environment handling * Add documentation for getCacheIdentifier --- packages/react-dev-utils/README.md | 14 ++++++++++++-- packages/react-dev-utils/getCacheIdentifier.js | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/packages/react-dev-utils/README.md b/packages/react-dev-utils/README.md index a93166d75..53c73bfc5 100644 --- a/packages/react-dev-utils/README.md +++ b/packages/react-dev-utils/README.md @@ -3,8 +3,8 @@ This package includes some utilities used by [Create React App](https://github.com/facebook/create-react-app).<br> Please refer to its documentation: -* [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app. -* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. +- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app. +- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. ## Usage in Create React App Projects @@ -361,3 +361,13 @@ module: { ]; } ``` + +#### `getCacheIdentifier(environment: string, packages: string[]): string` + +Returns a cache identifier (string) consisting of the specified environment and related package versions, e.g., + +```js +var getCacheIdentifier = require('react-dev-utils/getCacheIdentifier'); + +getCacheIdentifier('prod', ['react-dev-utils', 'chalk']); // # => 'prod:react-dev-utils@5.0.0:chalk@2.4.1' +``` diff --git a/packages/react-dev-utils/getCacheIdentifier.js b/packages/react-dev-utils/getCacheIdentifier.js index 2cc681f3a..08bcb6577 100644 --- a/packages/react-dev-utils/getCacheIdentifier.js +++ b/packages/react-dev-utils/getCacheIdentifier.js @@ -8,7 +8,7 @@ 'use strict'; module.exports = function getCacheIdentifier(environment, packages) { - let cacheIdentifier = `${environment}`; + let cacheIdentifier = environment == null ? '' : environment.toString(); for (const packageName of packages) { cacheIdentifier += `:${packageName}@`; try { -- GitLab