TypeScript Code Organizer Deletes Commented-Out Code

[Christopher-C-Robinson]

Title: TypeScript Code Organizer Deletes Commented-Out Code

Description:
The TypeScript Code Organizer extension is unexpectedly deleting commented-out code, particularly when there are consecutive comment lines or an empty line between them. This makes it difficult to temporarily disable code for debugging or iteration purposes.

Expected Behavior:

• Commented-out code should remain in the file after formatting.
• If a user explicitly comments something out, it should not be removed.

Actual Behavior:

• The extension removes commented-out code in certain cases.
• If a test or block of code is commented out at the end of a file, it gets deleted entirely instead of being preserved.
• It seems that the extension interprets back-to-back comments (especially with a blank line between them) as unnecessary and removes them.

Steps to Reproduce:

1. Comment out a block of code or a test at the end of a file.
2. Run the VS Code TypeScript Code Organizer extension.
3. Observe that the commented-out code is deleted.

Example:

Before running the organizer:

import { Selector } from "testcafe";

import Admin from "../../admin-variables";
import App from "../../app-variables";

//! Tests 1 through 16 are not concurrency enabled. Every test after that will be concurrency enabled

// Folders for this Suite
const folder1 = Admin.Navigation.AdvancedForms;
const folderOption = Admin.getFolderOption(folder1);
const roleOption = Selector('[id="ZZ Test Cafe-checkbox"]');

After running the organizer:

import { Selector } from "testcafe";

import Admin from "../../admin-variables";
import App from "../../app-variables";

//! Tests 1 through 16 are not concurrency enabled. Every test after that will be concurrency enabled
const folder1 = Admin.Navigation.AdvancedForms;
const folderOption = Admin.getFolderOption(folder1);
const roleOption = Selector('[id="ZZ Test Cafe-checkbox"]');

The comment // Folders for this Suite was removed.

Environment:

• VS Code Version: 1.99.0-insider (user setup)
• TypeScript Code Organizer Version: 2.0.10
• OS: Windows_NT x64 10.0.22631
• Electron: 34.2.0
• Chromium: 132.0.6834.196
• Node.js: 20.18.2
• V8: 13.2.152.36-electron.0

Additional Context:

This behavior negatively affects debugging, test iteration, and temporary modifications. The ability to comment out code is essential, and having it automatically deleted is frustrating.

Would it be possible to adjust the logic so that all user comments are preserved unless explicitly removed?

Thanks for the great tool!

[aljazsim]

I've fixed the issue. Please update the extension to the latest version and give it another try!

[Christopher-C-Robinson]

@aljazsim, this seems to be back. or a portion of it. it deletes all trailing commented lines.

import Admin from "../../../../../admin-variables";
import App from "../../../../../app-variables";
import { LongTextBuilderAdvanced } from "../../../../../infrastructure/admin/form-builder/fields-pane/inputs/longtext-form-builder/longtext-form-builder-advanced";
import { DeleteForm } from "../../../../../infrastructure/admin/form-builder/toolbar/delete-form";
import { SaveForm } from "../../../../../infrastructure/admin/form-builder/toolbar/save-form";
import { LongTextField } from "../../../../../infrastructure/app/form-fields/longtext-field";
import { Form } from "../../../../../infrastructure/app/form-tab";
import logger from "../../../../../logger-variables";
import { TestCafe } from "../../../../../roles";

// Folders for this Suite
const folder = Admin.Navigation.AdvancedForms;
const subfolder = Admin.Navigation.AdvancedLongText;
const folderOption = Admin.getFolderOption(folder, subfolder);
const roles = ['LongText'];

// Declare the variable 'AdminTestSuccess' for tracking if Admin side passed. This is to prevent running the Admin side test multiple times.
let AdminTestSuccess: { [key: string]: boolean } = {};

fixture`Advanced Form - Long Text - Field Conditions`
    .requestHooks(logger.saveForm, logger.submitForm)
    .beforeEach(async t => {
        await t.useRole(TestCafe);
        await Admin.loginSync(Admin.Credentials.TestCafe, Admin.Credentials.Password);
    });

