@plasmicapp/cli 0.1.182 → 0.1.185

package/README

@@ -1,16 +1,19 @@
-Public plasmic cli for syncing designs to local code.
+Plasmic CLI for syncing Plasmic designs down into your local repo as generated React code.
 
-Install
-=======
+Plasmic is the visual builder for React. Learn more at <https://plasmic.app>.
 
-`yarn global add @plasmicapp/cli`
+# Install
 
-Usage
-=====
+```bash
+npm install -g @plasmicapp/cli
+```
+
+# Usage
+
+See <https://docs.plasmic.app/learn/codegen-guide/> for the full docs to get started with Plasmic codegen.
 
 `plasmic init` creates the initial plasmic.json file, pointing to your local dev host.
 
 `plasmic sync --projects ...` allows you to sync all components in the specified projects
-down as code files to your current folder.  Once you've run `plasmic init`, you can run
+down as code files to your current folder. Once you've run `plasmic init`, you can run
 `plasmic sync` from any subfolder of the folder with the `plasmic.json` file.
-

package/dist/actions/sync-components.js

@@ -42,7 +42,8 @@ const updateDirectSkeleton = (newFileContent, editedFileContent, context, compCo
                 throw e;
             }
             else {
-                throw new error_1.HandledError(e.messag);
+                lang_utils_1.assert(e instanceof Error);
+                throw new error_1.HandledError(e.message);
             }
         }
     })), () => { }, appendJsxOnMissingBase);
