@webiny/cli 6.0.0-beta.0 → 6.0.0-rc.1

package/context.js

@@ -1,137 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const { importModule, getProject, PluginsContainer, log, localStorage, noop } = require("./utils");
-
-const project = getProject();
-
-if (!project) {
-    console.log(
-        `🚨 Couldn't locate "webiny.project.js"! Webiny CLI relies on that file to find the root of a Webiny project.`
-    );
-    process.exit(1);
-}
-
-class Context {
-    constructor() {
-        this.loadedEnvFiles = {};
-
-        this.version = require("./package.json").version;
-        this.project = project;
-
-        // Check if `projectName` was injected properly.
-        if (this.project.name === "[PROJECT_NAME]") {
-            console.log(
-                [
-                    "",
-                    "🚨 IMPORTANT 🚨",
-                    "Looks like your project was not bootstrapped correctly! We recommend creating a new project from scratch.",
-                    "If you see errors during project creation, please report them to us:",
-                    "🔗 Github:\thttps://github.com/webiny/webiny-js",
-                    "🔗 Slack:\thttps://www.webiny.com/slack",
-                    ""
-                ].join("\n")
-            );
-            process.exit(1);
-        }
-
-        this.plugins = new PluginsContainer();
-
-        this.localStorage = localStorage();
-
-        this.onExitCallbacks = [];
-
-        let onExitProcessed = false;
-        process.on("SIGINT", async () => {
-            if (onExitProcessed) {
-                return;
-            }
-
-            onExitProcessed = true;
-
-            for (let i = 0; i < this.onExitCallbacks.length; i++) {
-                await this.onExitCallbacks[i]("SIGINT");
-            }
-
-            process.exit(1);
-        });
-    }
-
-    onExit(callback) {
-        this.onExitCallbacks.push(callback);
-    }
-
-    import(name) {
-        return importModule(name);
-    }
-
-    async loadUserPlugins() {
-        if (this.project.config.cli) {
-            let plugins = this.project.config.cli.plugins || [];
-            if (typeof plugins === "function") {
-                plugins = await plugins();
-            }
-
-            this.plugins.register(
-                ...plugins.map(plugin => {
-                    if (typeof plugin === "string") {
-                        let loadedPlugin;
-                        try {
-                            loadedPlugin = require(path.join(this.project.root, plugin)); // Try loading the package from the project's root
-                        } catch {
-                            // If it fails, perhaps the user still has the package installed somewhere locally...
-                            loadedPlugin = require(plugin);
-                        }
-                        return loadedPlugin;
-                    }
-                    return plugin;
-                })
-            );
-        }
-    }
-
-    log = log.log;
-    info = log.info;
-    success = log.success;
-    debug = process.argv.some(v => v.match("--debug")) ? log.debug : noop;
-    warning = log.warning;
-    error = log.error;
-
-    resolve(...dir) {
-        return path.resolve(this.project.root, ...dir);
-    }
-
-    replaceProjectRoot(path) {
-        return path.replace(this.project.root, "<projectRoot>").replace(/\\/g, "/");
-    }
-
-    /**
-     * Uses `dotenv` lib to load env files, by accepting a simple file path.
-     * @param filePath
-     * @param debug
-     * @returns {Promise<void>}
-     */
-    async loadEnv(filePath, { debug = false } = {}) {
-        if (this.loadedEnvFiles[filePath]) {
-            return;
-        }
-
-        if (!fs.existsSync(filePath)) {
-            debug && this.debug(`No environment file found on %s.`, filePath);
-            return;
-        }
-
-        try {
-            require("dotenv").config({ path: filePath });
-            debug && this.success(`Loaded environment variables from ${filePath}.`);
-            this.loadedEnvFiles[filePath] = true;
-        } catch (err) {
-            if (debug) {
-                this.error(`Could not load env variables from ${filePath}:`);
-                this.error(err.message);
-                console.log();
-            }
-        }
-    }
-}
-
-module.exports = new Context();

