Skip to content

Improve validation for input on interactive mode #142

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

Draft
atilafassina wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Improve validation for input on interactive mode #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion packages/get-db/src/lib/utils/validate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,22 @@ describe("validateEnvPath", () => {
expect(validateEnvPath("env-local")).toBeUndefined();
});

it("returns undefined for valid relative paths", () => {
expect(validateEnvPath("./.env")).toBeUndefined();
expect(validateEnvPath("./.env.local")).toBeUndefined();
expect(validateEnvPath("./config/.env")).toBeUndefined();
expect(validateEnvPath("config/.env")).toBeUndefined();
expect(validateEnvPath("src/config/.env.local")).toBeUndefined();
});

it("returns undefined for empty string", () => {
expect(validateEnvPath("")).toBeUndefined();
});

it("returns error for invalid paths", () => {
expect(validateEnvPath(".env/local")).toBeInstanceOf(Error);
expect(validateEnvPath("../.env")).toBeInstanceOf(Error);
expect(validateEnvPath("/etc/.env")).toBeInstanceOf(Error);
expect(validateEnvPath(".env/")).toBeInstanceOf(Error);
expect(validateEnvPath("..env")).toBeInstanceOf(Error);
expect(validateEnvPath(".env..local")).toBeInstanceOf(Error);
});
Expand Down
10 changes: 7 additions & 3 deletions packages/get-db/src/lib/utils/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
/**
* Validates the path to the .env file - it can be dotfile or not.
* Validates the path to the .env file - accepts filenames and relative paths.
* @param value - The path to the .env file
* @returns An error if the path is invalid, otherwise undefined
*/
function validateEnvPath(value: string) {
if (!value) return undefined;

if (!/^\.?[\w-]+(?:\.[\w-]+)*$/.test(value)) {
if (
!/^(?:\.\/)?(?:[\w-]+(?:\.[\w-]+)*\/)*\.?[\w-]+(?:\.[\w-]+)*$/.test(
value,
)
) {
return new Error(
"Please enter a valid file name (e.g.: .env or .env.local)",
"Please enter a valid file path (e.g.: .env, .env.local, or ./config/.env)",
);
}

Expand Down