@plasmicapp/cli 0.1.292 → 0.1.294

package/dist/actions/localization-strings.d.ts

@@ -8,5 +8,6 @@ export interface LocalizationStringsArgs extends CommonArgs {
     forceOverwrite: boolean;
     keyScheme: "content" | "hash" | "path" | undefined;
     tagPrefix: string | undefined;
+    excludeDeps: boolean | undefined;
 }
 export declare function localizationStrings(opts: LocalizationStringsArgs): Promise<void>;

package/dist/actions/localization-strings.js

@@ -26,12 +26,36 @@ const user_utils_1 = require("../utils/user-utils");
 function localizationStrings(opts) {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
-        if (!opts.projects || opts.projects.length === 0) {
+        if (!opts.baseDir) {
+            opts.baseDir = process.cwd();
+        }
+        const maybeConfigFile = opts.config || config_utils_1.findConfigFile(opts.baseDir, { traverseParents: true });
+        let projectSpecs = opts.projects;
+        let keyScheme = opts.keyScheme;
+        let tagPrefix = opts.tagPrefix;
+        const projectTokensFromConfig = [];
+        if (maybeConfigFile) {
+            // if plasmic.json exists, then we can derive some settings from
+            // there instead.
+            deps_1.logger.info(`Using settings from ${maybeConfigFile}...`);
+            const context = yield get_context_1.getContext(opts, { enableSkipAuth: true });
+            context.config.projects.forEach((p) => {
+                projectTokensFromConfig.push(lodash_1.pick(p, "projectId", "projectApiToken"));
+            });
+            if (!projectSpecs || projectSpecs.length === 0) {
+                projectSpecs = context.config.projects.map((p) => p.projectId + (p.version === "latest" ? "" : `@${p.version}`));
+            }
+            if (!keyScheme) {
+                keyScheme = (_a = context.config.i18n) === null || _a === void 0 ? void 0 : _a.keyScheme;
+            }
+            if (!tagPrefix) {
+                tagPrefix = (_b = context.config.i18n) === null || _b === void 0 ? void 0 : _b.tagPrefix;
+            }
+        }
+        if (!projectSpecs || projectSpecs.length === 0) {
             throw new lib_1.HandledError(`Missing projects.`);
         }
-        if (!opts.baseDir)
-            opts.baseDir = process.cwd();
-        const parsedProjectTokens = ((_a = opts.projectTokens) !== null && _a !== void 0 ? _a : []).map((val) => {
+        const parsedProjectTokens = ((_c = opts.projectTokens) !== null && _c !== void 0 ? _c : []).map((val) => {
             const [projectId, projectApiToken] = val.split(":");
             if (!projectId || !projectApiToken) {
                 throw new Error(`Invalid value passed to '--project-tokens': ${val}\nPlease provide the API tokens with the format PROJECT_ID:PROJECT_API_TOKEN`);
@@ -46,23 +70,7 @@ function localizationStrings(opts) {
                 ? "data.po"
                 : "data.json"
             : opts.output;
-        let keyScheme = opts.keyScheme;
-        let tagPrefix = opts.tagPrefix;
-        const projectTokensFromConfig = [];
         const auth = yield auth_utils_1.getCurrentAuth(opts.auth);
-        const maybeConfigFile = opts.config || config_utils_1.findConfigFile(opts.baseDir, { traverseParents: true });
-        if (maybeConfigFile) {
-            const context = yield get_context_1.getContext(opts, { enableSkipAuth: true });
-            context.config.projects.forEach((p) => {
-                projectTokensFromConfig.push(lodash_1.pick(p, "projectId", "projectApiToken"));
-            });
-            if (!keyScheme) {
-                keyScheme = (_b = context.config.i18n) === null || _b === void 0 ? void 0 : _b.keyScheme;
-            }
-            if (!tagPrefix) {
-                tagPrefix = (_c = context.config.i18n) === null || _c === void 0 ? void 0 : _c.tagPrefix;
-            }
-        }
         const projectIdsAndTokens = [
             ...parsedProjectTokens,
             ...projectTokensFromConfig,
@@ -73,8 +81,8 @@ function localizationStrings(opts) {
                 user: "",
                 token: "",
             });
-            deps_1.logger.info(`Generating localization strings for ${chalk_1.default.bold(opts.projects.join(", "))}...`);
-            const data = yield api.genLocalizationStrings(opts.projects, opts.format, keyScheme !== null && keyScheme !== void 0 ? keyScheme : "content", tagPrefix, projectIdsAndTokens);
+            deps_1.logger.info(`Generating localization strings for ${chalk_1.default.bold(projectSpecs.join(", "))}...`);
+            const data = yield api.genLocalizationStrings(projectSpecs, opts.format, keyScheme !== null && keyScheme !== void 0 ? keyScheme : "content", tagPrefix, projectIdsAndTokens, opts.excludeDeps);
             if (file_utils_1.existsBuffered(output)) {
                 const overwrite = yield user_utils_1.confirmWithUser(`File ${output} already exists. Do you want to overwrite?`, opts.forceOverwrite);
                 if (!overwrite) {

package/dist/api.d.ts

@@ -200,7 +200,7 @@ export declare class PlasmicApi {
         metadata?: Metadata;
     }): Promise<ProjectBundle>;
     projectMeta(projectId: string): Promise<ProjectMetaInfo>;
-    genLocalizationStrings(projects: readonly string[], format: "po" | "json" | "lingui", keyScheme: "content" | "hash" | "path", tagPrefix: string | undefined, projectIdsAndTokens: ProjectIdAndToken[]): Promise<string>;
+    genLocalizationStrings(projects: readonly string[], format: "po" | "json" | "lingui", keyScheme: "content" | "hash" | "path", tagPrefix: string | undefined, projectIdsAndTokens: ProjectIdAndToken[], excludeDeps: boolean | undefined): Promise<string>;
     uploadBundle(projectId: string, bundleName: string, bundleJs: string, css: string[], metaJson: string, genModulePath: string | undefined, genCssPaths: string[], pkgVersion: string | undefined, extraPropMetaJson: string | undefined, themeProviderWrapper: string | undefined, themeModule: string | undefined): Promise<StyleTokensMap>;
     projectStyleTokens(projectId: string, branchName: string, versionRange?: string): Promise<StyleTokensMap>;
     projectIcons(projectId: string, branchName: string, versionRange?: string, iconIds?: string[]): Promise<ProjectIconsResponse>;

package/dist/api.js

@@ -99,11 +99,17 @@ class PlasmicApi {
             return result.data;
         });
     }
-    genLocalizationStrings(projects, format, keyScheme, tagPrefix, projectIdsAndTokens) {
+    genLocalizationStrings(projects, format, keyScheme, tagPrefix, projectIdsAndTokens, excludeDeps) {
         return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this.get(`${this.codegenHost}/api/v1/localization/gen-texts?format=${format}&keyScheme=${keyScheme}&tagPrefix=${tagPrefix}&preview=true&${projects
-                .map((p) => `projectId=${p}`)
-                .join("&")}`, undefined, {
+            const params = new URLSearchParams([
+                ["format", format],
+                ["keyScheme", keyScheme],
+                ["preview", "true"],
+                ...projects.map((p) => ["projectId", p]),
+                tagPrefix ? ["tagPrefix", tagPrefix] : undefined,
+                excludeDeps ? ["excludeDeps", "true"] : undefined,
+            ].filter((x) => !!x));
+            const result = yield this.get(`${this.codegenHost}/api/v1/localization/gen-texts?${params.toString()}`, undefined, {
                 "x-plasmic-api-project-tokens": projectIdsAndTokens
                     .map(({ projectId, projectApiToken }) => `${projectId}:${projectApiToken}`)
                     .join(","),

package/dist/index.js

@@ -190,7 +190,7 @@ yargs_1.default
     .command("localization-strings", false, (yargs) => yargs
     .option("projects", {
     alias: "p",
-    describe: "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version",
+    describe: "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version. If not specified, will be derived from plasmic.json if you are using codegen.",
     type: "array",
 })
     .option("host", {
@@ -212,6 +212,11 @@ yargs_1.default
     .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("exclude-deps", {
+    type: "boolean",
+    describe: "By default, strings from imported dependencies are also included. Specify --exclude-deps to only include strings from projects you explicitly specify.",
+    default: false,
 })
     .option("output", {
     alias: "o",

package/dist/plasmic.schema.json

@@ -182,10 +182,11 @@
         "I18NConfig": {
             "properties": {
                 "keyScheme": {
-                    "description": "For localization, whether the extracted strings are keyed by its content\nor by a hash of its content",
+                    "description": "For localization, whether the extracted strings are keyed by its content,\nor by a hash of its content, or by where the string is found (\"path\")",
                     "enum": [
                         "content",
-                        "hash"
+                        "hash",
+                        "path"
                     ],
                     "type": "string"
                 },

package/dist/utils/config-utils.d.ts

@@ -250,10 +250,10 @@ export interface ProjectLock {
 }
 export interface I18NConfig {
     /**
-     * For localization, whether the extracted strings are keyed by its content
-     * or by a hash of its content
+     * For localization, whether the extracted strings are keyed by its content,
+     * or by a hash of its content, or by where the string is found ("path")
      */
-    keyScheme: "content" | "hash";
+    keyScheme: "content" | "hash" | "path";
     /**
      * For localization, rich text with embedded tags are exported as
      * "Hello <0>there</0>, I am <1>here</1>".  Some frameworks, like

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.292",
+  "version": "0.1.294",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -80,5 +80,5 @@
     "wrap-ansi": "^7.0.0",
     "yargs": "^15.4.1"
   },
-  "gitHead": "b416c3aff370f8f8b0c884e3700bd8fe61ad3e2b"
+  "gitHead": "ff42d1b747943bedcc21cb39f8ffb92d38347292"
 }

package/src/actions/localization-strings.ts

@@ -19,15 +19,46 @@ export interface LocalizationStringsArgs extends CommonArgs {
   forceOverwrite: boolean;
   keyScheme: "content" | "hash" | "path" | undefined;
   tagPrefix: string | undefined;
+  excludeDeps: boolean | undefined;
 }
 
 export async function localizationStrings(
   opts: LocalizationStringsArgs
 ): Promise<void> {
-  if (!opts.projects || opts.projects.length === 0) {
+  if (!opts.baseDir) {
+    opts.baseDir = process.cwd();
+  }
+
+  const maybeConfigFile =
+    opts.config || findConfigFile(opts.baseDir, { traverseParents: true });
+
+  let projectSpecs = opts.projects;
+  let keyScheme = opts.keyScheme;
+  let tagPrefix = opts.tagPrefix;
+  const projectTokensFromConfig: ProjectIdAndToken[] = [];
+  if (maybeConfigFile) {
+    // if plasmic.json exists, then we can derive some settings from
+    // there instead.
+    logger.info(`Using settings from ${maybeConfigFile}...`);
+    const context = await getContext(opts, { enableSkipAuth: true });
+    context.config.projects.forEach((p) => {
+      projectTokensFromConfig.push(pick(p, "projectId", "projectApiToken"));
+    });
+    if (!projectSpecs || projectSpecs.length === 0) {
+      projectSpecs = context.config.projects.map(
+        (p) => p.projectId + (p.version === "latest" ? "" : `@${p.version}`)
+      );
+    }
+    if (!keyScheme) {
+      keyScheme = context.config.i18n?.keyScheme;
+    }
+    if (!tagPrefix) {
+      tagPrefix = context.config.i18n?.tagPrefix;
+    }
+  }
+  if (!projectSpecs || projectSpecs.length === 0) {
     throw new HandledError(`Missing projects.`);
   }
-  if (!opts.baseDir) opts.baseDir = process.cwd();
   const parsedProjectTokens: ProjectIdAndToken[] = (
     opts.projectTokens ?? []
   ).map((val) => {
@@ -47,24 +78,7 @@ export async function localizationStrings(
       ? "data.po"
       : "data.json"
     : opts.output;
-  let keyScheme = opts.keyScheme;
-  let tagPrefix = opts.tagPrefix;
-  const projectTokensFromConfig: ProjectIdAndToken[] = [];
   const auth = await getCurrentAuth(opts.auth);
-  const maybeConfigFile =
-    opts.config || findConfigFile(opts.baseDir, { traverseParents: true });
-  if (maybeConfigFile) {
-    const context = await getContext(opts, { enableSkipAuth: true });
-    context.config.projects.forEach((p) => {
-      projectTokensFromConfig.push(pick(p, "projectId", "projectApiToken"));
-    });
-    if (!keyScheme) {
-      keyScheme = context.config.i18n?.keyScheme;
-    }
-    if (!tagPrefix) {
-      tagPrefix = context.config.i18n?.tagPrefix;
-    }
-  }
 
   const projectIdsAndTokens = [
     ...parsedProjectTokens,
@@ -81,15 +95,16 @@ export async function localizationStrings(
     );
     logger.info(
       `Generating localization strings for ${chalk.bold(
-        opts.projects.join(", ")
+        projectSpecs.join(", ")
       )}...`
     );
     const data = await api.genLocalizationStrings(
-      opts.projects,
+      projectSpecs,
       opts.format,
       keyScheme ?? "content",
       tagPrefix,
-      projectIdsAndTokens
+      projectIdsAndTokens,
+      opts.excludeDeps
     );
     if (existsBuffered(output)) {
       const overwrite = await confirmWithUser(

package/src/api.ts

@@ -304,14 +304,21 @@ export class PlasmicApi {
     format: "po" | "json" | "lingui",
     keyScheme: "content" | "hash" | "path",
     tagPrefix: string | undefined,
-    projectIdsAndTokens: ProjectIdAndToken[]
+    projectIdsAndTokens: ProjectIdAndToken[],
+    excludeDeps: boolean | undefined
   ) {
+    const params = new URLSearchParams(
+      [
+        ["format", format],
+        ["keyScheme", keyScheme],
+        ["preview", "true"],
+        ...projects.map((p) => ["projectId", p]),
+        tagPrefix ? ["tagPrefix", tagPrefix] : undefined,
+        excludeDeps ? ["excludeDeps", "true"] : undefined,
+      ].filter((x): x is [string, string] => !!x)
+    );
     const result = await this.get(
-      `${
-        this.codegenHost
-      }/api/v1/localization/gen-texts?format=${format}&keyScheme=${keyScheme}&tagPrefix=${tagPrefix}&preview=true&${projects
-        .map((p) => `projectId=${p}`)
-        .join("&")}`,
+      `${this.codegenHost}/api/v1/localization/gen-texts?${params.toString()}`,
       undefined,
       {
         "x-plasmic-api-project-tokens": projectIdsAndTokens

package/src/index.ts

@@ -238,7 +238,7 @@ yargs
         .option("projects", {
           alias: "p",
           describe:
-            "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version",
+            "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version. If not specified, will be derived from plasmic.json if you are using codegen.",
           type: "array",
         })
         .option("host", {
@@ -263,6 +263,12 @@ yargs
             "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("exclude-deps", {
+          type: "boolean",
+          describe:
+            "By default, strings from imported dependencies are also included. Specify --exclude-deps to only include strings from projects you explicitly specify.",
+          default: false,
+        })
         .option("output", {
           alias: "o",
           describe: "Output file",

package/src/utils/config-utils.ts

@@ -351,10 +351,10 @@ export interface ProjectLock {
 
 export interface I18NConfig {
   /**
-   * For localization, whether the extracted strings are keyed by its content
-   * or by a hash of its content
+   * For localization, whether the extracted strings are keyed by its content,
+   * or by a hash of its content, or by where the string is found ("path")
    */
-  keyScheme: "content" | "hash";
+  keyScheme: "content" | "hash" | "path";
   /**
    * For localization, rich text with embedded tags are exported as
    * "Hello <0>there</0>, I am <1>here</1>".  Some frameworks, like