@plasmicapp/cli 0.1.173 → 0.1.176

package/dist/actions/sync.js

@@ -50,11 +50,11 @@ const resolve_utils_1 = require("../utils/resolve-utils");
 const semver = __importStar(require("../utils/semver"));
 const user_utils_1 = require("../utils/user-utils");
 const sync_components_1 = require("./sync-components");
+const sync_global_contexts_1 = require("./sync-global-contexts");
 const sync_global_variants_1 = require("./sync-global-variants");
 const sync_icons_1 = require("./sync-icons");
 const sync_images_1 = require("./sync-images");
 const sync_styles_1 = require("./sync-styles");
-const sync_global_contexts_1 = require("./sync-global-contexts");
 function ensureRequiredPackages(context, baseDir, yes) {
     return __awaiter(this, void 0, void 0, function* () {
         const requireds = yield context.api.requiredPackages();
@@ -302,23 +302,33 @@ function checkExternalPkgs(context, baseDir, opts, pkgs) {
         }
     });
 }
-function maybeRenamePathExt(context, path, ext) {
+function maybeRenamePathExt(context, path, ext, opts) {
     if (!path) {
         return path;
     }
     const correctPath = `${file_utils_1.stripExtension(path, true)}${ext}`;
     if (path !== correctPath) {
-        file_utils_1.renameFile(context, path, correctPath);
+        try {
+            file_utils_1.renameFile(context, path, correctPath);
+        }
+        catch (e) {
+            if (!(opts === null || opts === void 0 ? void 0 : opts.continueOnFailure)) {
+                throw e;
+            }
+            else {
+                deps_1.logger.warn(e);
+            }
+        }
     }
     return correctPath;
 }
 function fixFileExtension(context) {
     const cssExt = context.config.style.scheme === "css-modules" ? ".module.css" : ".css";
-    context.config.style.defaultStyleCssFilePath = maybeRenamePathExt(context, context.config.style.defaultStyleCssFilePath, cssExt);
+    context.config.style.defaultStyleCssFilePath = maybeRenamePathExt(context, context.config.style.defaultStyleCssFilePath, cssExt, { continueOnFailure: true });
     context.config.projects.forEach((project) => {
-        project.cssFilePath = maybeRenamePathExt(context, project.cssFilePath, cssExt);
+        project.cssFilePath = maybeRenamePathExt(context, project.cssFilePath, cssExt, { continueOnFailure: true });
         project.components.forEach((component) => {
-            component.cssFilePath = maybeRenamePathExt(context, component.cssFilePath, cssExt);
+            component.cssFilePath = maybeRenamePathExt(context, component.cssFilePath, cssExt, { continueOnFailure: true });
         });
     });
 }
@@ -343,6 +353,7 @@ function syncProject(context, opts, projectIdsAndTokens, projectId, componentIds
             codeOpts: context.config.code,
             metadata: get_context_1.generateMetadata(Object.assign(Object.assign({}, metadataDefaults), { platform: context.config.platform }), opts.metadata),
             indirect,
+            wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
         });
         // Convert from TSX => JSX
         if (context.config.code.lang === "js") {

package/dist/api.d.ts

@@ -184,6 +184,7 @@ export declare class PlasmicApi {
         codeOpts: CodeConfig;
         checksums: ChecksumBundle;
         indirect: boolean;
+        wrapPagesWithGlobalContexts: boolean;
         metadata?: Metadata;
     }): Promise<ProjectBundle>;
     projectMeta(projectId: string): Promise<ProjectMetaInfo>;

package/dist/plasmic.schema.json

@@ -458,6 +458,10 @@
         "tokens": {
             "$ref": "#/definitions/TokensConfig",
             "description": "Config for style tokens"
+        },
+        "wrapPagesWithGlobalContexts": {
+            "description": "Wether we should wrap the pages with the project global contexts or not",
+            "type": "boolean"
         }
     },
     "required": [
@@ -469,7 +473,8 @@
         "projects",
         "srcDir",
         "style",
-        "tokens"
+        "tokens",
+        "wrapPagesWithGlobalContexts"
     ],
     "type": "object"
 }