package/index.d.ts

@@ -1,3 +0,0 @@
-import { CliContext } from "./types";
-
-export declare const cli: CliContext;

package/types.d.ts

@@ -1,172 +0,0 @@
-/**
- * Rename file to types.ts when switching the package to Typescript.
- */
-
-import glob from "fast-glob";
-import { dirname, join } from "path";
-
-/**
- * A simplified plugins container interface, used specifically within the Webiny CLI.
- * Not in relation with "@webiny/plugins" package.
- */
-export interface PluginsContainer {
-    byType<T extends Plugin>(type: T["type"]): T[];
-
-    byName<T extends Plugin>(name: T["name"]): T;
-}
-
-/**
- * A simplified plugin interface, used specifically within the Webiny CLI.
- * Not in relation with "@webiny/plugins" package.
- */
-export interface Plugin {
-    type: string;
-    name?: string;
-
-    [key: string]: any;
-}
-
-interface Project {
-    /**
-     * Name of the project.
-     */
-    name: string;
-    /**
-     * Configurations.
-     */
-    config: Record<string, any>;
-    /**
-     * Root path of the project.
-     */
-    root: string;
-}
-
-export interface ProjectApplication {
-    /**
-     * Unique ID of the project application.
-     */
-    id: string;
-    /**
-     * Name of the project application.
-     */
-    name: string;
-    /**
-     * Description of the project application.
-     */
-    description: string;
-    /**
-     * Type of the project application.
-     */
-    type: string;
-    /**
-     * Root path of the project application.
-     */
-    root: string;
-    /**
-     * Commonly used paths.
-     */
-    paths: {
-        relative: string;
-        absolute: string;
-        workspace: string;
-    };
-    /**
-     * Project application config (exported via `webiny.application.ts` file).
-     */
-    config: Record<string, any>;
-    /**
-     * Project application package.json.
-     */
-    project: Project;
-
-    /**
-     * A list of all the packages in the project application.
-     */
-    get packages(): Array<{
-        name: string;
-        paths: {
-            root: string;
-            packageJson: string;
-            config: string;
-        };
-        packageJson: Record<string, any>;
-        get config(): any;
-    }>;
-}
-
-/**
- * A type that represents the logging method.
- */
-interface Log {
-    (...args: any): string;
-
-    hl: (...args: any) => string;
-    highlight: (...args: any) => string;
-}
-
-/**
- * Interface representing the CLI Context.
- */
-export interface CliContext {
-    /**
-     * All registered plugins.
-     */
-    plugins: PluginsContainer;
-    /**
-     * All the environment variables.
-     */
-    loadedEnvFiles: Record<string, any>;
-    /**
-     * Version of the Webiny CLI.
-     */
-    version: string;
-    /**
-     * Project information.
-     */
-    project: Project;
-    /**
-     * Trigger given callback on SIGINT.
-     */
-    onExit: (cb: () => any) => void;
-    /**
-     * Import a given module.
-     */
-    import: (module: string) => Promise<void>;
-    /**
-     * Regular logging.
-     */
-    log: Log;
-    /**
-     * Info logging.
-     */
-    info: Log;
-    /**
-     * Success logging.
-     */
-    success: Log;
-    /**
-     * Debug logging.
-     */
-    debug: Log;
-    /**
-     * Warnings logging.
-     */
-    warning: Log;
-    /**
-     * Errors logging.
-     */
-    error: Log;
-    /**
-     * Resolve given dir or dirs against project root path.
-     */
-    resolve: (dir: string) => string;
-
-    /**
-     * Provides a way to store some meta data in the project's local ".webiny/cli.json" file.
-     * Only trivial data should be passed here, specific to the current project.
-     */
-    localStorage: {
-        set: (key: string, value: string) => Record<string, any>;
-        get: (key: string) => any;
-    };
-}

package/utils/PluginsContainer.js

