@suspensive/codemods 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Viva Republica, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# Introduction
+
+Suspensive provides a codemod to facilitate easy code modifications. This helps in managing the Suspensive codebase more effectively.
+
+## Usage
+
+In your terminal, navigate into your project's folder, then run:
+
+```shell
+npx @suspensive/codemods <transform> <path>
+```

package/dist/bin/codemods.cjs

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/bin/codemods.ts
+var import_extra_typings = require("@commander-js/extra-typings");
+
+// package.json
+var package_default = {
+  name: "@suspensive/codemods",
+  version: "0.1.0",
+  description: "Codemods for @suspensive.",
+  keywords: [
+    "suspensive",
+    "codemods"
+  ],
+  homepage: "https://suspensive.org",
+  bugs: "https://github.com/toss/suspensive/issues",
+  repository: {
+    type: "git",
+    url: "git+https://github.com/toss/suspensive.git",
+    directory: "packages/codemods"
+  },
+  license: "MIT",
+  author: "Gwansik Kim <gwansik.kim@gwansik.dev>",
+  sideEffects: false,
+  type: "module",
+  files: [
+    "dist"
+  ],
+  scripts: {
+    build: "tsup",
+    "ci:attw": "attw --pack",
+    "ci:eslint": 'eslint "**/*.{ts,tsx,cts,mts}"',
+    "ci:publint": "publint --strict",
+    "ci:test": "vitest run --coverage --typecheck",
+    "ci:type": "tsc --noEmit",
+    clean: "rimraf ./dist && rimraf ./coverage",
+    prepack: "pnpm build",
+    "test:ui": "vitest --ui --coverage --typecheck"
+  },
+  bin: "dist/bin/codemods.cjs",
+  dependencies: {
+    "@commander-js/extra-typings": "^12.1.0",
+    commander: "^12.1.0",
+    execa: "^5.1.1",
+    jscodeshift: "^17.0.0",
+    prompts: "^2.4.2"
+  },
+  devDependencies: {
+    "@suspensive/eslint-config": "workspace:*",
+    "@suspensive/tsconfig": "workspace:*",
+    "@types/jscodeshift": "^0.12.0",
+    "@types/prompts": "^2.4.9"
+  },
+  publishConfig: {
+    access: "public"
+  }
+};
+
+// src/bin/transformRunner.ts
+var import_node_path = require("path");
+var import_execa = __toESM(require("execa"), 1);
+var import_prompts = __toESM(require("prompts"), 1);
+var TRANSFORMER_INQUIRER_CHOICES = [
+  {
+    title: "tanstack-query-import",
+    description: "Migrate imports to @tanstack/react-query in @suspensive/react-query (using @tanstack/react-query@5)"
+  }
+];
+function onCancel() {
+  process.exit(1);
+}
+var jscodeshiftExecutable = require.resolve(".bin/jscodeshift");
+var transformerDirectory = (0, import_node_path.join)(__dirname, "../", "../", "dist", "transforms");
+async function transformRunner(transform, path) {
+  let transformer = transform ?? "";
+  let directory = path ?? "";
+  if (transform && !TRANSFORMER_INQUIRER_CHOICES.find((x) => x.title === transform)) {
+    console.error("Invalid transform choice, pick one of:");
+    console.error(TRANSFORMER_INQUIRER_CHOICES.map((x) => "- " + x.title).join("\n"));
+    process.exit(1);
+  }
+  if (!transform) {
+    const res = await (0, import_prompts.default)(
+      {
+        type: "select",
+        name: "transformer",
+        message: "Which transform would you like to apply?",
+        choices: TRANSFORMER_INQUIRER_CHOICES.reverse().map(({ title, description }) => {
+          return {
+            title,
+            description,
+            value: title
+          };
+        })
+      },
+      { onCancel }
+    );
+    transformer = res.transformer;
+  }
+  if (!path) {
+    const res = await (0, import_prompts.default)(
+      {
+        type: "text",
+        name: "path",
+        message: "On which files or directory should the codemods be applied?",
+        initial: "."
+      },
+      { onCancel }
+    );
+    directory = res.path;
+  }
+  const args = [];
+  args.push("--no-babel");
+  args.push("--ignore-pattern=**/node_modules/**");
+  args.push("--ignore-pattern=**/.next/**");
+  args.push("--extensions=tsx,ts,jsx,js");
+  args.push("--transform", (0, import_node_path.join)(transformerDirectory, `${transformer}.cjs`));
+  args.push(directory);
+  console.log(`Executing command: jscodeshift ${args.join(" ")}`);
+  const execaChildProcess = (0, import_execa.default)(jscodeshiftExecutable, args, {
+    env: process.stdout.isTTY ? { FORCE_COLOR: "true" } : {}
+  });
+  let lastThreeLineBreaks = "";
+  if (execaChildProcess.stdout) {
+    execaChildProcess.stdout.pipe(process.stdout);
+    execaChildProcess.stderr?.pipe(process.stderr);
+    execaChildProcess.stdout.on("data", (chunk) => {
+      lastThreeLineBreaks += chunk.toString("utf-8");
+      let cutoff = lastThreeLineBreaks.length;
+      for (let i = 0; i < 3; i++) {
+        cutoff = lastThreeLineBreaks.lastIndexOf("\n", cutoff) - 1;
+      }
+      if (cutoff > 0 && cutoff < lastThreeLineBreaks.length) {
+        lastThreeLineBreaks = lastThreeLineBreaks.slice(cutoff + 1);
+      }
+    });
+  }
+  try {
+    const result = await execaChildProcess;
+    if (result.failed) {
+      throw new Error(`jscodeshift exited with code ${result.exitCode}`);
+    }
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+// src/bin/codemods.ts
+var program = new import_extra_typings.Command(package_default.name);
+program.description(package_default.description).version(package_default.version, "-v, --version", "Output the current version of @suspensive/codemods.").argument("[codemod]", "Codemod slug to run.").argument("[path]", "Path to source directory.").usage("[codemod] [path]").helpOption("-h, --help", "Display this help message.").action((codemod, path) => transformRunner(codemod, path));
+program.parse(process.argv);

package/dist/bin/transformRunner.cjs

@@ -0,0 +1,131 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/bin/transformRunner.ts
+var transformRunner_exports = {};
+__export(transformRunner_exports, {
+  jscodeshiftExecutable: () => jscodeshiftExecutable,
+  transformRunner: () => transformRunner,
+  transformerDirectory: () => transformerDirectory
+});
+module.exports = __toCommonJS(transformRunner_exports);
+var import_node_path = require("path");
+var import_execa = __toESM(require("execa"), 1);
+var import_prompts = __toESM(require("prompts"), 1);
+var TRANSFORMER_INQUIRER_CHOICES = [
+  {
+    title: "tanstack-query-import",
+    description: "Migrate imports to @tanstack/react-query in @suspensive/react-query (using @tanstack/react-query@5)"
+  }
+];
+function onCancel() {
+  process.exit(1);
+}
+var jscodeshiftExecutable = require.resolve(".bin/jscodeshift");
+var transformerDirectory = (0, import_node_path.join)(__dirname, "../", "../", "dist", "transforms");
+async function transformRunner(transform, path) {
+  let transformer = transform ?? "";
+  let directory = path ?? "";
+  if (transform && !TRANSFORMER_INQUIRER_CHOICES.find((x) => x.title === transform)) {
+    console.error("Invalid transform choice, pick one of:");
+    console.error(TRANSFORMER_INQUIRER_CHOICES.map((x) => "- " + x.title).join("\n"));
+    process.exit(1);
+  }
+  if (!transform) {
+    const res = await (0, import_prompts.default)(
+      {
+        type: "select",
+        name: "transformer",
+        message: "Which transform would you like to apply?",
+        choices: TRANSFORMER_INQUIRER_CHOICES.reverse().map(({ title, description }) => {
+          return {
+            title,
+            description,
+            value: title
+          };
+        })
+      },
+      { onCancel }
+    );
+    transformer = res.transformer;
+  }
+  if (!path) {
+    const res = await (0, import_prompts.default)(
+      {
+        type: "text",
+        name: "path",
+        message: "On which files or directory should the codemods be applied?",
+        initial: "."
+      },
+      { onCancel }
+    );
+    directory = res.path;
+  }
+  const args = [];
+  args.push("--no-babel");
+  args.push("--ignore-pattern=**/node_modules/**");
+  args.push("--ignore-pattern=**/.next/**");
+  args.push("--extensions=tsx,ts,jsx,js");
+  args.push("--transform", (0, import_node_path.join)(transformerDirectory, `${transformer}.cjs`));
+  args.push(directory);
+  console.log(`Executing command: jscodeshift ${args.join(" ")}`);
+  const execaChildProcess = (0, import_execa.default)(jscodeshiftExecutable, args, {
+    env: process.stdout.isTTY ? { FORCE_COLOR: "true" } : {}
+  });
+  let lastThreeLineBreaks = "";
+  if (execaChildProcess.stdout) {
+    execaChildProcess.stdout.pipe(process.stdout);
+    execaChildProcess.stderr?.pipe(process.stderr);
+    execaChildProcess.stdout.on("data", (chunk) => {
+      lastThreeLineBreaks += chunk.toString("utf-8");
+      let cutoff = lastThreeLineBreaks.length;
+      for (let i = 0; i < 3; i++) {
+        cutoff = lastThreeLineBreaks.lastIndexOf("\n", cutoff) - 1;
+      }
+      if (cutoff > 0 && cutoff < lastThreeLineBreaks.length) {
+        lastThreeLineBreaks = lastThreeLineBreaks.slice(cutoff + 1);
+      }
+    });
+  }
+  try {
+    const result = await execaChildProcess;
+    if (result.failed) {
+      throw new Error(`jscodeshift exited with code ${result.exitCode}`);
+    }
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  jscodeshiftExecutable,
+  transformRunner,
+  transformerDirectory
+});

package/dist/transforms/tanstack-query-import.cjs

@@ -0,0 +1,107 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/transforms/tanstack-query-import.ts
+var tanstack_query_import_exports = {};
+__export(tanstack_query_import_exports, {
+  default: () => transform
+});
+module.exports = __toCommonJS(tanstack_query_import_exports);
+
+// src/utils/createParserFromPath.ts
+var import_jscodeshift = __toESM(require("jscodeshift"), 1);
+var import_babylon = __toESM(require("jscodeshift/parser/babylon"), 1);
+var import_tsOptions = __toESM(require("jscodeshift/parser/tsOptions"), 1);
+function createParserFromPath(filePath) {
+  const isDeclarationFile = /\.d\.[mc]?ts$/.test(filePath);
+  if (isDeclarationFile) {
+    return import_jscodeshift.default.withParser(
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-call
+      (0, import_babylon.default)({
+        ...import_tsOptions.default,
+        plugins: [
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+          ...import_tsOptions.default.plugins.filter((plugin) => plugin !== "typescript"),
+          ["typescript", { dts: true }]
+        ]
+      })
+    );
+  }
+  const isTsFile = /\.[mc]?ts$/.test(filePath);
+  return isTsFile ? import_jscodeshift.default.withParser("ts") : import_jscodeshift.default.withParser("tsx");
+}
+
+// src/transforms/tanstack-query-import.ts
+var IMPORT_TO_CHANGE = [
+  "useSuspenseQuery",
+  "UseSuspenseQueryResult",
+  "UseSuspenseQueryOptions",
+  "useSuspenseQueries",
+  "SuspenseQueriesResults",
+  "SuspenseQueriesOptions",
+  "useSuspenseInfiniteQuery",
+  "UseSuspenseInfiniteQueryResult",
+  "UseSuspenseInfiniteQueryOptions",
+  "usePrefetchQuery",
+  "queryOptions",
+  "infiniteQueryOption"
+];
+function transform(file) {
+  const j2 = createParserFromPath(file.path);
+  const root = j2(file.source);
+  root.find(j2.ImportDeclaration, {
+    source: {
+      value: (v) => /^@suspensive\/react-query(-\d+)?$/.test(v)
+    }
+  }).forEach((path) => {
+    const importSpecifiers = path.node.specifiers || [];
+    const importNamesToChange = importSpecifiers.filter(
+      (specifier) => IMPORT_TO_CHANGE.includes(specifier.local?.name ?? "")
+    );
+    const importsNamesRemained = importSpecifiers.filter(
+      (specifier) => !IMPORT_TO_CHANGE.includes(specifier.local?.name ?? "")
+    );
+    if (importNamesToChange.length > 0) {
+      const newImportStatement = j2.importDeclaration(importNamesToChange, j2.stringLiteral("@tanstack/react-query"));
+      path.insertBefore(newImportStatement);
+    }
+    if (importsNamesRemained.length > 0) {
+      const remainingSpecifiers = importSpecifiers.filter(
+        (specifier) => !IMPORT_TO_CHANGE.includes(specifier.local?.name ?? "")
+      );
+      const suspensiveRemainImportsStatement = j2.importDeclaration(
+        remainingSpecifiers,
+        j2.stringLiteral(path.node.source.value || "@suspensive/react-query")
+      );
+      path.insertBefore(suspensiveRemainImportsStatement);
+    }
+    j2(path).remove();
+  }).toSource();
+  return root.toSource();
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@suspensive/codemods",
+  "version": "0.1.0",
+  "description": "Codemods for @suspensive.",
+  "keywords": [
+    "suspensive",
+    "codemods"
+  ],
+  "homepage": "https://suspensive.org",
+  "bugs": "https://github.com/toss/suspensive/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/toss/suspensive.git",
+    "directory": "packages/codemods"
+  },
+  "license": "MIT",
+  "author": "Gwansik Kim <gwansik.kim@gwansik.dev>",
+  "sideEffects": false,
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "bin": "dist/bin/codemods.cjs",
+  "dependencies": {
+    "@commander-js/extra-typings": "^12.1.0",
+    "commander": "^12.1.0",
+    "execa": "^5.1.1",
+    "jscodeshift": "^17.0.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/jscodeshift": "^0.12.0",
+    "@types/prompts": "^2.4.9",
+    "@suspensive/eslint-config": "0.0.0",
+    "@suspensive/tsconfig": "0.0.0-development"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "ci:attw": "attw --pack",
+    "ci:eslint": "eslint \"**/*.{ts,tsx,cts,mts}\"",
+    "ci:publint": "publint --strict",
+    "ci:test": "vitest run --coverage --typecheck",
+    "ci:type": "tsc --noEmit",
+    "clean": "rimraf ./dist && rimraf ./coverage",
+    "test:ui": "vitest --ui --coverage --typecheck"
+  }
+}