firebase-tools/lib/commands/init.js

Command-Line Interface for Firebase

"use strict";
var clc = require("cli-color");
var fs = require("fs");
var homeDir = require("os").homedir();
var path = require("path");
var { Command } = require("../command");
var Config = require("../config");
var fsutils = require("../fsutils");
var init = require("../init");
var logger = require("../logger");
var { prompt, promptOnce } = require("../prompt");
var requireAuth = require("../requireAuth");
var utils = require("../utils");
var TEMPLATE_ROOT = path.resolve(__dirname, "../../templates/");
var BANNER_TEXT = fs.readFileSync(path.join(TEMPLATE_ROOT, "banner.txt"), "utf8");
var GITIGNORE_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "_gitignore"), "utf8");
var _isOutside = function (from, to) {
    return path.relative(from, to).match(/^\.\./);
};
module.exports = new Command("init [feature]")
    .description("setup a Firebase project in the current directory")
    .before(requireAuth)
    .action(function (feature, options) {
    var cwd = options.cwd || process.cwd();
    var warnings = [];
    var warningText = "";
    if (_isOutside(homeDir, cwd)) {
        warnings.push("You are currently outside your home directory");
    }
    if (cwd === homeDir) {
        warnings.push("You are initializing your home directory as a Firebase project");
    }
    var config = Config.load(options, true);
    var existingConfig = !!config;
    if (!existingConfig) {
        config = new Config({}, { projectDir: cwd, cwd: cwd });
    }
    else {
        warnings.push("You are initializing in an existing Firebase project directory");
    }
    if (warnings.length) {
        warningText =
            "\nBefore we get started, keep in mind:\n\n  " +
                clc.yellow.bold("* ") +
                warnings.join("\n  " + clc.yellow.bold("* ")) +
                "\n";
    }
    logger.info(clc.yellow.bold(BANNER_TEXT) +
        "\nYou're about to initialize a Firebase project in this directory:\n\n  " +
        clc.bold(config.projectDir) +
        "\n" +
        warningText);
    var setup = {
        config: config._src,
        rcfile: config.readProjectFile(".firebaserc", {
            json: true,
            fallback: {},
        }),
    };
    var choices = [
        {
            value: "database",
            name: "Database: Deploy Firebase Realtime Database Rules",
            checked: false,
        },
        {
            value: "firestore",
            name: "Firestore: Deploy rules and create indexes for Firestore",
            checked: false,
        },
        {
            value: "functions",
            name: "Functions: Configure and deploy Cloud Functions",
            checked: false,
        },
        {
            value: "hosting",
            name: "Hosting: Configure and deploy Firebase Hosting sites",
            checked: false,
        },
        {
            value: "storage",
            name: "Storage: Deploy Cloud Storage security rules",
            checked: false,
        },
        {
            value: "emulators",
            name: "Emulators: Set up local emulators for Firebase features",
            checked: false,
        },
    ];
    var next;
    if (process.platform === "win32") {
        next = promptOnce({
            type: "confirm",
            message: "Are you ready to proceed?",
        });
    }
    else {
        next = Promise.resolve(true);
    }
    return next
        .then(function (proceed) {
        if (!proceed) {
            return utils.reject("Aborted by user.", { exit: 1 });
        }
        if (feature) {
            setup.featureArg = true;
            setup.features = [feature];
            return undefined;
        }
        return prompt(setup, [
            {
                type: "checkbox",
                name: "features",
                message: "Which Firebase CLI features do you want to set up for this folder? " +
                    "Press Space to select features, then Enter to confirm your choices.",
                choices: choices,
            },
        ]);
    })
        .then(function () {
        if (setup.features.length === 0) {
            return utils.reject("Must select at least one feature. Use " +
                clc.bold.underline("SPACEBAR") +
                " to select features, or provide a feature with " +
                clc.bold("firebase init [feature_name]"));
        }
        setup.features.unshift("project");
        return init(setup, config, options);
    })
        .then(function () {
        logger.info();
        utils.logBullet("Writing configuration info to " + clc.bold("firebase.json") + "...");
        config.writeProjectFile("firebase.json", setup.config);
        utils.logBullet("Writing project information to " + clc.bold(".firebaserc") + "...");
        config.writeProjectFile(".firebaserc", setup.rcfile);
        if (!fsutils.fileExistsSync(config.path(".gitignore"))) {
            utils.logBullet("Writing gitignore file to " + clc.bold(".gitignore") + "...");
            config.writeProjectFile(".gitignore", GITIGNORE_TEMPLATE);
        }
        logger.info();
        utils.logSuccess("Firebase initialization complete!");
    });
});