@@ -1,49 +0,0 @@
-const uniqid = require("uniqid");
-
-// Since the Webiny CLI can rely on "@webiny/plugins" package (chicken-egg problem), then
-// we need to make a copy of its PluginsContainer class. We removed all of the extra
-// features that are in reality not needed for the Webiny CLI.
-const assign = (plugins, target) => {
-    for (let i = 0; i < plugins.length; i++) {
-        const plugin = plugins[i];
-        if (Array.isArray(plugin)) {
-            assign(plugin, target);
-            continue;
-        }
-
-        let name = plugin._name || plugin.name;
-        if (!name) {
-            plugin.name = name = uniqid(plugin.type + "-");
-        }
-
-        target[name] = plugin;
-    }
-};
-
-module.exports = class PluginsContainer {
-    plugins = {};
-    constructor(...args) {
-        this.register(...args);
-    }
-
-    byName(name) {
-        return this.plugins[name];
-    }
-
-    byType(type) {
-        const plugins = this.findByType(type);
-        return Array.from(plugins);
-    }
-
-    findByType(type) {
-        return Object.values(this.plugins).filter(pl => pl.type === type);
-    }
-
-    register(...args) {
-        assign(args, this.plugins);
-    }
-
-    unregister(name) {
-        delete this.plugins[name];
-    }
-};

package/utils/createProjectApplicationWorkspace.js

@@ -1,16 +0,0 @@
-const util = require("util");
-const fs = require("fs-extra");
-const ncpBase = require("ncp");
-const ncp = util.promisify(ncpBase.ncp);
-
-module.exports = async projectApplication => {
-    if (await fs.pathExists(projectApplication.paths.workspace)) {
-        await fs.remove(projectApplication.paths.workspace);
-    }
-
-    await fs.ensureDir(projectApplication.paths.workspace);
-    await ncp(projectApplication.paths.absolute, projectApplication.paths.workspace);
-
-    // Wait a bit and make sure the files are ready to have its content replaced.
-    return new Promise(resolve => setTimeout(resolve, 10));
-};

package/utils/getProject.js

@@ -1,48 +0,0 @@
-const findUp = require("find-up");
-const { dirname } = require("path");
-const { importModule } = require("./importModule");
-
-const projectConfigs = ["webiny.project.js", "webiny.project.ts"];
-
-function getRoot({ cwd } = {}) {
-    let root = findUp.sync(projectConfigs, { cwd });
-    if (root) {
-        return dirname(root).replace(/\\/g, "/");
-    }
-
-    // For backwards compatibility
-    root = findUp.sync("webiny.root.js", { cwd });
-    if (root) {
-        return dirname(root).replace(/\\/g, "/");
-    }
-
-    throw new Error("Couldn't detect Webiny project.");
-}
-
-function getConfig({ cwd } = {}) {
-    let path = findUp.sync(projectConfigs, { cwd });
-    if (path) {
-        return importModule(path);
-    }
-
-    path = findUp.sync("webiny.root.js", { cwd });
-    if (path) {
-        return require(path);
-    }
-
-    throw new Error("Couldn't detect Webiny project.");
-}
-
-module.exports = args => {
-    const root = getRoot(args);
-    return {
-        get name() {
-            // Check "projectName" for backwards compatibility.
-            return process.env.WEBINY_PROJECT_NAME || this.config.projectName || this.config.name;
-        },
-        root,
-        get config() {
-            return getConfig(args);
-        }
-    };
-};

package/utils/getProjectApplication.js

