github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/ui/bin/gen-protobuf-cli-deps.js

#!/usr/bin/env node
// Copyright 2019 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.


// ProtobufJS's CLI attempts to install its own CLI dependencies at runtime by
// exec'ing NPM. This is crazy. It introduces a dependency on NPM and breaks our
// dependency pinning and vendoring. There is an upstream issue about this [1],
// but it hasn't received any attention in nearly a year.
//
// As a workaround, this script figures out what NPM packages the ProtobufJS CLI
// would install, mirroring the logic in [0], and generates a package.json
// encoding those dependencies. The Makefile can then invoke `yarn install` on
// this synthesized package, giving us enough control over the dependency
// installation to pin and vendor the dependencies. The ProtobufJS CLI will not
// try to invoke NPM itself if its required dependencies are already installed.
//
// TODO(benesch): switch away from ProtobufJS and use protoc's support for
// generating JavaScript directly.
//
// [0]: https://github.com/dcodeIO/protobuf.js/blob/e8449c4/cli/util.js#L135-L157
// [1]: https://github.com/dcodeIO/protobuf.js/issues/716

var pbjsPkg = require("protobufjs/package");

const pbjsCliPkg = {
  "//": "File automatically generated by gen-protobuf-cli-deps. DO NOT EDIT!",
  dependencies: {},
};

pbjsPkg.cliDependencies.forEach(dep => {
  const version = pbjsPkg.dependencies[dep] || pbjsPkg.devDependencies[dep];
  pbjsCliPkg.dependencies[dep] = version;
})

process.stdout.write(JSON.stringify(pbjsCliPkg, null, 2));