Skip to content

Commit 2da83d1

Browse files
committed
Explanatory comments for utility script
1 parent 5ee7d4f commit 2da83d1

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

scripts/exp/update-internal-dep-versions.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,20 @@
1515
* limitations under the License.
1616
*/
1717

18+
/**
19+
* Update `@firebase` dependency versions in a package.json to reflect the latest versions.
20+
* These can get out of sync when working on a new unreleased component in a branch while the
21+
* already-released component versions in its deps keep being updated with each release.
22+
*
23+
* Usage: node scripts/exp/update-internal-dep-versions.js --file [package.json file path]
24+
*
25+
* Example: node scripts/exp/update-internal-dep-versions.js --file packages-exp/functions-exp/package.json
26+
*/
27+
1828
const { projectRoot } = require('../utils');
1929
const { mapPkgNameToPkgJson } = require('../release/utils/workspace');
2030
const { argv } = require('yargs');
2131
const fs = require('mz/fs');
22-
2332
async function updateField(pkg, fieldName) {
2433
const field = pkg[fieldName];
2534
for (const depName in field) {

0 commit comments

Comments
 (0)