@stackshift-ui/scripts 1.0.0

package/hook.js

@@ -0,0 +1,62 @@
+const fs = require("fs");
+const path = require("path");
+
+const __dir = path.resolve(__dirname, "..");
+const TEMPLATE_DIR = "scripts/templates/";
+
+/**
+ * Gets actions based on the provided data.
+ * @param {InquirerDataType} data - Input data.
+ * @returns {import('plop').ActionType[]} Actions.
+ */
+function getActions(data) {
+  const actions = [];
+  if (!fs.existsSync(path.resolve(__dir, `${data.pkgPath}/src/hooks`, "index.ts"))) {
+    actions.push({
+      type: "add",
+      path: `${data.pkgPath}/src/hooks/index.ts`,
+      template: '// hooks exports\nexport * from "./{{kebabCase name}}";',
+    });
+  } else {
+    actions.push({
+      type: "append",
+      pattern: /(?<insertion> hooks exports)/,
+      path: `${data.pkgPath}/src/hooks/index.ts`,
+      template: 'export * from "./{{kebabCase name}}";',
+    });
+  }
+
+  ["", ".test"].forEach(suffix => {
+    actions.push({
+      type: "add",
+      path: `${data.pkgPath}/src/hooks/{{kebabCase name}}${suffix}.ts`,
+      templateFile: `${TEMPLATE_DIR}hook${suffix}.hbs`,
+    });
+  });
+
+  return actions;
+}
+
+module.exports = {
+  description: "Add a new React hook.",
+  prompts: [
+    {
+      type: "list",
+      name: "pkgPath",
+      choices: ["lib", "packages", "packages/shared"],
+      default: "lib",
+      message: "Select the package",
+    },
+    {
+      type: "input",
+      name: "name",
+      message: "What is the name of the hook?",
+    },
+    {
+      type: "input",
+      name: "description",
+      message: "Describe your custom hook. (This will be added as js-doc comment.)",
+    },
+  ],
+  actions: data => (data ? getActions(data) : []),
+};

package/lite.js

