@isograph/babel-plugin 0.2.0 → 0.3.0

package/BabelPluginIsograph.js

@@ -9,29 +9,40 @@ const configExplorer = cosmiconfig('isograph', {
     '.json': cosmiconfig.loadJson,
   },
 });
-
+/** @type {NonNullable<import("cosmiconfig").CosmiconfigResult>} */
 let IsographConfig;
 const result = configExplorer.searchSync();
 if (result) {
-  IsographConfig = result.config;
+  IsographConfig = result;
 } else {
   throw new Error(
     'No config found. Do you have a isograph.config.json file somewhere?',
   );
 }
 
+/** @typedef {import("@babel/core")} babel*/
+
+/**
+ * @typedef {Object} Context
+ * @property  {typeof babel.types} [types]
+ * */
+
+/**
+ * @param {Context} context
+ * @returns {babel.PluginObj} */
 module.exports = function BabelPluginIsograph(context) {
-  const { types: t } = context;
-  if (!t) {
+  const { types } = context;
+  if (!types) {
     throw new Error(
       'BabelPluginIsograph: Expected plugin context to include "types", but got:' +
         String(context),
     );
   }
 
+  /** @type {babel.Visitor<babel.PluginPass>} */
   const visitor = {
     CallExpression(path) {
-      compileTag(t, path, IsographConfig);
+      compileTag(types, path, IsographConfig);
     },
   };
 

package/compileTag.js

@@ -1,7 +1,14 @@
 'use strict';
 
 const pathModule = require('path');
+const os = require('os');
 
+/**
+ * @typedef {import("@babel/core")} babel
+ * @param {typeof babel.types} t
+ * @param {babel.NodePath<babel.types.CallExpression>} path
+ * @param {NonNullable<import("cosmiconfig").CosmiconfigResult>} config
+ */
 function compileTag(t, path, config) {
   const callee = path.node.callee;
   if (t.isIdentifier(callee) && callee.name === 'iso' && path.node.arguments) {
@@ -10,8 +17,16 @@ function compileTag(t, path, config) {
       // This throws if the tag is invalid
       compileImportStatement(t, path, type, field, 'entrypoint', config);
     } else if (keyword === 'field') {
-      // No-op
-      return false;
+      if (
+        t.isCallExpression(path.parentPath.node) &&
+        path.parentPath.node.arguments.length === 1
+      ) {
+        path.parentPath.replaceWith(path.parentPath.node.arguments[0]);
+      } else {
+        path.replaceWith(
+          t.arrowFunctionExpression([t.identifier('x')], t.identifier('x')),
+        );
+      }
     } else {
       throw new Error(
         "Invalid iso tag usage. Expected 'entrypoint' or 'field'.",
@@ -26,12 +41,22 @@ const typeAndFieldRegex = new RegExp(
   'm',
 );
 
+/**
+ * @param {babel.NodePath<babel.types.CallExpression>} path
+ *  */
 function getTypeAndField(path) {
   if (path.node.arguments.length !== 1) {
     throw new Error(
       `BabelPluginIsograph: Iso invocation require one parameter, found ${path.node.arguments.length}`,
     );
   }
+
+  if (path.node.arguments[0].type !== 'TemplateLiteral') {
+    throw new Error(
+      'BabelPluginIsograph: Only template literals are allowed in iso fragments.',
+    );
+  }
+
   const quasis = path.node.arguments[0].quasis;
   if (quasis.length !== 1) {
     throw new Error(
@@ -42,9 +67,9 @@ function getTypeAndField(path) {
   const content = quasis[0].value.raw;
   const typeAndField = typeAndFieldRegex.exec(content);
 
-  const keyword = typeAndField[1];
-  const type = typeAndField[2];
-  const field = typeAndField[3];
+  const keyword = typeAndField?.[1];
+  const type = typeAndField?.[2];
+  const field = typeAndField?.[3];
 
   if (keyword == null || type == null || field == null) {
     throw new Error(
@@ -54,13 +79,21 @@ function getTypeAndField(path) {
   return { keyword, type, field };
 }
 
+/**
+ * @param {typeof babel.types} t
+ * @param {babel.NodePath<babel.types.CallExpression>} path
+ * @param {string} type
+ * @param {string} field
+ * @param {string} artifactType
+ * @param {NonNullable<import("cosmiconfig").CosmiconfigResult>} config
+ */
 function compileImportStatement(t, path, type, field, artifactType, config) {
   const filename = path.state.filename;
   const folder = pathModule.dirname(filename);
-  const cwd = path.state.cwd;
+  const cwd = pathModule.dirname(config.filepath);
   const artifactDirectory = pathModule.join(
     cwd,
-    config.artifact_directory ?? config.project_root,
+    config.config['artifact_directory'] ?? config.config['project_root'],
   );
 
   const fileToArtifactDir = pathModule.relative(folder, artifactDirectory);
@@ -70,6 +103,10 @@ function compileImportStatement(t, path, type, field, artifactType, config) {
     artifactDirToArtifact,
   );
 
+  if (os.platform() === 'win32') {
+    fileToArtifact = fileToArtifact.replace(/\\/g, '/');
+  }
+
   // If we do not have to traverse upward, e.g. if the resolver is in
   // src/HomePage, and the artifact directory is src/, then fileToArtifact
   // will start with a /. require('/...') is not good, as that is treated
@@ -80,10 +117,10 @@ function compileImportStatement(t, path, type, field, artifactType, config) {
 
   path.replaceWith(
     t.memberExpression(
-      t.CallExpression(t.Identifier('require'), [
-        t.StringLiteral(fileToArtifact),
+      t.callExpression(t.identifier('require'), [
+        t.stringLiteral(fileToArtifact),
       ]),
-      t.Identifier('default'),
+      t.identifier('default'),
     ),
   );
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@isograph/babel-plugin",
   "description": "A Babel plugin for use with Isograph applications.",
   "homepage": "https://isograph.dev",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "keywords": [
     "graphql",
     "isograph",
@@ -15,6 +15,9 @@
     "url": "git+https://github.com/isographlabs/isograph.git",
     "directory": "libs/isograph-babel-plugin"
   },
+  "scripts": {
+    "tsc": "tsc"
+  },
   "dependencies": {
     "babel-plugin-macros": "^2.0.0",
     "cosmiconfig": "^5.0.5",
@@ -22,6 +25,9 @@
   },
   "devDependencies": {
     "@babel/core": "^7.20.0",
+    "@babel/types": "^7.25.6",
+    "@types/babel__core": "^7.20.5",
+    "@types/cosmiconfig": "^5.0.3",
     "prettier": "2.8.8",
     "prettier-plugin-hermes-parser": "0.16.0"
   },

package/stub.ts

@@ -0,0 +1,6 @@
+import type cosmiconfig from 'cosmiconfig';
+declare module 'cosmiconfig' {
+  export const loadJson: cosmiconfig.LoaderEntry;
+}
+
+export {};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "lib": ["es2017", "DOM"]
+  },
+  "include": ["./**/*.ts", "./**/*.js"]
+}