@@ -1,83 +0,0 @@
-const { dirname, basename, join, relative } = require("path");
-const findUp = require("find-up");
-const getProject = require("./getProject");
-const { importModule } = require("./importModule");
-const glob = require("fast-glob");
-
-const appConfigs = ["webiny.application.js", "webiny.application.ts"];
-
-module.exports = args => {
-    // Using "Pulumi.yaml" for the backwards compatibility.
-    const applicationRootFile = findUp.sync(appConfigs.concat("Pulumi.yaml"), { cwd: args.cwd });
-
-    if (!applicationRootFile) {
-        throw new Error(`Could not detect project application in given directory (${args.cwd}).`);
-    }
-
-    const rootFile = applicationRootFile.replace(/\\/g, "/");
-    const projectAppRootPath = dirname(rootFile);
-
-    let applicationConfig;
-    if (appConfigs.includes(basename(rootFile))) {
-        applicationConfig = importModule(rootFile);
-    }
-
-    let id, name, description;
-    if (applicationConfig) {
-        id = applicationConfig.id;
-        name = applicationConfig.name;
-        description = applicationConfig.description;
-    } else {
-        name = basename(projectAppRootPath);
-        description = name;
-        id = name;
-    }
-
-    const project = getProject(args);
-
-    const projectAppRelativePath = relative(project.root, projectAppRootPath);
-    const projectAppWorkspacePath = join(
-        project.root,
-        ".webiny",
-        "workspaces",
-        projectAppRelativePath
-    );
-
-    return {
-        id,
-        name,
-        description,
-        root: projectAppRootPath,
-        paths: {
-            relative: projectAppRelativePath,
-            absolute: projectAppRootPath,
-            workspace: projectAppWorkspacePath
-        },
-        config: applicationConfig,
-        project,
-        get packages() {
-            const webinyConfigs = glob.sync(
-                join(projectAppRootPath, "**/webiny.config*.{ts,js}").replace(/\\/g, "/")
-            );
-
-            return webinyConfigs.map(config => {
-                const dirPath = dirname(config);
-                const packageJson = require(join(dirPath, "package.json"));
-                return {
-                    name: packageJson.name,
-                    paths: {
-                        absolute: dirname(config),
-                        relative: relative(project.root, dirPath),
-                        root: dirname(config),
-                        packageJson: join(dirPath, "package.json"),
-                        config
-                    },
-                    packageJson,
-                    get config() {
-                        return require(config).default || require(config);
-                    }
-                };
-            });
-        }
-    };
-};

package/utils/importModule.js

@@ -1,43 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const { addHook } = require("pirates");
-
-/**
- * Add support for TS
- */
-
-addHook(
-    code => {
-        const ts = require("typescript");
-        const { outputText } = ts.transpileModule(code, {
-            compilerOptions: {
-                target: "es6",
-                allowJs: true,
-                allowSyntheticDefaultImports: true,
-                esModuleInterop: true,
-                outDir: "bin",
-                moduleResolution: "node",
-                module: "commonjs"
-            }
-        });
-
-        return outputText;
-    },
-    {
-        exts: [".ts"],
-        matcher: () => true
-    }
-);
-
-module.exports.importModule = configPath => {
-    if (!fs.existsSync(configPath)) {
-        throw Error(`"${configPath}" does not exist!`);
-    }
-
-    const extension = path.extname(configPath);
-    if (extension === ".ts") {
-        return require(configPath).default;
-    } else {
-        return require(configPath);
-    }
-};

package/utils/index.js

@@ -1,24 +0,0 @@
-const { importModule } = require("./importModule");
-const createProjectApplicationWorkspace = require("./createProjectApplicationWorkspace");
-const getProject = require("./getProject");
-const getProjectApplication = require("./getProjectApplication");
-const localStorage = require("./localStorage");
-const log = require("./log");
-const sendEvent = require("./sendEvent");
-const PluginsContainer = require("./PluginsContainer");
-
-const noop = () => {
-    // Do nothing.
-};
-
-module.exports = {
-    createProjectApplicationWorkspace,
-    getProject,
-    getProjectApplication,
-    importModule,
-    localStorage,
-    log,
-    noop,
-    sendEvent,
-    PluginsContainer
-};

package/utils/loadEnvVariables.js