@@ -0,0 +1,29 @@
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+const config = require("./rebrand.config.json");
+
+const packageJson = require("../lib/package.json");
+
+const ref = packageJson.name;
+packageJson.peerDependencies.r18gs = `${packageJson.dependencies.r18gs.split(".")[0]}`;
+delete packageJson.dependencies.r18gs;
+if (Object.keys(packageJson.dependencies).length === 0) delete packageJson.dependencies;
+packageJson.name = `${ref}-lite`;
+
+fs.writeFileSync(
+  path.resolve(__dirname, "../lib/package.json"),
+  JSON.stringify(packageJson, null, 2),
+);
+
+const readMePath = path.resolve(__dirname, "../lib", "README.md");
+
+let readMe = fs.readFileSync(readMePath, { encoding: "utf8" });
+const tmp = "!---";
+const { owner, repo } = config;
+readMe = readMe.replace(new RegExp(`${owner}/${repo}`, "g"), tmp);
+readMe = readMe.replace(new RegExp(ref, "g"), packageJson.name);
+readMe = readMe.replace(new RegExp(tmp, "g"), `${owner}/${repo}`);
+readMe = readMe.replace(/## Want Lite Version(.|\n|\r)*You need `r18gs` as a peer-dependency/m, "");
+fs.writeFileSync(readMePath, readMe);

package/manual-publish.js

@@ -0,0 +1,95 @@
+/**
+ * allow only patch changes from release branches.
+ * Major and minor changes allowed only from main branch.
+ * pre-release only from branch containing dev or alpha in the branchname
+ */
+
+/** Let the following error be thrown by npm. There are situations where publish could have failed for different reasons. */
+// throws an exception if process.env.oldv === process.env.v The library version is not up to date, error(" Not able to release to the same version.
+
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+
+const BRANCH = process.env.BRANCH;
+const DEFAULT_BRANCH = process.env.DEFAULT_BRANCH;
+
+const isLatestRelease = BRANCH === DEFAULT_BRANCH || BRANCH.includes("release-");
+let tag = "latest";
+
+const OLD_VERSION = require("../lib/package.json").version;
+if (!isLatestRelease) {
+  /** pre-release branch name should be the tag name (e.g., beta, canery, etc.) or tag name followed by a '-' and version or other specifiers. e.g. beta-2.0 */
+  tag = BRANCH.split("-")[0];
+  try {
+    execSync(`pnpm changeset pre enter ${tag}`);
+  } catch (e) {
+    console.log({ e });
+  }
+}
+/** Apply changeset */
+execSync("pnpm changeset version");
+
+// exit pre mode -- to avoid collision with full releases
+try {
+  execSync("pnpm changeset pre exit");
+} catch {
+  // empty
+}
+
+/** not requiring as require is cached by npm/node */
+const NEW_VERSION = JSON.parse(
+  fs.readFileSync(path.resolve(__dirname, "..", "lib", "package.json")),
+).version;
+
+const [newMajor, newMinor] = NEW_VERSION.split(".");
+const [oldMajor, oldMinor] = OLD_VERSION.split(".");
+
+const isNotPatch = newMajor !== oldMajor || newMinor !== oldMinor;
+
+const pushCmd = `git add . && git commit -m "Apply changesets and update CHANGELOG" && git push origin ${BRANCH}`;
+
+if (isNotPatch && BRANCH === DEFAULT_BRANCH) {
+  try {
+    execSync(pushCmd);
+  } catch (e) {
+    console.log({ e });
+  }
+  require("./update-security-md")(`${newMajor}.${newMinor}`, `${oldMajor}.${oldMinor}`);
+  /** Create new release branch for every Major or Minor release */
+  const releaseBranch = `release-${newMajor}.${newMinor}`;
+  execSync(`git checkout -b ${releaseBranch} && git push origin ${releaseBranch}`);
+} else if (isLatestRelease) {
+  /** New version must be valid SEMVER version. No pre-release (beta/alpha etc.) */
+  if (!/^\d+\.\d+.\d+$/.test(NEW_VERSION)) throw new Error("Invalid version");
+
+  if (isNotPatch)
+    throw new Error("Major or Minor changes can be published only from the default branch.");
+
+  // Push changes back to the repo
+  try {
+    execSync(pushCmd);
+  } catch (e) {
+    console.log({ e });
+  }
+} else {
+  try {
+    execSync(pushCmd);
+  } catch (e) {
+    console.log({ e });
+  }
+}
+
+const { visibility } = JSON.parse(execSync("gh repo view --json visibility").toString());
+const provenance = visibility.toLowerCase() === "public" ? "--provenance" : "";
+
+/** Create release */
+execSync(`cd lib && pnpm build && npm publish ${provenance} --access public --tag ${tag}`);
+
+/** Create GitHub release */
+execSync(
+  `gh release create ${NEW_VERSION} --generate-notes${isLatestRelease ? " --latest" : ""} -n "$(sed '1,/^## /d;/^## /,$d' CHANGELOG.md)" --title "Release v${NEW_VERSION}"`,
+);
+
+// execSync("node ./scripts/lite.js");
+// execSync(`cd lib && pnpm build && npm publish ${provenance} --access public --tag ${tag}`);

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@stackshift-ui/scripts",
+  "version": "1.0.0",
+  "description": "",
+  "main": "rebrand.js",
+  "scripts": {}
+}

package/publish.js

@@ -0,0 +1,54 @@
+/** It is assumed that this is called only from the default branch. */
+const { execSync } = require("child_process");
+
+// Apply changesets if any -- e.g., coming from pre-release branches
+try {
+  execSync("pnpm changeset pre exit");
+} catch {
+  // empty
+}
+try {
+  execSync("pnpm changeset version");
+  execSync(
+    `git add . && git commit -m "Apply changesets and update CHANGELOG" && git push origin main`,
+  );
+} catch {
+  // no changesets to be applied
+}
+
+const { version: VERSION, name } = require("../packages/core/react/package.json");
+let LATEST_VERSION = "0.0.-1";
+
+try {
+  LATEST_VERSION = execSync(`npm view ${name} version`).toString().trim() ?? "0.0.1";
+} catch {
+  // empty
+}
+
+console.log({ VERSION, LATEST_VERSION });
+
+const [newMajor, newMinor] = VERSION.split(".");
+const [oldMajor, oldMinor] = LATEST_VERSION.split(".");
+
+const isPatch = newMajor === oldMajor && newMinor === oldMinor;
+
+if (!isPatch) {
+  require("./update-security-md")(`${newMajor}.${newMinor}`, `${oldMajor}.${oldMinor}`);
+  /** Create new release branch for every Major or Minor release */
+  const releaseBranch = `release-${newMajor}.${newMinor}`;
+  execSync(`git checkout -b ${releaseBranch} && git push origin ${releaseBranch}`);
+}
+
+const { visibility } = JSON.parse(execSync("gh repo view --json visibility").toString());
+const provenance = visibility.toLowerCase() === "public" ? "--provenance" : "";
+
+/** Create release */
+execSync(`cd lib && pnpm build && npm publish ${provenance} --access public`);
+
+/** Create GitHub release */
+execSync(
+  `gh release create ${VERSION} --generate-notes --latest -n "$(sed '1,/^## /d;/^## /,$d' CHANGELOG.md)" --title "Release v${VERSION}"`,
+);
+
+execSync("node ./scripts/lite.js");
+execSync(`cd lib && pnpm build && npm publish ${provenance} --access public`);

