Skip to content

Commit 918a8ae

Browse files
📝 Add docstrings to patch-2
Docstrings generation was requested by @AstroGD. * #713 (comment) The following files were modified: * `apps/cli/src/helpers/core/project-config.ts`
1 parent db56dfa commit 918a8ae

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

apps/cli/src/helpers/core/project-config.ts

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ export async function updatePackageConfigurations(projectDir: string, options: P
2222
}
2323
}
2424

25+
/**
26+
* Update the root package.json with the project name, workspace entries, scripts, and package manager metadata according to the provided project configuration.
27+
*
28+
* This updates (if present) the root package.json: sets the package name, generates workspace-scoped scripts (dev, build, check-types, native/web dev, server/dev:setup, database commands and docker-related db scripts when applicable), attempts to record the installed package manager version, and ensures appropriate workspaces (apps/* and/or packages/*) are present.
29+
*
30+
* @param projectDir - Filesystem path to the project root containing package.json
31+
* @param options - Project configuration that determines which scripts and workspaces are added or modified (backend, packageManager, addons, database, orm, dbSetup, serverDeploy, frontend, etc.)
32+
*/
2533
async function updateRootPackageJson(projectDir: string, options: ProjectConfig) {
2634
const rootPackageJsonPath = path.join(projectDir, "package.json");
2735
if (!(await fs.pathExists(rootPackageJsonPath))) return;
@@ -91,10 +99,10 @@ async function updateRootPackageJson(projectDir: string, options: ProjectConfig)
9199
}
92100
}
93101
if (options.dbSetup === "docker") {
94-
scripts["db:start"] = `turbo -F ${dbPackageName} db:start`;
95-
scripts["db:watch"] = `turbo -F ${dbPackageName} db:watch`;
96-
scripts["db:stop"] = `turbo -F ${dbPackageName} db:stop`;
97-
scripts["db:down"] = `turbo -F ${dbPackageName} db:down`;
102+
scripts["db:start"] = `turbo -F ${dbPackageName} --env-mode=loose db:start`;
103+
scripts["db:watch"] = `turbo -F ${dbPackageName} --env-mode=loose db:watch`;
104+
scripts["db:stop"] = `turbo -F ${dbPackageName} --env-mode=loose db:stop`;
105+
scripts["db:down"] = `turbo -F ${dbPackageName} --env-mode=loose db:down`;
98106
}
99107
} else if (options.packageManager === "pnpm") {
100108
scripts.dev = devScript;
@@ -337,4 +345,4 @@ async function updateConvexPackageJson(projectDir: string, options: ProjectConfi
337345
}
338346

339347
await fs.writeJson(convexPackageJsonPath, convexPackageJson, { spaces: 2 });
340-
}
348+
}

0 commit comments

Comments
 (0)