@@ -1,63 +0,0 @@
-const path = require("path");
-const yargs = require("yargs");
-const log = require("./log");
-const getProject = require("./getProject");
-const { boolean } = require("boolean");
-
-// Load environment variables from following sources:
-// - `webiny.project.ts` file
-// - `.env` file
-// - `.env.{PASSED_ENVIRONMENT}` file
-
-const project = getProject();
-
-// `webiny.project.ts` file.
-// Environment variables defined via the `env` property.
-if (project.config.env) {
-    Object.assign(process.env, project.config.env);
-}
-
-// `.env.{PASSED_ENVIRONMENT}` and `.env` files.
-let paths = [path.join(project.root, ".env")];
-
-if (yargs.argv.env) {
-    paths.push(path.join(project.root, `.env.${yargs.argv.env}`));
-}
-
-// If the `WCP_PROJECT_ID` environment variable is not set already, we check if there's
-// a WCP project ID set via the `webiny.project.ts` config file. If so, we assign it
-// to the `WCP_PROJECT_ID` environment variable.
-if (!process.env.WCP_PROJECT_ID) {
-    if (project.config.id) {
-        process.env.WCP_PROJECT_ID = project.config.id;
-    }
-}
-
-// Let's load environment variables
-for (let i = 0; i < paths.length; i++) {
-    const path = paths[i];
-    const { error } = require("dotenv").config({ path });
-    if (boolean(yargs.argv.debug)) {
-        if (error) {
-            log.debug(`No environment file found on ${log.debug.hl(path)}.`);
-        } else {
-            log.success(`Successfully loaded environment variables from ${log.success.hl(path)}.`);
-        }
-    }
-}
-
-// Feature flags defined via the `featureFlags` property.
-// We set twice, to be available for both backend and frontend application code.
-// TODO: one day we might want to sync this up a bit.
-if (project.config.featureFlags) {
-    process.env.WEBINY_FEATURE_FLAGS = JSON.stringify(project.config.featureFlags);
-    process.env.REACT_APP_WEBINY_FEATURE_FLAGS = JSON.stringify(project.config.featureFlags);
-}
-
-// With 5.38.0, we are hiding the `WEBINY_ELASTICSEARCH_INDEX_LOCALE` env variable and always setting it to `true`.
-// This is because this variable is not something users should be concerned with, nor should they be able to change it.
-// In order to ensure backwards compatibility, we first check if the variable is set, and if it is, we don't override it.
-const esIndexLocaleEnvVarExists = "WEBINY_ELASTICSEARCH_INDEX_LOCALE" in process.env;
-if (!esIndexLocaleEnvVarExists) {
-    process.env.WEBINY_ELASTICSEARCH_INDEX_LOCALE = "true";
-}

package/utils/localStorage.js

@@ -1,44 +0,0 @@
-// This is a small class that enables us to store some useful
-// data into the .webiny folder, located in the project root.
-// For example, we are saving the path entered while creating
-// GraphQL services, so that the user doesn't have to type
-// the same paths over and over.
-const fs = require("fs");
-const path = require("path");
-const getProject = require("./getProject");
-
-module.exports = function (filename = "cli.json") {
-    const project = getProject();
-    const DOT_WEBINY = path.join(project.root, ".webiny");
-    const dataFilePath = path.join(DOT_WEBINY, filename);
-
-    let data = {};
-    if (fs.existsSync(dataFilePath)) {
-        try {
-            data = JSON.parse(fs.readFileSync(dataFilePath));
-        } catch (e) {
-            throw new Error(
-                `Could not parse Webiny CLI's locale storage data file located at ${dataFilePath}.`
-            );
-        }
-    }
-
-    return {
-        set(key, value) {
-            data[key] = value;
-
-            if (!fs.existsSync(DOT_WEBINY)) {
-                fs.mkdirSync(DOT_WEBINY);
-            }
-
-            fs.writeFileSync(dataFilePath, JSON.stringify(data));
-            return data;
-        },
-        get(key) {
-            if (!key) {
-                return data;
-            }
-            return data[key];
-        }
-    };
-};