feat: add tsconfig.build.json to cli

Author: christopher-buss

src/cli/constants.ts

@@ -1,8 +1,7 @@
-import pico from "picocolors";
-
-import type { FrameworkOption, PromItem } from "./types";
-
 export const vscodeSettingsString = `
+  // Enable the ESlint flat config support
+	"eslint.useFlatConfig": true,
+
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
   "editor.formatOnSave": false,
@@ -35,20 +34,11 @@ export const vscodeSettingsString = `
     "json",
     "jsonc",
     "yaml",
-	"toml",
-	"luau"
+	  "toml",
+	  "luau"
   ]
 `;
 
-export const frameworkOptions: Array<PromItem<FrameworkOption>> = [
-	{
-		label: pico.cyan("React"),
-		value: "react",
-	},
-];
-
-export const frameworks: Array<FrameworkOption> = frameworkOptions.map(({ value }) => value);
-
 export const dependenciesMap = {
 	react: ["@eslint-react/eslint-plugin", "eslint-plugin-react-hooks"],
 } as const;

src/cli/run.ts

@@ -5,11 +5,11 @@ import path from "node:path";
 import process from "node:process";
 import pico from "picocolors";
 
-import { frameworkOptions, frameworks } from "./constants";
+import { addTsconfigBuild } from "./stages/add-tsconfig.build.json";
 import { updateEslintFiles } from "./stages/update-eslint-files";
 import { updatePackageJson } from "./stages/update-package-json";
 import { updateVscodeSettings } from "./stages/update-vscode-settings";
-import type { FrameworkOption, PromItem, PromptResult } from "./types";
+import type { FrameworkOption, PromptResult } from "./types";
 import { isGitClean } from "./utils";
 
 export interface CliRunOptions {
@@ -38,26 +38,6 @@ export async function run(options: CliRunOptions = {}): Promise<undefined> {
 	if (!argumentSkipPrompt) {
 		result = (await p.group(
 			{
-				frameworks: ({ results }) => {
-					const isArgumentTemplateValid =
-						typeof argumentTemplate === "string" &&
-						!!frameworks.includes(<FrameworkOption>argumentTemplate);
-
-					if (!results.uncommittedConfirmed || isArgumentTemplateValid) {
-						return;
-					}
-
-					const message =
-						!isArgumentTemplateValid && argumentTemplate
-							? `"${argumentTemplate}" isn't a valid template. Please choose from below: `
-							: "Select a framework:";
-
-					return p.multiselect<Array<PromItem<FrameworkOption>>, FrameworkOption>({
-						message: pico.reset(message),
-						options: frameworkOptions,
-						required: false,
-					});
-				},
 				uncommittedConfirmed: () => {
 					if (argumentSkipPrompt || isGitClean()) {
 						return Promise.resolve(true);
@@ -94,9 +74,10 @@ export async function run(options: CliRunOptions = {}): Promise<undefined> {
 		}
 	}
 
-	await updatePackageJson(result);
-	await updateEslintFiles(result);
+	await updatePackageJson();
+	await updateEslintFiles();
 	await updateVscodeSettings(result);
+	await addTsconfigBuild();
 
 	p.log.success(pico.green(`Setup completed`));
 	p.outro(`Now you can update the dependencies and run ${pico.blue("eslint . --fix")}\n`);

src/cli/stages/add-tsconfig.build.json.ts

@@ -0,0 +1,32 @@
+import * as p from "@clack/prompts";
+
+import fs from "node:fs";
+import fsp from "node:fs/promises";
+import path from "path";
+import pico from "picocolors";
+
+export async function addTsconfigBuild(): Promise<void> {
+	const cwd = process.cwd();
+
+	const pathTsconfigBuild = path.join(cwd, "tsconfig.build.json");
+
+	if (fs.existsSync(pathTsconfigBuild)) {
+		p.log.info(pico.yellow("tsconfig.build.json already exists"));
+		return;
+	}
+
+	const tsconfigBuildContent = `{
+	"extends": "./tsconfig.json",
+	"include": ["src/**/*", "eslint.config.ts"],
+	"exclude": ["node_modules"]
+	}
+	`;
+
+	await fsp.writeFile(pathTsconfigBuild, tsconfigBuildContent, "utf-8");
+	p.log.success(pico.green(`Created tsconfig.build.json`));
+	p.log.info(
+		pico.yellow(
+			`You must add '"exclude": ["./eslint.config.ts"]' to your tsconfig.json. In the future, this will be done automatically.`,
+		),
+	);
+}

src/cli/stages/update-eslint-files.ts

@@ -9,10 +9,9 @@ import process from "node:process";
 import parse from "parse-gitignore";
 import pico from "picocolors";
 
-import type { PromptResult } from "../types";
 import { getEslintConfigContent } from "../utils";
 
-export async function updateEslintFiles(result: PromptResult): Promise<void> {
+export async function updateEslintFiles(): Promise<void> {
 	const cwd = process.cwd();
 	const pathESLintIgnore = path.join(cwd, ".eslintignore");
 	const pathPackageJSON = path.join(cwd, "package.json");
@@ -45,9 +44,14 @@ export async function updateEslintFiles(result: PromptResult): Promise<void> {
 		configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
 	}
 
-	for (const framework of result.frameworks) {
-		configLines.push(`${framework}: true,`);
-	}
+	configLines.push(
+		`${"react"}: true,`,
+		`typescript: {
+			parserOptions: {
+				project: "tsconfig.build.json",
+			},
+		},`,
+	);
 
 	const mainConfig = configLines.map(index => `  ${index}`).join("\n");
 	const additionalConfig: Array<string> = [];

src/cli/stages/update-package-json.ts

@@ -6,9 +6,8 @@ import process from "node:process";
 import pico from "picocolors";
 
 import { dependenciesMap, pkgJson as packageJson } from "../constants";
-import type { PromptResult } from "../types";
 
-export async function updatePackageJson(result: PromptResult): Promise<void> {
+export async function updatePackageJson(): Promise<void> {
 	const cwd = process.cwd();
 
 	const pathPackageJSON = path.join(cwd, "package.json");
@@ -26,16 +25,9 @@ export async function updatePackageJson(result: PromptResult): Promise<void> {
 
 	const addedPackages: Array<string> = [];
 
-	for (const framework of result.frameworks) {
-		const deps = dependenciesMap[framework];
-		if (!deps) {
-			continue;
-		}
-
-		for (const dep of deps) {
-			package_.devDependencies[dep] = packageJson.devDependencies[dep];
-			addedPackages.push(dep);
-		}
+	for (const dep of dependenciesMap["react"]) {
+		package_.devDependencies[dep] = packageJson.devDependencies[dep];
+		addedPackages.push(dep);
 	}
 
 	if (addedPackages.length) {

src/configs/typescript.ts

@@ -115,8 +115,11 @@ export async function typescript(
 			languageOptions: {
 				parser: parserTs,
 				parserOptions: {
+					ecmaVersion: 2018,
 					extraFileExtensions: componentExtensions.map(extension => `.${extension}`),
+					jsx: true,
 					sourceType: "module",
+					useJSXTextNode: true,
 					...(tsconfigPath
 						? {
 								project: tsconfigPath,