Skip to content

refactor: configuration class #30

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
yCodeTech merged 3 commits into from
Apr 19, 2026
+61 −70
Merged

refactor: configuration class #30

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d3f5d8
refactor: replace `var` with `let` for block scoping in `Configuration`
yCodeTech Apr 19, 2026
8b7326a
refactor: simplify blade comment handling in `Configuration`.
yCodeTech Apr 19, 2026
0f4cfff
refactor: extract duplicate custom single-line language logic into he…
yCodeTech Apr 19, 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
131 changes: 61 additions & 70 deletions src/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,46 +184,42 @@ export class Configuration {
}

/**
* Sets the block comments for the blade language determined by the user setting.
*
* @param bladeOverrideComments A boolean indicating whether or not the user setting "Blade Override Comments" is enabled.
*
* @param [onStart=false] A boolean indicating whether or not the method was called
* on starting the extension.
* If `true`, it returns the comments, if `false` (default), it sets the comments to
* the language directly.
* Get the appropriate comment style for the blade language. Either blade or html comments.
*
* @returns {vscode.CharacterPair | void} Returns the blade comments if `onStart` is `true`, otherwise nothing.
* @param bladeOverrideComments A boolean indicating whether or not the user setting
* "Blade Override Comments" is enabled.
*
* @returns {vscode.CharacterPair} The appropriate comment style for the blade language.
*/
public setBladeComments(bladeOverrideComments: boolean, onStart: boolean = false): vscode.CharacterPair | void {
// Is enabled AND blade langId is NOT set as disabled...
private getBladeOrHtmlComments(bladeOverrideComments: boolean): vscode.CharacterPair {
// If blade override is enabled AND blade langId is NOT set as disabled,
// return the blade comments.
if (bladeOverrideComments === true && !this.isLangIdDisabled("blade")) {
const bladeComments: vscode.CharacterPair = ["{{--", "--}}"];

if (onStart) {
return bladeComments;
} else {
vscode.languages.setLanguageConfiguration("blade", {
comments: {
blockComment: bladeComments,
},
});
}
return ["{{--", "--}}"];
}
// Is disabled OR blade langId is set as disabled...
else if (!bladeOverrideComments || this.isLangIdDisabled("blade")) {
const htmlComments: vscode.CharacterPair = ["<!--", "-->"];

if (onStart) {
return htmlComments;
} else {
vscode.languages.setLanguageConfiguration("blade", {
comments: {
blockComment: htmlComments,
},
});
}
// Otherwise, return the html comments.
return ["<!--", "-->"];
}

/**
* Sets the block comments for the blade language determined by the user setting.
*
* @param bladeOverrideComments A boolean indicating whether or not the user setting
* "Blade Override Comments" is enabled.
*/
public setBladeComments(bladeOverrideComments: boolean): void {
// If blade langId is NOT set as disabled...
if (!this.isLangIdDisabled("blade")) {
// Get blade or html comments.
const comments = this.getBladeOrHtmlComments(bladeOverrideComments);

// Set the comments into the language config for blade.
vscode.languages.setLanguageConfiguration("blade", {
comments: {
blockComment: comments,
},
});
}
}

Expand Down Expand Up @@ -586,6 +582,29 @@ export class Configuration {
this.multiLineBlocksMap.set("customSupportedLanguages", langArray.sort());
}

/**
* Add custom single-line languages to the map from a configuration setting.
*
* @param tempMap The temp map to add languages to.
* @param settingKey The configuration setting key to read languages from.
* @param style The comment style to associate with these languages.
*/
private addCustomSingleLineLanguages(
tempMap: Map<LanguageId, SingleLineCommentStyle>,
settingKey: "slashStyleBlocks" | "hashStyleBlocks" | "semicolonStyleBlocks",
style: SingleLineCommentStyle
): void {
const customLangs = this.getConfigurationValue(settingKey);
for (const langId of customLangs) {
// If langId exists (ie. not NULL or empty string) AND
// the langId is longer than 0, AND
// the langId isn't set as disabled...
if (langId && langId.length > 0 && !this.isLangIdDisabled(langId)) {
tempMap.set(langId, style);
}
}
}

/**
* Set the single-line comments language definitions.
*/
Expand Down Expand Up @@ -637,38 +656,10 @@ export class Configuration {
// Empty the tempMap to reuse it.
tempMap.clear();

// Get user-customized langIds for the //-style and add to the map.
let customSlashLangs = this.getConfigurationValue("slashStyleBlocks");
for (let langId of customSlashLangs) {
// If langId is exists (ie. not NULL or empty string) AND
// the langId is longer than 0, AND
// the langId isn't set as disabled...
if (langId && langId.length > 0) {
tempMap.set(langId, "//");
}
}

// Get user-customized langIds for the #-style and add to the map.
let customHashLangs = this.getConfigurationValue("hashStyleBlocks");
for (let langId of customHashLangs) {
// If langId is exists (ie. not NULL or empty string) AND
// the langId is longer than 0, AND
// the langId isn't set as disabled...
if (langId && langId.length > 0 && !this.isLangIdDisabled(langId)) {
tempMap.set(langId, "#");
}
}

// Get user-customized langIds for the ;-style and add to the map.
let customSemicolonLangs = this.getConfigurationValue("semicolonStyleBlocks");
for (let langId of customSemicolonLangs) {
// If langId is exists (ie. not NULL or empty string) AND
// the langId is longer than 0, AND
// the langId isn't set as disabled...
if (langId && langId.length > 0 && !this.isLangIdDisabled(langId)) {
tempMap.set(langId, ";");
}
}
// Add user-customized langIds for each comment style.
this.addCustomSingleLineLanguages(tempMap, "slashStyleBlocks", "//");
this.addCustomSingleLineLanguages(tempMap, "hashStyleBlocks", "#");
this.addCustomSingleLineLanguages(tempMap, "semicolonStyleBlocks", ";");

// Set the customSupportedLanguages tempMap into the singleLineBlocksMap,
// sorted in ascending order, for sanity reasons.
Expand Down Expand Up @@ -751,7 +742,7 @@ export class Configuration {
* Get the user settings/configuration and set the blade or html comments accordingly.
*/
if (langId === "blade") {
const bladeComments = this.setBladeComments(this.getConfigurationValue("bladeOverrideComments"), true);
const bladeComments = this.getBladeOrHtmlComments(this.getConfigurationValue("bladeOverrideComments"));

// If bladeComments has a value...
if (bladeComments) {
Expand Down Expand Up @@ -904,12 +895,12 @@ export class Configuration {

// Get the langId from the auto-supported langs. If it doesn't exist, try getting it from
// the custom-supported langs instead.
var style: SingleLineCommentStyle | ExtraSingleLineCommentStyles = singleLineLangs.get(langId) ?? customSingleLineLangs.get(langId);
let style: SingleLineCommentStyle | ExtraSingleLineCommentStyles = singleLineLangs.get(langId) ?? customSingleLineLangs.get(langId);

if (style && textEditor.selection.isEmpty) {
let line = textEditor.document.lineAt(textEditor.selection.active);
let isCommentLine = true;
var indentRegex: RegExp;
let indentRegex: RegExp;

if (style === "//" && line.text.search(/^\s*\/\/\s*/) !== -1) {
indentRegex = /\//;
Expand Down Expand Up @@ -939,7 +930,7 @@ export class Configuration {
return;
}

var indentedNewLine = "\n" + line.text.substring(0, line.text.search(indentRegex));
let indentedNewLine = "\n" + line.text.substring(0, line.text.search(indentRegex));
let isOnEnter = this.getConfigurationValue("singleLineBlockOnEnter");
if (!isOnEnter) {
indentedNewLine += style + " ";
Expand Down
Loading