package/rc.js

@@ -0,0 +1,208 @@
+const fs = require("fs");
+const path = require("path");
+
+const __dir = path.resolve(__dirname, "..");
+const TEMPLATE_DIR = "scripts/templates/";
+
+/**
+ * @typedef {Object} InquirerDataType
+ * @property {boolean} isClient - Indicates whether a client component should be created.
+ * @property {string} name - Component name along with the relative path from either the client or server directory.
+ * @property {string} pkgPath - Package path.
+ */
+
+/**
+ * Updates index files if needed based on the provided parameters.
+ * @param {import('plop').ActionType} nestedRouteActions - Nested route actions.
+ * @param {string[]} rootSegments - Root segments.
+ * @param {string[]} currentDirSegments - Current directory segments.
+ * @param {boolean} isClient - Indicates whether it's a client component.
+ */
+function updateIndexFilesIfNeeded(nestedRouteActions, rootSegments, currentDirSegments, isClient) {
+  const indexFilePath = path.resolve(__dir, ...rootSegments, ...currentDirSegments, "index.ts");
+  const root = rootSegments.join("/");
+  if (!fs.existsSync(indexFilePath)) {
+    const content =
+      `${isClient ? '"use client";\n' : ""}// ${currentDirSegments.join("/")}` +
+      " component exports\n";
+    nestedRouteActions.push({
+      type: "add",
+      path: `${root + currentDirSegments.join("/")}/index.ts`,
+      template: content,
+    });
+    const length = currentDirSegments.length;
+    nestedRouteActions.push({
+      type: "append",
+      pattern: /(?<insertion> component exports)/,
+      path: `${
+        root + (length === 1 ? "" : `${currentDirSegments.slice(0, length - 1).join("/")}/`)
+      }index.ts`,
+      template: `export * from "./${currentDirSegments[length - 1]}"`,
+    });
+  }
+}
+
+/**
+ * Converts a string to kebab-case.
+ * @param {string} str - The input string.
+ * @returns {string} The string in kebab-case.
+ */
+function toKebabCase(str) {
+  return str
+    .trim()
+    .replace(/([a-z])([A-Z])/g, "$1-$2")
+    .toLowerCase()
+    .replace(/ +/g, "-");
+}
+
+/**
+ * createRootIndexAndDeclarations if not present.
+ * @param {InquirerDataType} data - Input data.
+ */
+function createRootIndexAndDeclarations(data) {
+  const nestedRouteActions = [];
+  const { isClient } = data;
+  const srcDir = path.resolve(__dir, `${data.pkgPath}/src`);
+  const [banner, target] = isClient ? ['"use client";\n\n', "client"] : ["", "server"];
+  const root = `${data.pkgPath}/src/${target}/`;
+
+  /** Create index.ts in src directory if not present.  */
+  if (!fs.existsSync(path.resolve(srcDir, "index.ts")))
+    nestedRouteActions.push({
+      type: "add",
+      path: `${data.pkgPath}/src/index.ts`,
+      template: `${banner}export * from "./${target}";\n`,
+    });
+
+  /** Create declaration if not present.  */
+  if (!fs.existsSync(path.resolve(srcDir, "declaration.d.ts")))
+    nestedRouteActions.push({
+      type: "add",
+      path: `${data.pkgPath}/src/declaration.d.ts`,
+      template: 'declare module "*.module.css";\ndeclare module "*.module.scss";\n',
+    });
+
+  /** Create index.ts in src/client or src/server directory if not present.  */
+  if (!fs.existsSync(path.resolve(__dir, root, "index.ts")))
+    nestedRouteActions.push({
+      type: "add",
+      path: `${root}index.ts`,
+      template: `${banner}/**\n * Server components and client components need to be exported from separate files as\n * directive on top of the file from which component is imported takes effect.\n * i.e., server component re-exported from file with "use client" will behave as client component\n */\n\n// ${target} component exports\n`,
+    });
+
+  return { nestedRouteActions, root, isClient };
+}
+
+/**
+ * Gets nested route actions based on the provided data.
+ * @param {InquirerDataType} data - Input data.
+ * @returns {Object} Nested route actions and parent directory.
+ */
+function getNestedRouteActions(data) {
+  const name = data.name.replace(/\/+/g, "/").replace(/\/$/, "").trim();
+  const { nestedRouteActions, root, isClient } = createRootIndexAndDeclarations(data);
+
+  if (!name.includes("/")) return { nestedRouteActions, parentDir: root };
+
+  const lastSlashInd = name.lastIndexOf("/") || name.lastIndexOf("\\");
+  data.name = name.slice(lastSlashInd + 1);
+
+  const directories = toKebabCase(name.slice(0, lastSlashInd)).split(/\/|\\/);
+  const rootSegments = [...root.split(/\/|\\/)];
+
+  for (let i = 1; i <= directories.length; i++)
+    updateIndexFilesIfNeeded(nestedRouteActions, rootSegments, directories.slice(0, i), isClient);
+
+  return { nestedRouteActions, parentDir: `${root + directories.join("/")}/` };
+}
+
+/**
+ * Gets the index action based on the provided data and parent directory.
+ * @param {InquirerDataType} data - Input data.
+ * @param {string} parentDir - Parent directory.
+ * @returns {Object} Index action.
+ */
+function getIndexAction(data, parentDir) {
+  const indFilePath = path.resolve(__dir, parentDir, toKebabCase(data.name), "index.ts");
+  if (fs.existsSync(indFilePath))
+    return {
+      type: "append",
+      pattern: /(?<insertion> component exports)/,
+      path: `${parentDir}{{kebabCase name}}/index.ts`,
+      template: 'export * from "./{{kebabCase name}}";',
+    };
+  return {
+    type: "add",
+    path: `${parentDir}{{kebabCase name}}/index.ts`,
+    template: `${data.isClient ? '"use client";\n\n' : ""}// component exports\nexport * from "./{{kebabCase name}}";\n`,
+  };
+}
+
+/**
+ * Gets actions based on the provided data.
+ * @param {InquirerDataType} data - Input data.
+ * @returns {Array} Actions.
+ */
+function getActions(data) {
+  const { nestedRouteActions, parentDir } = getNestedRouteActions(data);
+
+  return nestedRouteActions.concat([
+    getIndexAction(data, parentDir),
+    {
+      type: "add",
+      path: `${parentDir}{{kebabCase name}}/{{kebabCase name}}.tsx`,
+      templateFile: `${TEMPLATE_DIR}component.hbs`,
+    },
+    {
+      type: "add",
+      path: `${parentDir}{{kebabCase name}}/{{kebabCase name}}.test.tsx`,
+      templateFile: `${TEMPLATE_DIR}component.test.hbs`,
+    },
+    {
+      type: "add",
+      path: `${parentDir}{{kebabCase name}}/{{kebabCase name}}.module.scss`,
+      templateFile: `${TEMPLATE_DIR}component.module.hbs`,
+    },
+    {
+      type: "append",
+      pattern: /(?<insertion> component exports)/,
+      path: `${parentDir}index.ts`,
+      template: 'export * from "./{{kebabCase name}}";',
+    },
+  ]);
+}
+
+/** Export rc generator */
+module.exports = {
+  description: "Adds a new React component to the selected package.",
+  prompts: [
+    {
+      type: "list",
+      name: "pkgPath",
+      choices: [
+        "lib",
+        "packages/components/common",
+        "packages/components/sections",
+        "packages/shared",
+      ],
+      default: "packages/components/common",
+      message: "Select the package",
+    },
+    {
+      type: "input",
+      name: "name",
+      message: "What is the name of the component?",
+    },
+    {
+      type: "confirm",
+      name: "isClient",
+      message: 'Is this a client component? (Should we add "use client" directive?)',
+    },
+    {
+      type: "input",
+      name: "description",
+      message: "Describe your component. (This will be added as js-doc comment.)",
+    },
+  ],
+  actions: data => (data ? getActions(data) : []),
+};

