Refactor package dependency management and environment setup

This commit is contained in:
Aman Varshney
2025-03-20 16:31:09 +05:30
parent 938ddda351
commit 3172b5bebb
6 changed files with 93 additions and 113 deletions

View File

@@ -27,12 +27,10 @@ export async function setupAuth(
} }
addPackageDependency({ addPackageDependency({
dependencies: ["better-auth"], dependencies: ["better-auth"],
devDependencies: false,
projectDir: serverDir, projectDir: serverDir,
}); });
addPackageDependency({ addPackageDependency({
dependencies: ["better-auth"], dependencies: ["better-auth"],
devDependencies: false,
projectDir: clientDir, projectDir: clientDir,
}); });
} catch (error) { } catch (error) {

View File

@@ -62,6 +62,33 @@ export async function createProject(options: ProjectConfig): Promise<string> {
await setupAddons(projectDir, options.addons); await setupAddons(projectDir, options.addons);
} }
await updatePackageConfigurations(projectDir, options);
await createReadme(projectDir, options);
displayPostInstallInstructions(
options.database,
options.projectName,
options.packageManager,
!options.noInstall,
options.orm,
);
return projectDir;
} catch (error) {
s.message(pc.red("Failed"));
if (error instanceof Error) {
cancel(pc.red(`Error during project creation: ${error.message}`));
process.exit(1);
}
throw error;
}
}
async function updatePackageConfigurations(
projectDir: string,
options: ProjectConfig,
) {
const rootPackageJsonPath = path.join(projectDir, "package.json"); const rootPackageJsonPath = path.join(projectDir, "package.json");
if (await fs.pathExists(rootPackageJsonPath)) { if (await fs.pathExists(rootPackageJsonPath)) {
const packageJson = await fs.readJson(rootPackageJsonPath); const packageJson = await fs.readJson(rootPackageJsonPath);
@@ -90,13 +117,13 @@ export async function createProject(options: ProjectConfig): Promise<string> {
if (options.database !== "none") { if (options.database !== "none") {
if (options.database === "sqlite") { if (options.database === "sqlite") {
serverPackageJson.scripts["db:local"] = serverPackageJson.scripts["db:local"] = "turso dev --db-file local.db";
"turso dev --db-file local.db";
} }
if (options.auth) { if (options.auth) {
serverPackageJson.scripts["auth:generate"] = serverPackageJson.scripts["auth:generate"] =
"npx @better-auth/cli generate --output ./src/db/auth-schema.ts"; "npx @better-auth/cli generate --output ./src/db/auth-schema.ts";
}
if (options.orm === "prisma") { if (options.orm === "prisma") {
serverPackageJson.scripts["db:push"] = "prisma db push"; serverPackageJson.scripts["db:push"] = "prisma db push";
@@ -105,41 +132,12 @@ export async function createProject(options: ProjectConfig): Promise<string> {
serverPackageJson.scripts["db:push"] = "drizzle-kit push"; serverPackageJson.scripts["db:push"] = "drizzle-kit push";
serverPackageJson.scripts["db:studio"] = "drizzle-kit studio"; serverPackageJson.scripts["db:studio"] = "drizzle-kit studio";
} }
} else {
if (options.orm === "prisma") {
serverPackageJson.scripts["db:push"] = "prisma db push";
serverPackageJson.scripts["db:studio"] = "prisma studio";
} else if (options.orm === "drizzle") {
serverPackageJson.scripts["db:push"] = "drizzle-kit push";
serverPackageJson.scripts["db:studio"] = "drizzle-kit studio";
}
}
} }
await fs.writeJson(serverPackageJsonPath, serverPackageJson, { await fs.writeJson(serverPackageJsonPath, serverPackageJson, {
spaces: 2, spaces: 2,
}); });
} }
await createReadme(projectDir, options);
displayPostInstallInstructions(
options.database,
options.projectName,
options.packageManager,
!options.noInstall,
options.orm,
);
return projectDir;
} catch (error) {
s.message(pc.red("Failed"));
if (error instanceof Error) {
cancel(pc.red(`Error during project creation: ${error.message}`));
process.exit(1);
}
throw error;
}
} }
function getOrmTemplateDir(orm: ProjectOrm, database: ProjectDatabase): string { function getOrmTemplateDir(orm: ProjectOrm, database: ProjectDatabase): string {

View File

@@ -69,10 +69,10 @@ ${generateScriptsList(packageManagerRunCmd, database, orm, auth)}
} }
function generateFeaturesList( function generateFeaturesList(
database: string, database: ProjectDatabase,
auth: boolean, auth: boolean,
features: string[], features: string[],
orm: string, orm: ProjectOrm,
): string { ): string {
const featuresList = [ const featuresList = [
"- **TypeScript** - For type safety and improved developer experience", "- **TypeScript** - For type safety and improved developer experience",

View File

@@ -2,13 +2,14 @@ import path from "node:path";
import { log, spinner } from "@clack/prompts"; import { log, spinner } from "@clack/prompts";
import fs from "fs-extra"; import fs from "fs-extra";
import pc from "picocolors"; import pc from "picocolors";
import type { ProjectDatabase, ProjectOrm } from "../types";
import { addPackageDependency } from "../utils/add-package-deps"; import { addPackageDependency } from "../utils/add-package-deps";
import { setupTurso } from "./turso-setup"; import { setupTurso } from "./turso-setup";
export async function setupDatabase( export async function setupDatabase(
projectDir: string, projectDir: string,
databaseType: string, databaseType: ProjectDatabase,
orm: string, orm: ProjectOrm,
setupTursoDb = true, setupTursoDb = true,
): Promise<void> { ): Promise<void> {
const s = spinner(); const s = spinner();
@@ -23,49 +24,32 @@ export async function setupDatabase(
if (databaseType === "sqlite") { if (databaseType === "sqlite") {
if (orm === "drizzle") { if (orm === "drizzle") {
addPackageDependency({ addPackageDependency({
dependencies: ["drizzle-orm", "drizzle-kit", "@libsql/client"], dependencies: ["drizzle-orm", "@libsql/client"],
devDependencies: false, devDependencies: ["drizzle-kit"],
projectDir: serverDir, projectDir: serverDir,
}); });
if (setupTursoDb) {
await setupTurso(projectDir, true);
}
} else if (orm === "prisma") { } else if (orm === "prisma") {
addPackageDependency({ addPackageDependency({
dependencies: ["@prisma/client"], dependencies: ["@prisma/client"],
devDependencies: false, devDependencies: ["prisma"],
projectDir: serverDir,
});
addPackageDependency({
dependencies: ["prisma"],
devDependencies: true,
projectDir: serverDir, projectDir: serverDir,
}); });
}
if (setupTursoDb) { if (setupTursoDb) {
await setupTurso(projectDir, true); await setupTurso(projectDir, true);
} }
}
} else if (databaseType === "postgres") { } else if (databaseType === "postgres") {
if (orm === "drizzle") { if (orm === "drizzle") {
addPackageDependency({ addPackageDependency({
dependencies: ["drizzle-orm", "postgres"], dependencies: ["drizzle-orm", "postgres"],
devDependencies: false, devDependencies: ["drizzle-kit"],
projectDir: serverDir,
});
addPackageDependency({
dependencies: ["drizzle-kit"],
devDependencies: true,
projectDir: serverDir, projectDir: serverDir,
}); });
} else if (orm === "prisma") { } else if (orm === "prisma") {
addPackageDependency({ addPackageDependency({
dependencies: ["@prisma/client"], dependencies: ["@prisma/client"],
devDependencies: false, devDependencies: ["prisma"],
projectDir: serverDir,
});
addPackageDependency({
dependencies: ["prisma"],
devDependencies: true,
projectDir: serverDir, projectDir: serverDir,
}); });
} }

View File

@@ -29,6 +29,12 @@ export async function setupEnvironmentVariables(
if (!envContent.includes("CORS_ORIGIN")) { if (!envContent.includes("CORS_ORIGIN")) {
envContent += "\nCORS_ORIGIN=http://localhost:3001"; envContent += "\nCORS_ORIGIN=http://localhost:3001";
} }
const clientEnvPath = path.join(clientDir, ".env");
if (!(await fs.pathExists(clientEnvPath))) {
const clientEnvContent = "VITE_SERVER_URL=http://localhost:3000\n";
await fs.writeFile(clientEnvPath, clientEnvContent);
}
} }
if (options.database !== "none") { if (options.database !== "none") {
@@ -40,22 +46,12 @@ export async function setupEnvironmentVariables(
envContent += databaseUrlLine; envContent += databaseUrlLine;
} }
if (options.database === "sqlite") { if (options.database === "sqlite" && !options.turso) {
if (!envContent.includes("TURSO_CONNECTION_URL")) { if (!envContent.includes("TURSO_CONNECTION_URL")) {
if (!options.turso) {
envContent += "\nTURSO_CONNECTION_URL=http://127.0.0.1:8080"; envContent += "\nTURSO_CONNECTION_URL=http://127.0.0.1:8080";
} }
} }
} }
}
await fs.writeFile(envPath, envContent.trim()); await fs.writeFile(envPath, envContent.trim());
if (options.auth) {
const clientEnvPath = path.join(clientDir, ".env");
if (!(await fs.pathExists(clientEnvPath))) {
const clientEnvContent = "VITE_SERVER_URL=http://localhost:3000\n";
await fs.writeFile(clientEnvPath, clientEnvContent);
}
}
} }

View File

@@ -4,25 +4,29 @@ import fs from "fs-extra";
import { type AvailableDependencies, dependencyVersionMap } from "../constants"; import { type AvailableDependencies, dependencyVersionMap } from "../constants";
export const addPackageDependency = (opts: { export const addPackageDependency = (opts: {
dependencies: AvailableDependencies[]; dependencies?: AvailableDependencies[];
devDependencies: boolean; devDependencies?: AvailableDependencies[];
projectDir: string; projectDir: string;
}) => { }) => {
const { dependencies, devDependencies, projectDir } = opts; const { dependencies = [], devDependencies = [], projectDir } = opts;
const pkgJson = fs.readJSONSync(path.join(projectDir, "package.json")); const pkgJsonPath = path.join(projectDir, "package.json");
const pkgJson = fs.readJSONSync(pkgJsonPath);
if (!pkgJson.dependencies) pkgJson.dependencies = {};
if (!pkgJson.devDependencies) pkgJson.devDependencies = {};
for (const pkgName of dependencies) { for (const pkgName of dependencies) {
const version = dependencyVersionMap[pkgName]; const version = dependencyVersionMap[pkgName];
if (devDependencies && pkgJson.devDependencies) {
pkgJson.devDependencies[pkgName] = version;
} else if (pkgJson.dependencies) {
pkgJson.dependencies[pkgName] = version; pkgJson.dependencies[pkgName] = version;
} }
for (const pkgName of devDependencies) {
const version = dependencyVersionMap[pkgName];
pkgJson.devDependencies[pkgName] = version;
} }
fs.writeJSONSync(path.join(projectDir, "package.json"), pkgJson, { fs.writeJSONSync(pkgJsonPath, pkgJson, {
spaces: 2, spaces: 2,
}); });
}; };