@plasmicapp/cli 0.1.291 → 0.1.293

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

@@ -6,6 +6,8 @@ export interface LocalizationStringsArgs extends CommonArgs {
     format: "po" | "json" | "lingui";
     output: string;
     forceOverwrite: boolean;
-    keyScheme: "content" | "hash" | undefined;
+    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

@@ -24,7 +24,7 @@ const file_utils_1 = require("../utils/file-utils");
 const get_context_1 = require("../utils/get-context");
 const user_utils_1 = require("../utils/user-utils");
 function localizationStrings(opts) {
-    var _a, _b;
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         if (!opts.projects || opts.projects.length === 0) {
             throw new lib_1.HandledError(`Missing projects.`);
@@ -47,6 +47,7 @@ function localizationStrings(opts) {
                 : "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 });
@@ -58,6 +59,9 @@ function localizationStrings(opts) {
             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,
@@ -70,7 +74,7 @@ function localizationStrings(opts) {
                 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", projectIdsAndTokens);
+            const data = yield api.genLocalizationStrings(opts.projects, 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", 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, 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}&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

@@ -205,9 +205,18 @@ yargs_1.default
     default: "json",
 })
     .option("key-scheme", {
-    describe: "What value to use as message keys; either the message content itself, or a hash of it. Defaults to whatever is specified in plasmic.json, or `content`",
+    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"],
+    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("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

@@ -188,6 +188,10 @@
                         "hash"
                     ],
                     "type": "string"
+                },
+                "tagPrefix": {
+                    "description": "For localization, rich text with embedded tags are exported as\n\"Hello <0>there</0>, I am <1>here</1>\".  Some frameworks, like\nreact-intl, doesn't work with numbers as tag names, so you can\nspecify a prefix. For example, a tagPrefix of \"n\" turns the above\ninto \"Hello <n0>there</n0>, I am <n1>here</n1>\".",
+                    "type": "string"
                 }
             },
             "required": [

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

@@ -254,6 +254,14 @@ export interface I18NConfig {
      * or by a hash of its content
      */
     keyScheme: "content" | "hash";
+    /**
+     * For localization, rich text with embedded tags are exported as
+     * "Hello <0>there</0>, I am <1>here</1>".  Some frameworks, like
+     * react-intl, doesn't work with numbers as tag names, so you can
+     * specify a prefix. For example, a tagPrefix of "n" turns the above
+     * into "Hello <n0>there</n0>, I am <n1>here</n1>".
+     */
+    tagPrefix?: string;
 }
 export interface PlasmicLock {
     projects: ProjectLock[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.291",
+  "version": "0.1.293",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -20,7 +20,6 @@
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.12.1",
-    "@plasmicapp/react-web": "0.2.224",
     "@types/cli-progress": "^3.11.0",
     "@types/findup-sync": "^2.0.2",
     "@types/glob": "^7.1.3",
@@ -81,5 +80,5 @@
     "wrap-ansi": "^7.0.0",
     "yargs": "^15.4.1"
   },
-  "gitHead": "596857aecc29c48046f82c0de3e913063322e8ec"
+  "gitHead": "44f8c8ab413dee1f09112df30df9bdf323ac5214"
 }

package/src/actions/localization-strings.ts

@@ -17,7 +17,9 @@ export interface LocalizationStringsArgs extends CommonArgs {
   format: "po" | "json" | "lingui";
   output: string;
   forceOverwrite: boolean;
-  keyScheme: "content" | "hash" | undefined;
+  keyScheme: "content" | "hash" | "path" | undefined;
+  tagPrefix: string | undefined;
+  excludeDeps: boolean | undefined;
 }
 
 export async function localizationStrings(
@@ -47,6 +49,7 @@ export async function localizationStrings(
       : "data.json"
     : opts.output;
   let keyScheme = opts.keyScheme;
+  let tagPrefix = opts.tagPrefix;
   const projectTokensFromConfig: ProjectIdAndToken[] = [];
   const auth = await getCurrentAuth(opts.auth);
   const maybeConfigFile =
@@ -59,6 +62,9 @@ export async function localizationStrings(
     if (!keyScheme) {
       keyScheme = context.config.i18n?.keyScheme;
     }
+    if (!tagPrefix) {
+      tagPrefix = context.config.i18n?.tagPrefix;
+    }
   }
 
   const projectIdsAndTokens = [
@@ -83,7 +89,9 @@ export async function localizationStrings(
       opts.projects,
       opts.format,
       keyScheme ?? "content",
-      projectIdsAndTokens
+      tagPrefix,
+      projectIdsAndTokens,
+      opts.excludeDeps
     );
     if (existsBuffered(output)) {
       const overwrite = await confirmWithUser(

package/src/api.ts

@@ -302,15 +302,23 @@ export class PlasmicApi {
   async genLocalizationStrings(
     projects: readonly string[],
     format: "po" | "json" | "lingui",
-    keyScheme: "content" | "hash",
-    projectIdsAndTokens: ProjectIdAndToken[]
+    keyScheme: "content" | "hash" | "path",
+    tagPrefix: string | undefined,
+    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}&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

@@ -254,9 +254,20 @@ yargs
         })
         .option("key-scheme", {
           describe:
-            "What value to use as message keys; either the message content itself, or a hash of it. Defaults to whatever is specified in plasmic.json, or `content`",
+            "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"],
+          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("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/src/utils/config-utils.ts

@@ -355,6 +355,14 @@ export interface I18NConfig {
    * or by a hash of its content
    */
   keyScheme: "content" | "hash";
+  /**
+   * For localization, rich text with embedded tags are exported as
+   * "Hello <0>there</0>, I am <1>here</1>".  Some frameworks, like
+   * react-intl, doesn't work with numbers as tag names, so you can
+   * specify a prefix. For example, a tagPrefix of "n" turns the above
+   * into "Hello <n0>there</n0>, I am <n1>here</n1>".
+   */
+  tagPrefix?: string;
 }
 
 export interface PlasmicLock {