feat: override default config files

simple config override options for cli regex match tailwind file extension add lint rule to remove invalid end of line linting error
t3-oss · Jan 16, 2023 · 9afc402 · 9afc402
1 parent a36a100
commit 9afc402
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 7 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -44,5 +44,11 @@ module.exports = {
       "error",
       { argsIgnorePattern: "^_", destructuredArrayIgnorePattern: "^_" },
     ],
+    "prettier/prettier": [
+      "error",
+      {
+        endOfLine: "auto",
+      },
+    ],
   },
 };
diff --git a/cli/src/cli/index.ts b/cli/src/cli/index.ts
@@ -18,6 +18,8 @@ interface CliFlags {
   trpc: boolean /** @internal - used in CI */;
   prisma: boolean /** @internal - used in CI */;
   nextAuth: boolean /** @internal - used in CI */;
+  twConfig: undefined | string;
+  tsConfig: undefined | string;
 }
 
 interface CliResults {
@@ -38,6 +40,8 @@ const defaultOptions: CliResults = {
     trpc: false,
     prisma: false,
     nextAuth: false,
+    twConfig: undefined,
+    tsConfig: undefined,
   },
 };
 
@@ -69,6 +73,17 @@ export const runCli = async () => {
       "Bypass the CLI and use all default options to bootstrap a new t3-app",
       false,
     )
+    .option(
+      "--twConfig [path]",
+      "Path to a custom tailwind.congif.cjs file",
+      (value) =>
+        value.match(/(tailwind\.config)\.(js|cjs)/) ? value : undefined,
+    )
+    .option(
+      "--tsConfig [path]",
+      "Path to a custom tsconfig.json file",
+      (value) => (value.includes("tsconfig.json") ? value : undefined),
+    )
     /** START CI-FLAGS */
     /**
      * @experimental - used for CI E2E tests

diff --git a/cli/src/helpers/createProject.ts b/cli/src/helpers/createProject.ts
@@ -4,17 +4,22 @@ import { installPackages } from "~/helpers/installPackages.js";
 import { scaffoldProject } from "~/helpers/scaffoldProject.js";
 import { selectAppFile, selectIndexFile } from "~/helpers/selectBoilerplate.js";
 import { getUserPkgManager } from "~/utils/getUserPkgManager.js";
+import { overrideConfigs } from "~/helpers/overrideConfigs.js";
 
 interface CreateProjectOptions {
   projectName: string;
   packages: PkgInstallerMap;
   noInstall: boolean;
+  twConfig?: string | undefined;
+  tsConfig?: string | undefined;
 }
 
 export const createProject = async ({
   projectName,
   packages,
   noInstall,
+  twConfig,
+  tsConfig,
 }: CreateProjectOptions) => {
   const pkgManager = getUserPkgManager();
   const projectDir = path.resolve(process.cwd(), projectName);
@@ -35,6 +40,14 @@ export const createProject = async ({
     noInstall,
   });
 
+  // Overriding default configuration files with the selected boilerplate
+  overrideConfigs({
+    tsConfig,
+    twConfig,
+    projectDir,
+    packages,
+  });
+
   // TODO: Look into using handlebars or other templating engine to scaffold without needing to maintain multiple copies of the same file
   selectAppFile({ projectDir, packages });
   selectIndexFile({ projectDir, packages });

diff --git a/cli/src/helpers/overrideConfigs.ts b/cli/src/helpers/overrideConfigs.ts
@@ -0,0 +1,49 @@
+import ora from "ora";
+import { PkgInstallerMap } from "~/installers/index.js";
+import fs from "fs-extra";
+import path from "path";
+
+type overrideConfigOptions = {
+  twConfig?: string | undefined;
+  tsConfig?: string | undefined;
+  packages?: PkgInstallerMap;
+  projectDir: string;
+};
+
+export const overrideConfigs = ({
+  twConfig,
+  tsConfig,
+  packages,
+  projectDir,
+}: overrideConfigOptions) => {
+  if (twConfig !== undefined || tsConfig !== undefined) {
+    const spinner = ora("Config overrides detected").start();
+    spinner.info("Config overrides detected");
+    if (twConfig) {
+      if (fs.existsSync(twConfig) && packages?.tailwind?.inUse) {
+        spinner.info(`Overriding default tailwind.config.cjs with ${twConfig}`);
+        fs.unlinkSync(path.join(projectDir, "tailwind.config.cjs"));
+        fs.copyFileSync(twConfig, path.join(projectDir, "tailwind.config.cjs"));
+        spinner.info("successfully copied tailwind config");
+      } else if (!packages?.tailwind?.inUse) {
+        spinner.info("Tailwind not in use, skipping override");
+      } else {
+        spinner.fail(`Could not find ${twConfig}`);
+      }
+    }
+    if (tsConfig) {
+      if (fs.existsSync(tsConfig)) {
+        spinner.info(`Overriding default tsconfig.json with ${tsConfig}`);
+        fs.unlinkSync(path.join(projectDir, "tsconfig.json"));
+        fs.copyFileSync(tsConfig, path.join(projectDir, "tsconfig.json"));
+        spinner.info("successfully copied typescript config");
+      } else {
+        spinner.fail(`Could not find ${tsConfig}`);
+      }
+    }
+    spinner.warn(
+      "WARNING: create-t3-app does not take responsibility for any issues caused by overriding default configs",
+    );
+    spinner.succeed("Config overrides complete");
+  }
+};
diff --git a/cli/src/index.ts b/cli/src/index.ts
@@ -31,7 +31,7 @@ const main = async () => {
   const {
     appName,
     packages,
-    flags: { noGit, noInstall },
+    flags: { noGit, noInstall, twConfig, tsConfig },
   } = await runCli();
 
   const usePackages = buildPkgInstallerMap(packages);
@@ -43,6 +43,8 @@ const main = async () => {
     projectName: appDir,
     packages: usePackages,
     noInstall,
+    twConfig,
+    tsConfig,
   });
 
   // Write name to package.json

diff --git a/www/src/pages/en/installation.md b/www/src/pages/en/installation.md
@@ -29,12 +29,14 @@ After your app has been scaffolded, check out the [first steps](/en/usage/first-
 
 ## Advanced usage
 
-| Option/Flag       | Description                                                             |
-| ----------------- | ----------------------------------------------------------------------- |
-| `[dir]`           | Include a directory argument with a name for the project                |
-| `--noGit`         | Explicitly tell the CLI to not initialize a new git repo in the project |
-| `-y`, `--default` | Bypass the CLI and bootstrap a new t3-app with all options selected     |
-| `--noInstall`     | Generate project without installing dependencies                        |
+| Option/Flag         | Description                                                             |
+| ------------------- | ----------------------------------------------------------------------- |
+| `[dir]`             | Include a directory argument with a name for the project                |
+| `--noGit`           | Explicitly tell the CLI to not initialize a new git repo in the project |
+| `-y`, `--default`   | Bypass the CLI and bootstrap a new t3-app with all options selected     |
+| `--noInstall`       | Generate project without installing dependencies                        |
+| `--tsConfig [path]` | Override default typescript config file. File path must be absolute.    |
+| `--twConfig [path]` | Override default tailwind config file. File path must be absolute.      |
 
 ## Experimental usage