//Long Text - Field Condition - Required
test('Test Case: 15916 - OLD', async t => {
    t.ctx.formName = 'Test Case: 15916';

    //*ADMIN SIDE*//
    if (Admin.RunAdmin === true && (!AdminTestSuccess[`${t.ctx.formName}`])) {
        //check if form exists and if so it will be deleted
        await DeleteForm.delete(t.ctx.formName, folder, subfolder);
        //create a new form
        await Admin.createAdvancedForm(roles, folderOption, t.ctx.formName);

        //add Long Text field
        await LongTextBuilderAdvanced.addField();
        //add another Long Text field
        await LongTextBuilderAdvanced.addField();
        //edit the second Long Text field
        await LongTextBuilderAdvanced.editField('Long_Text_1');
        //add a field condition
        await LongTextBuilderAdvanced.addFieldConditionRule('(Long_Text is equal to Long_Text_1)', 'required');
        //complete edit
        await LongTextBuilderAdvanced.completeEdit();

        //save the form
        await SaveForm.saveForm();
        AdminTestSuccess[`${t.ctx.formName}`] = true; // Set the variable to true to prevent running the Admin side test multiple times
    }

    //*APP SIDE*//
    if (App.RunApp === true) {
        //open app
        await App.openApp(App.Credentials.LongText, App.Credentials.Password);
        //open form
        await Form.openForm(t.ctx.formName);

        //Try to submit the form expecting an error
        await Form.checkSubmitRequiredFieldError();
        //add 'test' to the Long_Text field
        await LongTextField.addValue('Long_Text', 'test');

        //submit form
        await Form.submitForm(logger.submitForm);
    }
});

//Long Text - Field Condition - Read-Only
test('Test Case: 15917 - OLD', async t => {
    t.ctx.formName = 'Test Case: 15917';

    //*ADMIN SIDE*//
    if (Admin.RunAdmin === true && (!AdminTestSuccess[`${t.ctx.formName}`])) {
        //check if form exists and if so it will be deleted
        await DeleteForm.delete(t.ctx.formName, folder, subfolder);
        //create a new form
        await Admin.createAdvancedForm(roles, folderOption, t.ctx.formName);

        //add Long Text field
        await LongTextBuilderAdvanced.addField();
        //add another Long Text field
        await LongTextBuilderAdvanced.addField();
        //edit the second Long Text field
        await LongTextBuilderAdvanced.editField('Long_Text_1');
        //add a field condition
        await LongTextBuilderAdvanced.addFieldConditionRule('(Long_Text is equal to Long_Text_1)', 'read-only');
        //complete edit
        await LongTextBuilderAdvanced.completeEdit();

        //save the form
        await SaveForm.saveForm();
        AdminTestSuccess[`${t.ctx.formName}`] = true; // Set the variable to true to prevent running the Admin side test multiple times
    }

    //*APP SIDE*//
    if (App.RunApp === true) {
        //open app
        await App.openApp(App.Credentials.LongText, App.Credentials.Password);
        //open form
        await Form.openForm(t.ctx.formName);

        //check for the Long_Text_1 field to be read-only
        await LongTextField.isReadOnly('Long_Text_1', true);
        //add 'test' to the Long_Text field
        await LongTextField.addValue('Long_Text', 'test');
        //check for the Long_Text_1 field to not be read-only
        await LongTextField.isReadOnly('Long_Text_1', false);
        //add 'test' to the Long_Text_1 field
        await LongTextField.addValue('Long_Text_1', 'test');

        //submit form
        await Form.submitForm(logger.submitForm);
    }
});

if I comment out the last test like so, it will completely delete it:

import Admin from "../../../../../admin-variables";
import App from "../../../../../app-variables";
import { LongTextBuilderAdvanced } from "../../../../../infrastructure/admin/form-builder/fields-pane/inputs/longtext-form-builder/longtext-form-builder-advanced";
import { DeleteForm } from "../../../../../infrastructure/admin/form-builder/toolbar/delete-form";
import { SaveForm } from "../../../../../infrastructure/admin/form-builder/toolbar/save-form";
import { LongTextField } from "../../../../../infrastructure/app/form-fields/longtext-field";
import { Form } from "../../../../../infrastructure/app/form-tab";
import logger from "../../../../../logger-variables";
import { TestCafe } from "../../../../../roles";

// Folders for this Suite
const folder = Admin.Navigation.AdvancedForms;
const subfolder = Admin.Navigation.AdvancedLongText;
const folderOption = Admin.getFolderOption(folder, subfolder);
const roles = ['LongText'];