package/rebrand.config.json

@@ -0,0 +1,6 @@
+{
+  "packageName": "components-library",
+  "owner": "stackshift-ui",
+  "repo": "components-library",
+  "title": "StackShift UI"
+}

package/rebrand.js

@@ -0,0 +1,145 @@
+const fs = require("node:fs");
+const path = require("node:path");
+// skipcq: JS-0258
+const { prompt } = require("enquirer");
+const { execSync } = require("child_process");
+
+const [owner, repo] = execSync(
+  'git remote get-url --push origin | sed "s/https:\\/\\/github.com\\///" | sed "s/.git//"',
+)
+  .toString()
+  .trim()
+  .split("/");
+
+const packageName = repo;
+
+/** avoiding IIFE as formettter keeps misformettting IIFEs */
+const rebrandFn = async () => {
+  const { shouldRebrand } = await prompt({
+    type: "confirm",
+    name: "shouldRebrand",
+    message: "Do you want to rebrand this repo?",
+    initial: true,
+  });
+
+  if (!shouldRebrand) return;
+
+  // if .tkb is not moved - setup workflow was not triggered or could not create the required commit
+  if (fs.existsSync(path.resolve(process.cwd(), "scripts", ".tkb"))) {
+    `rm .tkb
+          mv ./scripts/.tkb ./.tkb
+          rm -rf ./docs`
+      .split("\n")
+      .forEach(cmd => execSync(cmd.trim()));
+  }
+
+  const { installExt, ...answers } = await prompt([
+    {
+      type: "input",
+      name: "packageName",
+      message: "What is the name of your library?",
+      initial: packageName,
+    },
+    {
+      type: "input",
+      name: "owner",
+      message:
+        "Who is the owner of this repo? (GitHub user or organization login, .e.g, mayank1513)",
+      initial: owner,
+    },
+    {
+      type: "input",
+      name: "repo",
+      message: "What is the name of your repository?",
+      initial: repo,
+    },
+    {
+      type: "input",
+      name: "title",
+      message: "What is the title of your project?",
+      initial: packageName
+        .split("-")
+        .map(w => w[0].toUpperCase() + w.slice(1))
+        .join(" "),
+    },
+    {
+      type: "confirm",
+      name: "installExt",
+      message: "Do you want to install the recommended VS Code extensions?",
+      initial: true,
+    },
+  ]);
+
+  if (installExt) {
+    console.log("\x1b[32m", "Installing recommended VS Code extensions...");
+    execSync("code --install-extension mayank1513.trello-kanban-task-board");
+    execSync("code --install-extension esbenp.prettier-vscode");
+  }
+
+  console.log("\x1b[32m", "Creating rebrand.config.json...");
+  fs.writeFileSync(
+    path.resolve(process.cwd(), "scripts", "rebrand.config.json"),
+    JSON.stringify(answers, null, 2),
+  );
+
+  console.log("\x1b[32m", "rebranding...");
+  execSync("node ./scripts/rebrander.js");
+
+  console.log("\x1b[32m", "...");
+  console.log("\x1b[32m", "...");
+  console.log("\x1b[32m", "...");
+  console.log("\x1b[32m", "Clean up repo by removing things that you don't need");
+
+  const { pkgs } = await prompt({
+    type: "multiselect",
+    name: "pkgs",
+    message: "Select the examples or packages to remove",
+    choices: [
+      {
+        name: "examples/express",
+        message:
+          "Express.js example at examples/express -- You might want to keep this for server or API related functionality provided by your app.",
+      },
+      { name: "examples/remix", message: "Remix example at examples/remix." },
+      {
+        name: "packages/logger",
+        message:
+          "Logger package at packages/logger. The express example uses logger - handle it if needed.",
+      },
+      {
+        name: "packages/jest-presets",
+        message:
+          "We use vitest. You can keep this in case you want to use Jest. Note that the express example and logger package are set up to use jest with this jest-presets.",
+      },
+    ],
+  });
+
+  pkgs.forEach(pkg => execSync(`rm -rf ${pkg}`));
+
+  console.log("\x1b[32m", "90% of rebranding completed!");
+  console.log("\x1b[36m%s", ".");
+  console.log("\x1b[36m%s", ".");
+  console.log(
+    "\x1b[36m",
+    "Please open TKB (Workspace) and clear the Kanban Board to complete setting up your repo.",
+  );
+  console.log("\x1b[36m", ".");
+  console.log(
+    "\x1b[35m",
+    "To open TKB (Workspace) click on the `TKB (Workspace)` button on the vscode taskbar or follow these steps.",
+  );
+  console.log("\x1b[36m", ".");
+  console.log("\x1b[36m", "  1. Press `Ctrl/command` + `Shift` + `P` to open the command palette.");
+  console.log(
+    "\x1b[36m",
+    "  2. Type 'TrelloKanban: Workspace' and hit Enter to open the TKB (Workspace).",
+  );
+  console.log("\x1b[36m", ".");
+  console.log("\x1b[36m", ".");
+  console.log(
+    "\x1b[33m",
+    "If you have any issues, please raise an issue at https://github.com/react18-tools/turborepo-template/issues",
+  );
+};
+
+rebrandFn();