Skip to content
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

Jump to bottom

[vscode][5/n] Setup Env Variables: Read the text from the env template and append to existing file #1285

Merged
merged 2 commits into from
Feb 22, 2024
Merged

[vscode][5/n] Setup Env Variables: Read the text from the env template and append to existing file #1285

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
351c376
[vscode][4/n] Setup Env Variables: Add helper text to existing env path
Feb 22, 2024
73a7e8b
[vscode][5/n] Setup Env Variables: Read the text from the env templat…
Feb 22, 2024
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
58 changes: 35 additions & 23 deletions vscode-extension/src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export function activate(context: vscode.ExtensionContext) {
context.subscriptions.push(
vscode.commands.registerCommand(
COMMANDS.SETUP_ENVIRONMENT_VARIABLES,
() => {
setupEnvironmentVariables(context);
async () => {
await setupEnvironmentVariables(context);
}
)
);
Expand Down Expand Up @@ -757,18 +757,29 @@ async function setupEnvironmentVariables(context: vscode.ExtensionContext) {
return;
}

const envTemplatePath = vscode.Uri.joinPath(
context.extensionUri,
"static",
"env_template.env"
);

if (fs.existsSync(envPath)) {
vscode.window.showInformationMessage(
"Env file already exists, will implement next PR"
);
const helperText = (
await vscode.workspace.fs.readFile(envTemplatePath)
).toString();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! using const instead of let


// TODO: Check if we already appended the template text to existing .env
// file before. If we did, don't do it again
fs.appendFile(envPath, "\n\n" + helperText, function (err) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for now, but if a file already exists perhaps we should ask the user to specify a different file or ask them if they want to overwrite or append. Can be a future improvement.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to push back saying this is P1 and focus more on content for tonight. If I have time before midnight I'll do it

Copy link
Member

@Ankush-lastmile Ankush-lastmile Feb 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: define \n\n as a constant

if (err) {
throw err;
}
console.log(
`Added .env template text from ${envTemplatePath.fsPath} to ${envPath}`
);
});
} else {
// Create the .env file from the sample
const envTemplatePath = vscode.Uri.joinPath(
context.extensionUri,
"static",
"env_template.env"
);

try {
await vscode.workspace.fs.copy(
envTemplatePath,
Expand All @@ -780,19 +791,20 @@ async function setupEnvironmentVariables(context: vscode.ExtensionContext) {
`Error creating new file ${envTemplatePath}: ${err}`
);
}
}

const doc = await vscode.workspace.openTextDocument(envPath);
if (doc) {
vscode.window.showTextDocument(doc, {
preview: false,
// Tried using vscode.ViewColumn.Active but that overrides existing
// walkthrough window
viewColumn: vscode.ViewColumn.Beside,
});
vscode.window.showInformationMessage(
"Please define your environment variables."
);
}
// Open the env file that was either was created or already existed
const doc = await vscode.workspace.openTextDocument(envPath);
if (doc) {
vscode.window.showTextDocument(doc, {
preview: false,
// Tried using vscode.ViewColumn.Active but that overrides existing
// walkthrough window
viewColumn: vscode.ViewColumn.Beside,
});
vscode.window.showInformationMessage(
"Please define your environment variables."
);
}
}

Expand Down