// Declare the variable 'AdminTestSuccess' for tracking if Admin side passed. This is to prevent running the Admin side test multiple times.
let AdminTestSuccess: { [key: string]: boolean } = {};

fixture`Advanced Form - Long Text - Field Conditions`
    .requestHooks(logger.saveForm, logger.submitForm)
    .beforeEach(async t => {
        await t.useRole(TestCafe);
        await Admin.loginSync(Admin.Credentials.TestCafe, Admin.Credentials.Password);
    });

//Long Text - Field Condition - Required
test('Test Case: 15916 - OLD', async t => {
    t.ctx.formName = 'Test Case: 15916';

    //*ADMIN SIDE*//
    if (Admin.RunAdmin === true && (!AdminTestSuccess[`${t.ctx.formName}`])) {
        //check if form exists and if so it will be deleted
        await DeleteForm.delete(t.ctx.formName, folder, subfolder);
        //create a new form
        await Admin.createAdvancedForm(roles, folderOption, t.ctx.formName);

        //add Long Text field
        await LongTextBuilderAdvanced.addField();
        //add another Long Text field
        await LongTextBuilderAdvanced.addField();
        //edit the second Long Text field
        await LongTextBuilderAdvanced.editField('Long_Text_1');
        //add a field condition
        await LongTextBuilderAdvanced.addFieldConditionRule('(Long_Text is equal to Long_Text_1)', 'required');
        //complete edit
        await LongTextBuilderAdvanced.completeEdit();

        //save the form
        await SaveForm.saveForm();
        AdminTestSuccess[`${t.ctx.formName}`] = true; // Set the variable to true to prevent running the Admin side test multiple times
    }

    //*APP SIDE*//
    if (App.RunApp === true) {
        //open app
        await App.openApp(App.Credentials.LongText, App.Credentials.Password);
        //open form
        await Form.openForm(t.ctx.formName);

        //Try to submit the form expecting an error
        await Form.checkSubmitRequiredFieldError();
        //add 'test' to the Long_Text field
        await LongTextField.addValue('Long_Text', 'test');

        //submit form
        await Form.submitForm(logger.submitForm);
    }
});

// //Long Text - Field Condition - Read-Only
// test('Test Case: 15917 - OLD', async t => {
//     t.ctx.formName = 'Test Case: 15917';

//     //*ADMIN SIDE*//
//     if (Admin.RunAdmin === true && (!AdminTestSuccess[`${t.ctx.formName}`])) {
//         //check if form exists and if so it will be deleted
//         await DeleteForm.delete(t.ctx.formName, folder, subfolder);
//         //create a new form
//         await Admin.createAdvancedForm(roles, folderOption, t.ctx.formName);

//         //add Long Text field
//         await LongTextBuilderAdvanced.addField();
//         //add another Long Text field
//         await LongTextBuilderAdvanced.addField();
//         //edit the second Long Text field
//         await LongTextBuilderAdvanced.editField('Long_Text_1');
//         //add a field condition
//         await LongTextBuilderAdvanced.addFieldConditionRule('(Long_Text is equal to Long_Text_1)', 'read-only');
//         //complete edit
//         await LongTextBuilderAdvanced.completeEdit();

//         //save the form
//         await SaveForm.saveForm();
//         AdminTestSuccess[`${t.ctx.formName}`] = true; // Set the variable to true to prevent running the Admin side test multiple times
//     }

//     //*APP SIDE*//
//     if (App.RunApp === true) {
//         //open app
//         await App.openApp(App.Credentials.LongText, App.Credentials.Password);
//         //open form
//         await Form.openForm(t.ctx.formName);

//         //check for the Long_Text_1 field to be read-only
//         await LongTextField.isReadOnly('Long_Text_1', true);
//         //add 'test' to the Long_Text field
//         await LongTextField.addValue('Long_Text', 'test');
//         //check for the Long_Text_1 field to not be read-only
//         await LongTextField.isReadOnly('Long_Text_1', false);
//         //add 'test' to the Long_Text_1 field
//         await LongTextField.addValue('Long_Text_1', 'test');

//         //submit form
//         await Form.submitForm(logger.submitForm);
//     }
// });