Skip to content

fix(create-termui-app): validate project name to prevent path traversal #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karanjot786 merged 2 commits into from
Jun 5, 2026
Merged

fix(create-termui-app): validate project name to prevent path traversal #710

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
788db70
fix(create-termui-app): validate project name to prevent path traversal
Siddh2024 Jun 4, 2026
bfcf144
chore: trigger CI
Karanjot786 Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions packages/create-termui-app/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@ import {
import { generateProject, type ProjectConfig } from "./templates.js";
import { parseArgs, isNonInteractive } from "./args.js";

const VALID_PROJECT_NAME_RE = /^[a-zA-Z0-9@][a-zA-Z0-9_.-]*$/;

function validateProjectName(name: string, source: string): void {
if (!VALID_PROJECT_NAME_RE.test(name)) {
throw new Error(
`Invalid project name "${name}" (from ${source}). Use only letters, digits, hyphens, underscores, dots, or start with @ for scoped packages.`
);
}
if (name === "." || name === "..") {
throw new Error(
`Invalid project name "${name}". "." and ".." are not allowed as project names.`
);
}
}

const TEMPLATES = [
"Empty (start from scratch)",
"Dashboard (real-time data)",
Expand Down Expand Up @@ -56,6 +71,7 @@ async function main() {
// ───────── CI MODE ─────────
if (isNonInteractive(args)) {
projectName ??= "my-termui-app";
validateProjectName(projectName, "command-line argument");

if (args.template && !TEMPLATE_KEYS.includes(args.template as any)) {
throw new Error(
Expand Down Expand Up @@ -116,6 +132,7 @@ async function main() {
if (!projectName) {
projectName = await textPrompt("Project name", "my-termui-app");
}
validateProjectName(projectName, "interactive prompt");

const templateIdx = await selectPrompt("What kind of app?", TEMPLATES);
template = TEMPLATE_KEYS[templateIdx];
Expand Down
Loading