feat(turbo-gen): support TS config files

vercel · May 15, 2023 · 00f75d6 · 00f75d6
1 parent 21bc5ab
commit 00f75d6
Show file tree

Hide file tree

Showing 13 changed files with 397 additions and 102 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -30,13 +30,15 @@
     "next-themes": "^0.2.0",
     "nextra": "^2.1.0",
     "nextra-theme-docs": "^2.1.0",
+    "node-fetch": "^2.6.8",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "sharp": "^0.32.1",
     "swr": "1.3.0"
   },
   "devDependencies": {
     "@babel/core": "7.20.12",
+    "@turbo/gen": "workspace:*",
     "@turbo/types": "workspace:*",
     "@types/node": "^16.11.12",
     "@types/react": "18.2.0",

diff --git a/docs/turbo/generators/config.js → docs/turbo/generators/config.ts b/docs/turbo/generators/config.js → docs/turbo/generators/config.ts
@@ -1,10 +1,11 @@
-const fs = require("fs");
-const { releasePostStats, dateToday, majorMinor } = require("./utils");
+import fs from "fs";
+import { releasePostStats } from "./utils";
+import * as helpers from "./helpers";
+import type { PlopTypes } from "@turbo/gen";
 
-module.exports = function (plop) {
+export default function generator(plop: PlopTypes.NodePlopAPI): void {
   // add helpers for use in templates
-  plop.setHelper("dateToday", dateToday);
-  plop.setHelper("majorMinor", majorMinor);
+  helpers.init(plop);
 
   // create generators
   plop.setGenerator("blog - release post", {
@@ -97,7 +98,6 @@ module.exports = function (plop) {
       {
         type: "list",
         name: "post",
-        loop: false,
         pageSize: 20,
         message: "Which release post should the stats be updated?",
         choices: () => {
@@ -143,4 +143,4 @@ module.exports = function (plop) {
       },
     ],
   });
-};
+}
diff --git a/docs/turbo/generators/helpers.ts b/docs/turbo/generators/helpers.ts
@@ -0,0 +1,14 @@
+import type { PlopTypes } from "@turbo/gen";
+
+// helpers
+const dateToday = (): string =>
+  new Date().toISOString().split("T")[0].replace(/-/g, "/");
+
+const majorMinor = (version: string): string =>
+  version.split(".").slice(0, 2).join(".");
+
+export function init(plop: PlopTypes.NodePlopAPI): void {
+  // add helpers for use in templates
+  plop.setHelper("dateToday", dateToday);
+  plop.setHelper("majorMinor", majorMinor);
+}
diff --git a/docs/turbo/generators/utils.js b/docs/turbo/generators/utils.js
diff --git a/docs/turbo/generators/utils.ts b/docs/turbo/generators/utils.ts
@@ -0,0 +1,64 @@
+import fetch from "node-fetch";
+
+interface Answers extends Object {
+  turboStars: string;
+  turboDownloads: string;
+  turboYearsSaved: string;
+}
+
+const PUBLIC_TB_TOKEN =
+  "p.eyJ1IjogIjAzYzA0Y2MyLTM1YTAtNDhhNC05ZTZjLThhMWE0NGNhNjhkZiIsICJpZCI6ICJmOWIzMTU5Yi0wOTVjLTQyM2UtOWIwNS04ZDZlNzIyNjEwNzIifQ.A3TOPdm3Lhmn-1x5m6jNvulCQbbgUeQfAIO3IaaAt5k";
+
+export async function releasePostStats(answers: Answers): Promise<string> {
+  const [starsResponse, downloadsResponse, timeSavedResponse] =
+    await Promise.all([
+      fetch("https://api.github.com/repos/vercel/turbo"),
+      fetch("https://api.npmjs.org/versions/turbo/last-week"),
+      fetch(
+        `https://api.us-east.tinybird.co/v0/pipes/turborepo_time_saved_ticker.json?token=${PUBLIC_TB_TOKEN}`
+      ),
+    ]);
+
+  const [starsData, downloadsData, timeSavedData] = await Promise.all([
+    starsResponse.json() as { stargazers_count: number },
+    downloadsResponse.json() as {
+      downloads: Array<{ [key: string]: number }>;
+    },
+    timeSavedResponse.json() as {
+      data: [
+        {
+          remote_cache_minutes_saved: number;
+          local_cache_minutes_saved: number;
+        }
+      ];
+    },
+  ]);
+
+  const totalMinutesSaved: number =
+    timeSavedData.data[0].remote_cache_minutes_saved +
+    timeSavedData.data[0].local_cache_minutes_saved;
+  const totalYearsSaved: number = Math.floor(totalMinutesSaved / 60 / 24 / 365);
+  const weeklyDownloads: number = Object.keys(downloadsData.downloads).reduce(
+    (sum, version) => sum + downloadsData.downloads[version],
+    0
+  );
+
+  console.log(JSON.stringify(weeklyDownloads));
+
+  const prettyRound = (num: number): string => {
+    if (num < 1000) {
+      return num.toString();
+    } else if (num < 1000000) {
+      return (num / 1000).toFixed(1) + "k";
+    } else {
+      return (num / 1000000).toFixed(1) + "M";
+    }
+  };
+
+  // extend answers
+  answers.turboStars = prettyRound(starsData.stargazers_count);
+  answers.turboDownloads = prettyRound(weeklyDownloads);
+  answers.turboYearsSaved = prettyRound(totalYearsSaved);
+
+  return "Fetched stats for release post";
+}
diff --git a/packages/turbo-codemod/package.json b/packages/turbo-codemod/package.json
@@ -36,6 +36,11 @@
     "update-check": "^1.5.4"
   },
   "devDependencies": {
+    "@turbo/gen": "workspace:*",
+    "@turbo/test-utils": "workspace:*",
+    "@turbo/tsconfig": "workspace:*",
+    "@turbo/types": "workspace:*",
+    "@turbo/utils": "workspace:*",
     "@types/chalk-animation": "^1.6.0",
     "@types/diff": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
@@ -51,11 +56,7 @@
     "plop": "^3.1.1",
     "semver": "^7.3.5",
     "ts-jest": "^27.1.1",
-    "@turbo/tsconfig": "workspace:*",
-    "tsup": "^5.10.3",
-    "@turbo/test-utils": "workspace:*",
-    "@turbo/types": "workspace:*",
-    "@turbo/utils": "workspace:*",
+    "tsup": "^6.7.0",
     "typescript": "^4.5.5"
   },
   "files": [

diff --git a/.../turbo-codemod/turbo/generators/config.js → .../turbo-codemod/turbo/generators/config.ts b/.../turbo-codemod/turbo/generators/config.js → .../turbo-codemod/turbo/generators/config.ts
@@ -1,7 +1,11 @@
-const fs = require("fs-extra");
-const path = require("path");
+import path from "path";
+import fs from "fs-extra";
+import type { PlopTypes } from "@turbo/gen";
 
-module.exports = function (plop, config) {
+export default function generator(
+  plop: PlopTypes.NodePlopAPI,
+  config: PlopTypes.PlopCfg
+): void {
   plop.setGenerator("transformer", {
     description: "Add a new transformer",
     prompts: [
@@ -34,8 +38,11 @@ module.exports = function (plop, config) {
         path: "__tests__/{{name}}.test.ts",
         templateFile: "templates/transformer.test.hbs",
       },
-      function createFixturesDirectory(answers) {
-        process.chdir(plop.getPlopfilePath());
+      function createFixturesDirectory(answers: { name?: string }) {
+        if (!answers.name) {
+          return "no name provided, skipping fixture directory creation";
+        }
+
         const directory = path.join(
           config.destBasePath,
           "__tests__",
@@ -48,4 +55,4 @@ module.exports = function (plop, config) {
       },
     ],
   });
-};
+}
diff --git a/packages/turbo-gen/package.json b/packages/turbo-gen/package.json
@@ -13,6 +13,7 @@
     "url": "https://github.com/vercel/turbo/issues"
   },
   "bin": "dist/cli.js",
+  "types": "dist/types.d.ts",
   "scripts": {
     "build": "tsup",
     "test": "jest",
@@ -27,6 +28,7 @@
     "minimatch": "^9.0.0",
     "node-plop": "^0.26.3",
     "semver": "^7.3.8",
+    "ts-node": "^10.9.1",
     "update-check": "^1.5.4",
     "validate-npm-package-name": "^5.0.0"
   },

diff --git a/packages/turbo-gen/src/types.ts b/packages/turbo-gen/src/types.ts
@@ -1,11 +1,13 @@
-export interface DependencyGroups {
+import type * as PlopTypes from "node-plop";
+
+interface DependencyGroups {
   dependencies?: Record<string, string>;
   devDependencies?: Record<string, string>;
   peerDependencies?: Record<string, string>;
   optionalDependencies?: Record<string, string>;
 }
 
-export interface PackageJson extends DependencyGroups {
+interface PackageJson extends DependencyGroups {
   name: string;
   version: string;
   private?: boolean;
@@ -16,3 +18,5 @@ export interface PackageJson extends DependencyGroups {
   exports?: object;
   scripts?: Record<string, string>;
 }
+
+export type { PlopTypes, DependencyGroups, PackageJson };
diff --git a/packages/turbo-gen/src/utils/plop.ts b/packages/turbo-gen/src/utils/plop.ts
@@ -1,27 +1,36 @@
 import fs from "fs-extra";
 import { Project } from "@turbo/workspaces";
 import nodePlop, { NodePlopAPI, PlopGenerator } from "node-plop";
+import { register } from "ts-node";
 import path from "path";
 import inquirer from "inquirer";
 import { searchUp, getTurboConfigs, logger } from "@turbo/utils";
 import { GeneratorError } from "./error";
 
-// TODO: Support a TS config file
-const TURBO_GENERATOR_CONFIG = path.join("turbo", "generators", "config.js");
+const SUPPORTED_CONFIG_EXTENSIONS = ["ts", "js", "cjs"];
+const TURBO_GENERATOR_DIRECTORY = path.join("turbo", "generators");
 
-// support root plopfile so that users with existing configurations can use them immediately
-const DEFAULT_ROOT_CONFIG_LOCATIONS = [
-  TURBO_GENERATOR_CONFIG,
-  "plopfile.js",
-  "plopfile.cjs",
-  "plopfile.mjs",
+// config formats that will be automatically loaded from within workspaces
+const SUPPORTED_WORKSPACE_GENERATOR_CONFIGS = SUPPORTED_CONFIG_EXTENSIONS.map(
+  (ext) => path.join(TURBO_GENERATOR_DIRECTORY, `config.${ext}`)
+);
+
+// config formats that will be automatically loaded from the root (support plopfiles so that users with existing configurations can use them immediately)
+const SUPPORTED_ROOT_GENERATOR_CONFIGS = [
+  ...SUPPORTED_WORKSPACE_GENERATOR_CONFIGS,
+  ...SUPPORTED_CONFIG_EXTENSIONS.map((ext) => path.join(`plopfile.${ext}`)),
 ];
 
 export type Generator = PlopGenerator & {
   basePath: string;
   name: string;
 };
 
+// init ts-node for plop to support ts configs
+register({
+  transpileOnly: true,
+});
+
 export function getPlop({
   project,
   configPath,
@@ -44,8 +53,8 @@ export function getPlop({
     }
   } else {
     // look for a root config
-    for (const defaultConfigPath of DEFAULT_ROOT_CONFIG_LOCATIONS) {
-      const plopFile = path.join(project.paths.root, defaultConfigPath);
+    for (const configPath of SUPPORTED_ROOT_GENERATOR_CONFIGS) {
+      const plopFile = path.join(project.paths.root, configPath);
       try {
         plop = nodePlop(plopFile, {
           destBasePath: project.paths.root,
@@ -70,10 +79,14 @@ export function getPlop({
   if (plop) {
     // add in all the workspace configs
     workspaceConfigs.forEach((c) => {
-      plop?.load(c.config, {
-        destBasePath: c.root,
-        force: false,
-      });
+      try {
+        plop?.load(c.config, {
+          destBasePath: c.root,
+          force: false,
+        });
+      } catch (e) {
+        console.error(e);
+      }
     });
   }
 
@@ -199,11 +212,13 @@ function getWorkspaceGeneratorConfigs({ project }: { project: Project }) {
     root: string;
   }> = [];
   project.workspaceData.workspaces.forEach((w) => {
-    if (fs.existsSync(path.join(w.paths.root, TURBO_GENERATOR_CONFIG))) {
-      workspaceGeneratorConfigs.push({
-        config: path.join(w.paths.root, TURBO_GENERATOR_CONFIG),
-        root: w.paths.root,
-      });
+    for (const configPath of SUPPORTED_WORKSPACE_GENERATOR_CONFIGS) {
+      if (fs.existsSync(path.join(w.paths.root, configPath))) {
+        workspaceGeneratorConfigs.push({
+          config: path.join(w.paths.root, configPath),
+          root: w.paths.root,
+        });
+      }
     }
   });
   return workspaceGeneratorConfigs;

diff --git a/packages/turbo-gen/tsup.config.ts b/packages/turbo-gen/tsup.config.ts
@@ -1,8 +1,9 @@
 import { defineConfig, Options } from "tsup";
 
 export default defineConfig((options: Options) => ({
-  entry: ["src/cli.ts"],
+  entry: ["src/cli.ts", "src/types.ts"],
   format: ["cjs"],
+  dts: true,
   clean: true,
   minify: true,
   ...options,

diff --git a/packages/turbo-utils/src/index.ts b/packages/turbo-utils/src/index.ts
@@ -22,3 +22,4 @@ export * as logger from "./logger";
 // types
 export type { PackageManagerAvailable } from "./managers";
 export type { RepoInfo } from "./examples";
+export type { TurboConfigs } from "./getTurboConfigs";