#!/usr/bin/env node

const fs = require('fs');

const path = require('path');

const DEBUG = !!process.env['DEBUG'];

/**

* Detect if the user ran `yarn create @bazel` so we can default

* to using yarn in the new workspace.

*

* TODO: check whether it detects properly on Windows

*/

function detectRunningUnderYarn() {

const executable = process.argv[1];

if (!!executable && executable.indexOf('yarn/bin') >= 0) {

return true;

}

if (process.env['_'] && process.env['_'].endsWith('yarn')) {

return true;

}

return false;

}

function validateWorkspaceName(name, error) {

if (/^[_a-zA-Z0-9]+$/.test(name)) {

return true;

}

error(`ERROR: ${name} is not a valid Bazel workspace name.

A workspace name must start with a letter and can contain letters, numbers, and underscores

(this is to maximize the number of languages for which this string can be a valid package/module name).

It should describe the project in reverse-DNS form, with elements separated by underscores.

For example, if a project is hosted at example.com/some-project,

you might use com_example_some_project as the workspace name.

From https://docs.bazel.build/versions/master/be/functions.html#workspace`);

return false;

}

function usage(error) {

error(`@bazel/create usage:

Invoke it with any of these equivalent commands:

npx @bazel/create [workspace name] [options...]

npm init @bazel [workspace name] [options...]

yarn create @bazel [workspace name] [options...]

Options:

--packageManager=[yarn|npm] Select npm or yarn to install packages

(default: npm if you ran npm/npx, yarn if you ran yarn create)

--typescript Set up the workspace for TypeScript development

Run @bazel/create --help to see all options

`);

}

function main(argv, error = console.error, log = console.log) {

const args = require('minimist')(argv, {

boolean: ['typescript'],

});

if (!args['_'] || args['_'].length < 1) {

error('Please specify the workspace directory\n');

usage(error);

return 1;

}

if (args['help']) {

usage(error);

return 0;

}

// Which package manager will be used in the new project

const pkgMgr = args['packageManager'] || detectRunningUnderYarn() ? 'yarn' : 'npm';

if (DEBUG) {

log('Running with', process.argv);

log('Environment', process.env);

}

const [wkspDir] = args['_'];

// TODO: user might want these to differ

const wkspName = wkspDir;

if (!validateWorkspaceName(wkspName, error)) {

return 1;

}

log(`Creating Bazel workspace ${wkspName}...`);

fs.mkdirSync(wkspDir);

function write(workspaceRelativePath, content) {

fs.writeFileSync(

path.join(wkspDir, workspaceRelativePath), content + require('os').EOL,

{encoding: 'utf-8'});

}

const devDependencies = {

'@bazel/bazel': 'latest',

'@bazel/ibazel': 'latest',

'@bazel/buildifier': 'latest',

};

let rootBuildContent = '# Add rules here to build your software\n' +

'# See https://docs.bazel.build/versions/master/build-ref.html#BUILD_files\n\n';

if (args['typescript']) {

devDependencies['@bazel/typescript'] = 'latest';

devDependencies['typescript'] = '~3.4.0';

write('tsconfig.json', '');

rootBuildContent += '# Allow any ts_library rules in this workspace to reference the config\n' +

'# Note: if you move the tsconfig.json file to a subdirectory, you can add an alias() here instead\n' +

'# so that ts_library rules still use it by default.\n' +

'# See https://www.npmjs.com/package/@bazel/typescript#installation\n' +

'exports_files(["tsconfig.json"], visibility = ["//:__subpackages__"])\n';

}

write('BUILD.bazel', rootBuildContent);

const yarnInstallCmd =

`# The yarn_install rule runs yarn anytime the package.json or yarn.lock file changes.

# It also extracts and installs any Bazel rules distributed in an npm package.

load("@build_bazel_rules_nodejs//:index.bzl", "yarn_install")

yarn_install(

# Name this npm so that Bazel Label references look like @npm//package

name = "npm",

package_json = "//:package.json",

yarn_lock = "//:yarn.lock",

)`;

const npmInstallCmd =

`# The npm_install rule runs yarn anytime the package.json or package-lock.json file changes.

# It also extracts any Bazel rules distributed in an npm package.

load("@build_bazel_rules_nodejs//:index.bzl", "npm_install")

npm_install(

# Name this npm so that Bazel Label references look like @npm//package

name = "npm",

package_json = "//:package.json",

package_lock_json = "//:package-lock.json",

)`;

let workspaceContent = `# Bazel workspace created by @bazel/create 0.0.0-PLACEHOLDER

# Declares that this directory is the root of a Bazel workspace.

# See https://docs.bazel.build/versions/master/build-ref.html#workspace

workspace(

# How this workspace would be referenced with absolute labels from another workspace

name = "${wkspName}",

# Map the @npm bazel workspace to the node_modules directory.

# This lets Bazel use the same node_modules as other local tooling.

managed_directories = {"@npm": ["node_modules"]},

)

# Install the nodejs "bootstrap" package

# This provides the basic tools for running and packaging nodejs programs in Bazel

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(

name = "build_bazel_rules_nodejs",

sha256 = "3d7296d834208792fa3b2ded8ec04e75068e3de172fae79db217615bd75a6ff7",

urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/0.39.1/rules_nodejs-0.39.1.tar.gz"],

)

${pkgMgr === 'yarn' ? yarnInstallCmd : npmInstallCmd}

# Install any Bazel rules which were extracted earlier by the ${pkgMgr}_install rule.

load("@npm//:install_bazel_dependencies.bzl", "install_bazel_dependencies")

install_bazel_dependencies()`;

if (args['typescript']) {

workspaceContent += `

# Setup TypeScript toolchain

load("@npm_bazel_typescript//:index.bzl", "ts_setup_workspace")

ts_setup_workspace()`;

}

write('WORKSPACE', workspaceContent);

write('.bazelignore', `node_modules`);

write(

'package.json',

JSON.stringify(

{

name: wkspName,

version: '0.1.0',

private: true,

devDependencies,

scripts: {

'build': 'bazel build //...',

'test': 'bazel test //...',

}

},

null, 4));

write('.gitignore', `

dist

bazel-out

node_modules`);

// in the published distribution, this file will appear in the same folder as this file

try {

const rc = require.resolve('./common.bazelrc');

write('.bazelrc', fs.readFileSync(rc));

} catch (_) {

// but running locally against sources, it's in the root of the repo two directories up

if (fs.existsSync('../../common.bazelrc')) {

write('.bazelrc', fs.readFileSync('../../common.bazelrc'));

} else {

error('ERROR: missing common.bazelrc file, continuing with no bazel settings...');

}

}

log(`Successfully created new Bazel workspace at ${path.resolve(wkspDir)}`);

// TODO: we should probably run the package manager install now

log(`Next steps:

1. cd ${wkspDir}

2. ${pkgMgr} install

3. ${pkgMgr === 'yarn' ? 'yarn build' : 'npm run build'}

Note that there is nothing to build, so this trivially succeeds.

4. Add contents to the BUILD.bazel file or create a new BUILD.bazel in a subdirectory.

`);

return 0;

}

module.exports = {main};

if (require.main === module) {

process.exitCode = main(process.argv.slice(2));

}