@plasmicapp/cli 0.1.304 → 0.1.306

package/src/actions/sync.ts

@@ -22,9 +22,7 @@ import {
 } from "../utils/code-utils";
 import {
   CONFIG_FILE_NAME,
-  LOADER_CONFIG_FILE_NAME,
   PlasmicContext,
-  PlasmicLoaderConfig,
   createProjectConfig,
   getOrAddProjectConfig,
   getOrAddProjectLock,
@@ -73,7 +71,6 @@ export interface SyncArgs extends CommonArgs {
   quiet?: boolean;
   metadata?: string;
   allFiles?: boolean;
-  loaderConfig?: string;
   skipFormatting?: boolean;
   skipBuffering?: boolean;
 }
@@ -159,30 +156,6 @@ async function ensureRequiredPackages(
   }
 }
 
-function getLoaderConfigPath(opts: SyncArgs) {
-  return opts.loaderConfig || LOADER_CONFIG_FILE_NAME;
-}
-
-function maybeReadLoaderConfig(opts: SyncArgs): Partial<PlasmicLoaderConfig> {
-  const path = getLoaderConfigPath(opts);
-  if (!existsBuffered(path)) {
-    return {};
-  }
-  return JSON.parse(readFileText(path!));
-}
-
-function writeLoaderConfig(
-  opts: SyncArgs,
-  config: Partial<PlasmicLoaderConfig>
-) {
-  const loaderConfigPath = getLoaderConfigPath(opts);
-
-  writeFileText(
-    loaderConfigPath,
-    formatAsLocal(JSON.stringify(config), loaderConfigPath, opts.baseDir)
-  );
-}
-
 /**
  * Sync will always try to sync down a set of components that are version-consistent among specified projects.
  * (we only allow 1 version per projectId).
@@ -214,12 +187,8 @@ export async function sync(
   fixFileExtension(context);
   assertAllPathsInRootDir(context);
 
-  const loaderConfig: Partial<PlasmicLoaderConfig> = process.env.PLASMIC_LOADER
-    ? maybeReadLoaderConfig(opts)
-    : {};
-
   const projectIdToToken = new Map(
-    [...context.config.projects, ...(loaderConfig?.projects ?? [])]
+    [...context.config.projects]
       .filter((p) => p.projectApiToken)
       .map((p) => tuple(p.projectId, p.projectApiToken))
   );
@@ -265,9 +234,7 @@ export async function sync(
       context = await getContext(opts);
     } catch (e) {
       if ((e as any).message.includes("Unable to authenticate Plasmic")) {
-        const configFileName = process.env.PLASMIC_LOADER
-          ? LOADER_CONFIG_FILE_NAME
-          : CONFIG_FILE_NAME;
+        const configFileName = CONFIG_FILE_NAME;
         throw new HandledError(
           `Unable to authenticate Plasmic. Please run 'plasmic auth' or check the projectApiTokens in your ${configFileName}, and try again.`
         );
@@ -376,26 +343,6 @@ export async function sync(
     // Now we know config.components are all correct, so we can go ahead and fix up all the import statements
     await fixAllImportStatements(context, opts.baseDir, summary);
 
-    if (process.env.PLASMIC_LOADER) {
-      const rootProjectIds = new Set(projectSyncParams.map((p) => p.projectId));
-      const freshIdsAndTokens = projectIdsAndTokens
-        .filter((p) => rootProjectIds.has(p.projectId))
-        .map((p) => L.pick(p, "projectId", "projectApiToken"));
-
-      const config: Partial<PlasmicLoaderConfig> = {
-        ...loaderConfig,
-        projects: L.sortBy(
-          L.uniqBy(
-            [...freshIdsAndTokens, ...(loaderConfig?.projects ?? [])],
-            (p) => p.projectId
-          ),
-          (p) => p.projectId
-        ),
-      };
-
-      writeLoaderConfig(opts, config);
-    }
-
     const codegenVersion = await context.api.latestCodegenVersion();
     context.lock.projects.forEach((p) => {
       if (

package/src/api.ts

@@ -26,7 +26,7 @@ export interface ComponentBundle {
   cssFileName: string;
   componentName: string;
   id: string;
-  scheme: string;
+  scheme: "blackbox" | "plain";
   nameInIdToUuid: Array<[string, string]>;
   isPage: boolean;
   plumeType?: string;
@@ -291,6 +291,39 @@ export class PlasmicApi {
     );
     return result.data as ProjectBundle;
   }
+  /**
+   * Code-gen endpoint.
+   * This will fetch components from a given branch at an exact specified version
+   * using the "plain" scheme
+   */
+  async exportProject(
+    projectId: string,
+    branchName: string,
+    opts: {
+      platform: string;
+      platformOptions: {
+        nextjs?: {
+          appDir: boolean;
+        };
+      };
+      version: string;
+      imageOpts: ImagesConfig;
+      stylesOpts: StyleConfig;
+      i18nOpts?: I18NConfig;
+      codeOpts: Pick<CodeConfig, "lang">;
+      indirect: boolean;
+      wrapPagesWithGlobalContexts: boolean;
+      metadata?: Metadata;
+    }
+  ): Promise<ProjectBundle> {
+    const result = await this.post(
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/components?branchName=${branchName}&export=true`,
+      {
+        ...opts,
+      }
+    );
+    return result.data as ProjectBundle;
+  }
 
   async projectMeta(projectId: string) {
     const result = await this.post(

package/src/index.ts

@@ -5,6 +5,7 @@ import { fixImports, FixImportsArgs } from "./actions/fix-imports";
 import { InfoArgs, printProjectInfo } from "./actions/info";
 import { getYargsOption, InitArgs, initPlasmic } from "./actions/init";
 import {
+  getLocalizationYargs,
   localizationStrings,
   LocalizationStringsArgs,
 } from "./actions/localization-strings";
@@ -12,8 +13,8 @@ import * as projectToken from "./actions/project-token";
 import { sync, SyncArgs } from "./actions/sync";
 import { UploadBundleArgs, uploadJsBundle } from "./actions/upload-bundle";
 import { WatchArgs, watchProjects } from "./actions/watch";
-import { LOADER_CONFIG_FILE_NAME } from "./utils/config-utils";
 import { handleError } from "./utils/error";
+import { ExportArgs, exportProjectsCli } from "./actions/export";
 
 if (process.env.DEBUG_CHDIR) {
   process.chdir(process.env.DEBUG_CHDIR);
@@ -248,7 +249,7 @@ yargs
   )
   .command<LocalizationStringsArgs>(
     "localization-strings",
-    false,
+    "Generate localization strings",
     (yargs) =>
       yargs
         .option("projects", {
@@ -268,17 +269,8 @@ yargs
           choices: ["json", "po", "lingui"],
           default: "json",
         })
-        .option("key-scheme", {
-          describe:
-            "What value to use as message keys; `content` uses the message content itself, `hash` uses a hash of the content, and `path` uses a a hierarchical string containing the project id, component name, element name, and related variants, and does not encode the text content in the key.  Defaults to whatever is specified in plasmic.json, or `content`",
-          type: "string",
-          choices: ["content", "hash", "path"],
-        })
-        .option("tag-prefix", {
-          describe:
-            "By default, rich text with markup tags look like '<0>hello</0>'. If your localization framework requires num-numeric tags, then specify a prefix; for example a prefix of 'n' turns it into '<n0>hello</n0>'.",
-          type: "string",
-        })
+        .option("key-scheme", getLocalizationYargs("key-scheme"))
+        .option("tag-prefix", getLocalizationYargs("tag-prefix"))
         .option("exclude-deps", {
           type: "boolean",
           describe:
@@ -303,6 +295,35 @@ yargs
         }),
     (argv) => handleError(localizationStrings(argv))
   )
+  .command<ExportArgs>(
+    "export",
+    false,
+    (yargs) =>
+      yargs
+        .option("projects", {
+          alias: "p",
+          describe: "ID of project to export from",
+          type: "array",
+        })
+        .option("out-dir", {
+          alias: "o",
+          describe: "Folder to output exported code to",
+          type: "string",
+        })
+        .option("platform", getYargsOption("platform"))
+        .option("code-lang", getYargsOption("codeLang"))
+        .option("code-scheme", getYargsOption("codeScheme"))
+        .option("style-scheme", getYargsOption("styleScheme"))
+        .option("images-scheme", getYargsOption("imagesScheme"))
+        .option("images-public-dir", getYargsOption("imagesPublicDir"))
+        .option(
+          "images-public-url-prefix",
+          getYargsOption("imagesPublicUrlPrefix")
+        )
+        .option("i18n-key-scheme", getLocalizationYargs("key-scheme"))
+        .option("i18n-tag-prefix", getLocalizationYargs("tag-prefix")),
+    (argv) => handleError(exportProjectsCli(argv))
+  )
   .demandCommand()
   .strict()
   .help("h")
@@ -325,13 +346,6 @@ function configureSyncArgs(
       describe: "Force sync to bypass specified version ranges.",
       default: false,
     })
-    .option("loader-config", {
-      type: "string",
-      describe:
-        "Path to loader config file, and causes CLI to run in PlasmicLoader mode.",
-      hidden: true,
-      default: LOADER_CONFIG_FILE_NAME,
-    })
     .option("non-recursive", {
       type: "boolean",
       describe:

package/src/test-common/fixtures.ts

@@ -99,7 +99,6 @@ export function standardTestSetup(includeDep = true) {
     forceOverwrite: true,
     config: tmpRepo.plasmicJsonPath(),
     auth: tmpRepo.plasmicAuthPath(),
-    loaderConfig: tmpRepo.plasmicLoaderJsonPath(),
     baseDir: process.cwd(),
   };
 }
@@ -154,9 +153,9 @@ export const project1Config: ProjectConfig = {
   globalContextsFilePath: "",
 };
 
-export function expectProject1PlasmicJson(
-  optional?: { [k in keyof ProjectConfig]?: boolean }
-) {
+export function expectProject1PlasmicJson(optional?: {
+  [k in keyof ProjectConfig]?: boolean;
+}) {
   const plasmicJson = tmpRepo.readPlasmicJson();
   expect(plasmicJson.projects.length).toEqual(1);
   const projectConfig = plasmicJson.projects[0];

package/src/utils/config-utils.ts

@@ -18,7 +18,6 @@ export const DEFAULT_HOST =
 export const AUTH_FILE_NAME = ".plasmic.auth";
 export const CONFIG_FILE_NAME = "plasmic.json";
 export const LOCK_FILE_NAME = "plasmic.lock";
-export const LOADER_CONFIG_FILE_NAME = "plasmic-loader.json";
 export const CONFIG_SCHEMA_FILE_NAME = "plasmic.schema.json";
 
 // Default environment variable names
@@ -26,16 +25,6 @@ export const ENV_AUTH_HOST = "PLASMIC_AUTH_HOST";
 export const ENV_AUTH_USER = "PLASMIC_AUTH_USER";
 export const ENV_AUTH_TOKEN = "PLASMIC_AUTH_TOKEN";
 
-export interface PlasmicLoaderConfig {
-  projects: ProjectIdAndToken[];
-  aboutThisFile: string;
-  dir: string;
-  plasmicDir: string;
-  pageDir: string;
-  initArgs: Record<string, string>;
-  substitutions?: Record<string, any>;
-}
-
 export interface PlasmicConfig {
   /** Target platform to generate code for */
   platform: "react" | "nextjs" | "gatsby";

package/src/utils/error.ts

@@ -16,10 +16,10 @@ export class HandledError extends Error {}
  * @returns
  */
 export const handleError = <T>(p: Promise<T>) => {
-  return p.catch((e) => {
+  return p.catch((e: Error) => {
     if (e.message) {
       logger.error(
-        chalk.bold(chalk.redBright("\nPlasmic error: ")) + e.message
+        chalk.bold(chalk.redBright("\nPlasmic error: ")) + e.message + e.stack
       );
     }
     // Check if we satisfy the engine policy first

package/src/utils/file-utils.ts

@@ -135,6 +135,14 @@ export function eqPagePath(a: string, b: string) {
     return true;
   }
 
+  // We also let users rename [...page].js to [[...page]].js
+  const normPagePathBrackets = (p: string) => {
+    return p.replace("[[", "[").replace("]]", "]");
+  };
+  if (normPagePathBrackets(a) === normPagePathBrackets(b)) {
+    return true;
+  }
+
   // pages/about.* and pages/about/index.* resolve to the same URI, but
   // pages/index.* and pages/index/index.* do not.
   if (!a.endsWith("/index") && `${a}/index` === b) {

package/src/utils/get-context.ts

@@ -289,7 +289,12 @@ export async function getContext(
   {
     enableSkipAuth = false,
     skipMissingFiles = false,
-  }: { enableSkipAuth?: boolean; skipMissingFiles?: boolean } = {}
+    skipInit = false,
+  }: {
+    enableSkipAuth?: boolean;
+    skipMissingFiles?: boolean;
+    skipInit?: boolean;
+  } = {}
 ): Promise<PlasmicContext> {
   if (!args.baseDir) args.baseDir = process.cwd();
   const auth = enableSkipAuth
@@ -361,7 +366,7 @@ export async function getContext(
 /**
  * Use empty user/token to signify no auth (only returning to provide a default host).
  */
-async function getCurrentOrDefaultAuth(args: CommonArgs) {
+export async function getCurrentOrDefaultAuth(args: CommonArgs) {
   const auth = await getCurrentAuth(args.auth);
   if (auth) {
     return auth;

package/src/utils/test-utils.ts

@@ -5,9 +5,7 @@ import {
   AuthConfig,
   AUTH_FILE_NAME,
   CONFIG_FILE_NAME,
-  LOADER_CONFIG_FILE_NAME,
   PlasmicConfig,
-  PlasmicLoaderConfig,
 } from "../utils/config-utils";
 import { deleteFileBuffered, readFileText, writeFileText } from "./file-utils";
 
@@ -105,12 +103,4 @@ export class TempRepo {
   deletePlasmicJson() {
     this.deleteFile(CONFIG_FILE_NAME);
   }
-
-  plasmicLoaderJsonPath() {
-    return this.resolveFile(LOADER_CONFIG_FILE_NAME);
-  }
-
-  readPlasmicLoaderJson(): PlasmicLoaderConfig {
-    return JSON.parse(this.readFile(LOADER_CONFIG_FILE_NAME));
-  }
 }