@@ -170,7 +171,7 @@ function syncProjectComponents(context, project, version, componentBundles, forc
                 }
                 if (isPage &&
                     config_utils_1.isPageAwarePlatform(context.config.platform) &&
-                    skeletonPath !== compConfig.importSpec.modulePath &&
+                    !file_utils_1.eqPagePath(skeletonPath, compConfig.importSpec.modulePath) &&
                     file_utils_1.fileExists(context, compConfig.importSpec.modulePath)) {
                     if (context.cliArgs.quiet !== true) {
                         deps_1.logger.info(`Renaming page file: ${compConfig.importSpec.modulePath} -> ${skeletonPath}\t['${project.projectName}' ${project.projectId}/${id} ${project.version}]`);

package/dist/utils/code-utils.js

@@ -252,7 +252,7 @@ function replaceImports(context, code, fromPath, fixImportContext, removeImportD
             const meta = fixImportContext.codeComponentMetas[uuid];
             if (meta.componentImportPath[0] === ".") {
                 // Relative path from the project root
-                const toPath = upath_1.default.join(process.cwd(), meta.componentImportPath);
+                const toPath = upath_1.default.join(context.rootDir, meta.componentImportPath);
                 lang_utils_1.assert(upath_1.default.isAbsolute(toPath));
                 const realPath = makeImportPath(context, fromPath, toPath, true, true);
                 stmt.source.value = realPath;

package/dist/utils/envdetect.js

@@ -27,7 +27,7 @@ function detectNextJs() {
 }
 exports.detectNextJs = detectNextJs;
 function detectGatsby() {
-    return findup_sync_1.default("gatsby-config.js");
+    return findup_sync_1.default("gatsby-config.js") || findup_sync_1.default("gatsby-config.ts");
 }
 exports.detectGatsby = detectGatsby;
 function detectCreateReactApp() {

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

@@ -9,6 +9,16 @@ export declare function writeFileContentRaw(filePath: string, content: string |
 export declare function defaultResourcePath(context: PlasmicContext, project: ProjectConfig | ProjectMetaBundle | string, ...subpaths: string[]): string;
 export declare function defaultPublicResourcePath(context: PlasmicContext, project: ProjectConfig, ...subpaths: string[]): string;
 export declare function defaultPagePath(context: PlasmicContext, fileName: string): string;
+/**
+ * Returns true iff paths `a` and `b` resolve to the same page URI. For
+ * example:
+ *
+ * - pages/about.tsx and pages/about.js resolve to the same URI (/about).
+ * - pages/about/index.tsx and pages/about.tsx resolve to the same URI (/about).
+ * - pages/index.tsx and pages/index/index.tsx do not resolve to the same URI
+ * (they resolve, respectively, to / and /index).
+ */
+export declare function eqPagePath(a: string, b: string): boolean;
 export declare function writeFileContent(context: PlasmicContext, srcDirFilePath: string, content: string | Buffer, opts?: {
     force?: boolean;
 }): Promise<void>;

package/dist/utils/file-utils.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.existsBuffered = exports.deleteFileBuffered = exports.renameFileBuffered = exports.readFileText = exports.writeFileText = exports.withBufferedFs = exports.assertAllPathsInRootDir = exports.findFile = exports.findSrcDirPath = exports.buildBaseNameToFiles = exports.renameFile = exports.makeFilePath = exports.fileExists = exports.deleteFile = exports.readFileContent = exports.writeFileContent = exports.defaultPagePath = exports.defaultPublicResourcePath = exports.defaultResourcePath = exports.writeFileContentRaw = exports.stripExtension = void 0;
+exports.existsBuffered = exports.deleteFileBuffered = exports.renameFileBuffered = exports.readFileText = exports.writeFileText = exports.withBufferedFs = exports.assertAllPathsInRootDir = exports.findFile = exports.findSrcDirPath = exports.buildBaseNameToFiles = exports.renameFile = exports.makeFilePath = exports.fileExists = exports.deleteFile = exports.readFileContent = exports.writeFileContent = exports.eqPagePath = exports.defaultPagePath = exports.defaultPublicResourcePath = exports.defaultResourcePath = exports.writeFileContentRaw = exports.stripExtension = void 0;
 const fs_1 = __importDefault(require("fs"));
 const glob_1 = __importDefault(require("glob"));
 const lodash_1 = __importDefault(require("lodash"));
@@ -68,6 +68,34 @@ function defaultPagePath(context, fileName) {
     return fileName;
 }
 exports.defaultPagePath = defaultPagePath;
+/**
+ * Returns true iff paths `a` and `b` resolve to the same page URI. For
+ * example:
+ *
+ * - pages/about.tsx and pages/about.js resolve to the same URI (/about).
+ * - pages/about/index.tsx and pages/about.tsx resolve to the same URI (/about).
+ * - pages/index.tsx and pages/index/index.tsx do not resolve to the same URI
+ * (they resolve, respectively, to / and /index).
+ */
+function eqPagePath(a, b) {
+    // Remove extension and ensure that a.length < b.length.
+    a = stripExtension(a);
+    b = stripExtension(b);
+    if (a.length > b.length) {
+        [a, b] = [b, a];
+    }
+    // pages/about.tsx and pages/about.js resolve to the same page URI.
+    if (a === 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) {
+        return true;
+    }
+    return false;
+}
+exports.eqPagePath = eqPagePath;
 function writeFileContent(context, srcDirFilePath, content, opts = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const path = makeFilePath(context, srcDirFilePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.182",
+  "version": "0.1.185",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -16,7 +16,7 @@
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --watch",
     "build": "bash build.sh",
     "plasmic": "ts-node src/index.ts",
-    "prepare": "yarn build"
+    "prepare": "if-env PREPARE_NO_BUILD=true || yarn build"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.12.1",

package/src/actions/sync-components.ts

@@ -21,6 +21,7 @@ import {
   defaultPagePath,
   defaultResourcePath,
   deleteFile,
+  eqPagePath,
   fileExists,
   readFileContent,
   renameFile,
@@ -71,7 +72,8 @@ const updateDirectSkeleton = async (
         ) {
           throw e;
         } else {
-          throw new HandledError(e.messag);
+          assert(e instanceof Error);
+          throw new HandledError(e.message);
         }
       }
     }),
@@ -302,7 +304,7 @@ export async function syncProjectComponents(
       if (
         isPage &&
         isPageAwarePlatform(context.config.platform) &&
-        skeletonPath !== compConfig.importSpec.modulePath &&
+        !eqPagePath(skeletonPath, compConfig.importSpec.modulePath) &&
         fileExists(context, compConfig.importSpec.modulePath)
       ) {
         if (context.cliArgs.quiet !== true) {

package/src/utils/code-utils.ts

@@ -330,7 +330,7 @@ export function replaceImports(
       const meta = fixImportContext.codeComponentMetas[uuid];
       if (meta.componentImportPath[0] === ".") {
         // Relative path from the project root
-        const toPath = path.join(process.cwd(), meta.componentImportPath);
+        const toPath = path.join(context.rootDir, meta.componentImportPath);
         assert(path.isAbsolute(toPath));
         const realPath = makeImportPath(context, fromPath, toPath, true, true);
         stmt.source.value = realPath;

package/src/utils/envdetect.ts

@@ -26,7 +26,7 @@ export function detectNextJs() {
 }
 
 export function detectGatsby() {
-  return findupSync("gatsby-config.js");
+  return findupSync("gatsby-config.js") || findupSync("gatsby-config.ts");
 }
 
 export function detectCreateReactApp() {

package/src/utils/file-utils.ts

@@ -87,6 +87,37 @@ export function defaultPagePath(context: PlasmicContext, fileName: string) {
   return fileName;
 }
 
+/**
+ * Returns true iff paths `a` and `b` resolve to the same page URI. For
+ * example:
+ *
+ * - pages/about.tsx and pages/about.js resolve to the same URI (/about).
+ * - pages/about/index.tsx and pages/about.tsx resolve to the same URI (/about).
+ * - pages/index.tsx and pages/index/index.tsx do not resolve to the same URI
+ * (they resolve, respectively, to / and /index).
+ */
+export function eqPagePath(a: string, b: string) {
+  // Remove extension and ensure that a.length < b.length.
+  a = stripExtension(a);
+  b = stripExtension(b);
+  if (a.length > b.length) {
+    [a, b] = [b, a];
+  }
+
+  // pages/about.tsx and pages/about.js resolve to the same page URI.
+  if (a === 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) {
+    return true;
+  }
+
+  return false;
+}
+
 export async function writeFileContent(
   context: PlasmicContext,
   srcDirFilePath: string,