package/dist/test-common/fixtures.js

@@ -32,6 +32,7 @@ exports.defaultPlasmicJson = {
     globalVariants: {
         variantGroups: [],
     },
+    wrapPagesWithGlobalContexts: true,
     cliVersion: "0.1.44",
 };
 function standardTestSetup(includeDep = true) {

package/dist/utils/code-utils.js

@@ -125,7 +125,7 @@ function tryParsePlasmicImportSpec(node) {
     if (!c) {
         return undefined;
     }
-    const m = c.value.match(/plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent))?/);
+    const m = c.value.match(/plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext))?/);
     if (m) {
         return { id: m[1], type: m[2] };
     }
@@ -262,6 +262,14 @@ function replaceImports(context, code, fromPath, fixImportContext, removeImportD
                 stmt.source.value = meta.componentImportPath;
             }
         }
+        else if (type === "globalContext") {
+            const projectConfig = fixImportContext.projects[uuid];
+            if (!projectConfig) {
+                throwMissingReference(context, "project", uuid, fromPath);
+            }
+            const realPath = makeImportPath(context, fromPath, projectConfig.globalContextsFilePath, true);
+            stmt.source.value = realPath;
+        }
     });
     if (!changed) {
         return code;
@@ -297,8 +305,10 @@ function makeImportPath(context, fromPath, toPath, stripExt, forceRelative = fal
  * a local file
  */
 function isLocalModulePath(modulePath) {
-    // It is a local file reference if the importPath includes the file extension
-    return !!upath_1.default.extname(modulePath);
+    // It is a local file reference if the importPath includes the file extension, and
+    // modulePath doesn't start with "@" (like an alias by convention, or scoped npm
+    // package). This is not a reliable way to detect scoped npm package, but :shrug:
+    return !!upath_1.default.extname(modulePath) && !modulePath.startsWith("@");
 }
 exports.isLocalModulePath = isLocalModulePath;
 exports.mkFixImportContext = (config) => {

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

@@ -56,6 +56,8 @@ export interface PlasmicConfig {
     globalVariants: GlobalVariantsConfig;
     /** Metadata for each project that has been synced */
     projects: ProjectConfig[];
+    /** Wether we should wrap the pages with the project global contexts or not */
+    wrapPagesWithGlobalContexts: boolean;
     /** The version of cli when this file was written */
     cliVersion?: string;
     /** Arbitrary command to run after `plasmic sync` has run; useful for linting and code formatting synced files */

package/dist/utils/config-utils.js

@@ -70,6 +70,7 @@ exports.DEFAULT_CONFIG = {
     globalVariants: {
         variantGroups: [],
     },
+    wrapPagesWithGlobalContexts: true,
 };
 exports.DEFAULT_PUBLIC_FILES_CONFIG = {
     scheme: "public-files",

package/dist/utils/get-context.js

@@ -104,6 +104,14 @@ function removeMissingFilesFromLock(context, config, lock) {
         return project;
     });
 }
+/**
+ *
+ * @param context
+ * @param expectedPath
+ * @param baseNameToFiles
+ * @returns The path if we are able to find the file, undefined if we need to recreate it
+ * @throws if the user interrupts flow
+ */
 function attemptToRestoreFilePath(context, expectedPath, baseNameToFiles) {
     return __awaiter(this, void 0, void 0, function* () {
         // If the path is not set, always recreate.
@@ -163,16 +171,19 @@ function resolveMissingFilesInConfig(context, config) {
             });
         }
         context.config.globalVariants.variantGroups = yield filterFiles(context.config.globalVariants.variantGroups, "contextFilePath");
+        // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
         context.config.style.defaultStyleCssFilePath =
-            (yield attemptToRestoreFilePath(context, context.config.style.defaultStyleCssFilePath, baseNameToFiles)) || "";
+            (yield attemptToRestoreFilePath(context, context.config.style.defaultStyleCssFilePath, baseNameToFiles)) || context.config.style.defaultStyleCssFilePath;
+        // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
         for (const project of config.projects) {
             project.cssFilePath =
-                (yield attemptToRestoreFilePath(context, project.cssFilePath, baseNameToFiles)) || "";
+                (yield attemptToRestoreFilePath(context, project.cssFilePath, baseNameToFiles)) || project.cssFilePath;
             if (!project.globalContextsFilePath) {
                 project.globalContextsFilePath = "";
             }
+            // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
             project.globalContextsFilePath =
-                (yield attemptToRestoreFilePath(context, project.globalContextsFilePath, baseNameToFiles)) || "";
+                (yield attemptToRestoreFilePath(context, project.globalContextsFilePath, baseNameToFiles)) || project.globalContextsFilePath;
             project.images = yield filterFiles(project.images, "filePath");
             project.icons = yield filterFiles(project.icons, "moduleFilePath");
             project.jsBundleThemes = yield filterFiles(project.jsBundleThemes || [], "themeFilePath");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.173",
+  "version": "0.1.176",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"

package/src/actions/sync.ts

@@ -60,11 +60,11 @@ import {
   ComponentPendingMerge,
   syncProjectComponents,
 } from "./sync-components";
+import { syncGlobalContexts } from "./sync-global-contexts";
 import { syncGlobalVariants } from "./sync-global-variants";
 import { syncProjectIconAssets } from "./sync-icons";
 import { syncProjectImageAssets } from "./sync-images";
 import { upsertStyleTokens } from "./sync-styles";
-import { syncGlobalContexts } from "./sync-global-contexts";
 
 export interface SyncArgs extends CommonArgs {
   projects: readonly string[];
@@ -488,14 +488,25 @@ async function checkExternalPkgs(
 function maybeRenamePathExt(
   context: PlasmicContext,
   path: string,
-  ext: string
+  ext: string,
+  opts?: {
+    continueOnFailure?: boolean;
+  }
 ) {
   if (!path) {
     return path;
   }
   const correctPath = `${stripExtension(path, true)}${ext}`;
   if (path !== correctPath) {
-    renameFile(context, path, correctPath);
+    try {
+      renameFile(context, path, correctPath);
+    } catch (e) {
+      if (!opts?.continueOnFailure) {
+        throw e;
+      } else {
+        logger.warn(e);
+      }
+    }
   }
   return correctPath;
 }
@@ -506,19 +517,22 @@ function fixFileExtension(context: PlasmicContext) {
   context.config.style.defaultStyleCssFilePath = maybeRenamePathExt(
     context,
     context.config.style.defaultStyleCssFilePath,
-    cssExt
+    cssExt,
+    { continueOnFailure: true }
   );
   context.config.projects.forEach((project) => {
     project.cssFilePath = maybeRenamePathExt(
       context,
       project.cssFilePath,
-      cssExt
+      cssExt,
+      { continueOnFailure: true }
     );
     project.components.forEach((component) => {
       component.cssFilePath = maybeRenamePathExt(
         context,
         component.cssFilePath,
-        cssExt
+        cssExt,
+        { continueOnFailure: true }
       );
     });
   });
@@ -581,6 +595,7 @@ async function syncProject(
       opts.metadata
     ),
     indirect,
+    wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
   });
 
   // Convert from TSX => JSX

package/src/api.ts

@@ -266,6 +266,7 @@ export class PlasmicApi {
       codeOpts: CodeConfig;
       checksums: ChecksumBundle;
       indirect: boolean;
+      wrapPagesWithGlobalContexts: boolean;
       metadata?: Metadata;
     }
   ): Promise<ProjectBundle> {

package/src/test-common/fixtures.ts

@@ -34,6 +34,7 @@ export const defaultPlasmicJson: PlasmicConfig = {
   globalVariants: {
     variantGroups: [],
   },
+  wrapPagesWithGlobalContexts: true,
   cliVersion: "0.1.44",
 };
 export function standardTestSetup(includeDep = true) {

package/src/utils/code-utils.ts

@@ -156,6 +156,7 @@ type PlasmicImportType =
   | "picture"
   | "jsBundle"
   | "codeComponent"
+  | "globalContext"
   | undefined;
 
 function tryParsePlasmicImportSpec(node: ImportDeclaration) {
@@ -164,7 +165,7 @@ function tryParsePlasmicImportSpec(node: ImportDeclaration) {
     return undefined;
   }
   const m = c.value.match(
-    /plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent))?/
+    /plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext))?/
   );
   if (m) {
     return { id: m[1], type: m[2] as PlasmicImportType } as PlasmicImportSpec;
@@ -337,6 +338,18 @@ export function replaceImports(
         // npm package
         stmt.source.value = meta.componentImportPath;
       }
+    } else if (type === "globalContext") {
+      const projectConfig = fixImportContext.projects[uuid];
+      if (!projectConfig) {
+        throwMissingReference(context, "project", uuid, fromPath);
+      }
+      const realPath = makeImportPath(
+        context,
+        fromPath,
+        projectConfig.globalContextsFilePath,
+        true
+      );
+      stmt.source.value = realPath;
     }
   });
 
@@ -392,8 +405,10 @@ function makeImportPath(
  * a local file
  */
 export function isLocalModulePath(modulePath: string) {
-  // It is a local file reference if the importPath includes the file extension
-  return !!path.extname(modulePath);
+  // It is a local file reference if the importPath includes the file extension, and
+  // modulePath doesn't start with "@" (like an alias by convention, or scoped npm
+  // package). This is not a reliable way to detect scoped npm package, but :shrug:
+  return !!path.extname(modulePath) && !modulePath.startsWith("@");
 }
 
 export interface ComponentUpdateSummary {

package/src/utils/config-utils.ts

@@ -85,6 +85,9 @@ export interface PlasmicConfig {
   /** Metadata for each project that has been synced */
   projects: ProjectConfig[];
 
+  /** Wether we should wrap the pages with the project global contexts or not */
+  wrapPagesWithGlobalContexts: boolean;
+
   /** The version of cli when this file was written */
   cliVersion?: string;
 
@@ -411,6 +414,7 @@ export const DEFAULT_CONFIG: PlasmicConfig = {
   globalVariants: {
     variantGroups: [],
   },
+  wrapPagesWithGlobalContexts: true,
 };
 
 export const DEFAULT_PUBLIC_FILES_CONFIG: ImagesConfig = {

package/src/utils/get-context.ts

@@ -106,6 +106,14 @@ function removeMissingFilesFromLock(
     });
 }
 
+/**
+ *
+ * @param context
+ * @param expectedPath
+ * @param baseNameToFiles
+ * @returns The path if we are able to find the file, undefined if we need to recreate it
+ * @throws if the user interrupts flow
+ */
 async function attemptToRestoreFilePath(
   context: PlasmicContext,
   expectedPath: string,
@@ -193,30 +201,34 @@ async function resolveMissingFilesInConfig(
     "contextFilePath"
   );
 
+  // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
   context.config.style.defaultStyleCssFilePath =
     (await attemptToRestoreFilePath(
       context,
       context.config.style.defaultStyleCssFilePath,
       baseNameToFiles
-    )) || "";
+    )) || context.config.style.defaultStyleCssFilePath;
 
+  // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
   for (const project of config.projects) {
     project.cssFilePath =
       (await attemptToRestoreFilePath(
         context,
         project.cssFilePath,
         baseNameToFiles
-      )) || "";
+      )) || project.cssFilePath;
 
     if (!project.globalContextsFilePath) {
       project.globalContextsFilePath = "";
     }
+
+    // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
     project.globalContextsFilePath =
       (await attemptToRestoreFilePath(
         context,
         project.globalContextsFilePath,
         baseNameToFiles
-      )) || "";
+      )) || project.globalContextsFilePath;
 
     project.images = await filterFiles(project.images, "filePath");
     project.icons = await filterFiles(project.icons, "moduleFilePath");