Ctrl + S is pressed or when :w is executed while using vim keybindings)',
},
'display-message': {
'name': 'Display message on lint',
@@ -150,7 +150,7 @@ export default {
},
'display-lint-on-file-change-message': {
'name': 'Display Lint on File Change Message',
- 'description': 'Displays a message when `Lint on Focused File Change` occurs',
+ 'description': 'Displays a message when Lint on Focused File Change occurs',
},
'folders-to-ignore': {
'name': 'Folders to ignore',
@@ -207,11 +207,11 @@ export default {
},
'log-collection': {
'name': 'Collect logs when linting on save and linting the current file',
- 'description': 'Goes ahead and collects logs when you `Lint on save` and linting the current file. These logs can be helpful for debugging and create bug reports.',
+ 'description': 'Goes ahead and collects logs when you Lint on save and linting the current file. These logs can be helpful for debugging and create bug reports.',
},
'linter-logs': {
'name': 'Linter Logs',
- 'description': 'The logs from the last `Lint on save` or the last lint current file run if enabled.',
+ 'description': 'The logs from the last Lint on save or the last lint current file run if enabled.',
},
},
},
@@ -259,14 +259,14 @@ export default {
// auto-correct-common-misspellings.ts
'auto-correct-common-misspellings': {
'name': 'Auto-correct Common Misspellings',
- 'description': 'Uses a dictionary of common misspellings to automatically convert them to their proper spellings. See [auto-correct map](https://github.com/platers/obsidian-linter/tree/master/src/utils/default-misspellings.md) for the full list of auto-corrected words. **Note: this list can work on text from multiple languages, but this list is the same no matter what language is currently in use.**',
+ 'description': 'Uses a dictionary of common misspellings to automatically convert them to their proper spellings. See auto-correct map for the full list of auto-corrected words. Note: this list can work on text from multiple languages, but this list is the same no matter what language is currently in use.',
'ignore-words': {
'name': 'Ignore Words',
'description': 'A comma separated list of lowercased words to ignore when auto-correcting',
},
'extra-auto-correct-files': {
'name': 'Extra Auto-Correct Source Files',
- 'description': 'These are files that have a markdown table in them that have the initial word and the word to correct it to (these are case insensitive corrections). **Note: the tables used should have the starting and ending `|` indicators present for each line.**',
+ 'description': 'These are files that have a markdown table in them that have the initial word and the word to correct it to (these are case insensitive corrections). Note: the tables used should have the starting and ending | indicators present for each line.',
},
'skip-words-with-multiple-capitals': {
'name': 'Skip Words with Multiple Capitals',
@@ -371,7 +371,7 @@ export default {
'description': 'Add a default language to code fences that do not have a language specified.',
'default-language': {
'name': 'Programming Language',
- 'description': 'Leave empty to do nothing. Languages tags can be found [here](https://prismjs.com/#supported-languages).',
+ 'description': 'Leave empty to do nothing. Languages tags can be found here.',
},
},
// emphasis-style.ts
@@ -386,7 +386,7 @@ export default {
// empty-line-around-blockquotes.ts
'empty-line-around-blockquotes': {
'name': 'Empty Line Around Blockquotes',
- 'description': 'Ensures that there is an empty line around blockquotes unless they start or end a document. **Note: an empty line is either one less level of nesting for blockquotes or a newline character.**',
+ 'description': 'Ensures that there is an empty line around blockquotes unless they start or end a document. Note: an empty line is either one less level of nesting for blockquotes or a newline character.',
},
// empty-line-around-code-fences.ts
'empty-line-around-code-fences': {
@@ -396,7 +396,7 @@ export default {
// empty-line-around-math-block.ts
'empty-line-around-math-blocks': {
'name': 'Empty Line Around Math Blocks',
- 'description': 'Ensures that there is an empty line around math blocks using `Number of Dollar Signs to Indicate a Math Block` to determine how many dollar signs indicates a math block for single-line math.',
+ 'description': 'Ensures that there is an empty line around math blocks using Number of Dollar Signs to Indicate a Math Block to determine how many dollar signs indicates a math block for single-line math.',
},
// empty-line-around-tables.ts
'empty-line-around-tables': {
@@ -439,10 +439,10 @@ export default {
// format-yaml-array.ts
'format-yaml-array': {
'name': 'Format YAML Array',
- 'description': 'Allows for the formatting of regular YAML arrays as either multi-line or single-line and `tags` and `aliases` are allowed to have some Obsidian specific YAML formats. **Note: that single string to single-line goes from a single string entry to a single-line array if more than 1 entry is present. The same is true for single string to multi-line except it becomes a multi-line array.**',
+ 'description': 'Allows for the formatting of regular YAML arrays as either multi-line or single-line and tags and aliases are allowed to have some Obsidian specific YAML formats. Note: that single string to single-line goes from a single string entry to a single-line array if more than 1 entry is present. The same is true for single string to multi-line except it becomes a multi-line array.',
'alias-key': {
'name': 'Format YAML aliases section',
- 'description': 'Turns on formatting for the YAML aliases section. You should not enable this option alongside the rule `YAML Title Alias` as they may not work well together or they may have different format styles selected causing unexpected results.',
+ 'description': 'Turns on formatting for the YAML aliases section. You should not enable this option alongside the rule YAML Title Alias as they may not work well together or they may have different format styles selected causing unexpected results.',
},
'tag-key': {
'name': 'Format YAML tags section',
@@ -450,7 +450,7 @@ export default {
},
'default-array-style': {
'name': 'Default YAML array section style',
- 'description': 'The style of other YAML arrays that are not `tags`, `aliases` or in `Force key values to be single-line arrays` and `Force key values to be multi-line arrays`',
+ 'description': 'The style of other YAML arrays that are not tags, aliases or in Force key values to be single-line arrays and Force key values to be multi-line arrays',
},
'default-array-keys': {
'name': 'Format YAML array sections',
@@ -514,7 +514,7 @@ export default {
// move-math-block-indicators-to-their-own-line.ts
'move-math-block-indicators-to-their-own-line': {
'name': 'Move Math Block Indicators to Their Own Line',
- 'description': 'Move all starting and ending math block indicators to their own lines using `Number of Dollar Signs to Indicate a Math Block` to determine how many dollar signs indicates a math block for single-line math.',
+ 'description': 'Move all starting and ending math block indicators to their own lines using Number of Dollar Signs to Indicate a Math Block to determine how many dollar signs indicates a math block for single-line math.',
},
// move-tags-to-yaml.ts
'move-tags-to-yaml': {
@@ -526,7 +526,7 @@ export default {
},
'tags-to-ignore': {
'name': 'Tags to ignore',
- 'description': 'The tags that will not be moved to the tags array or removed from the body content if `Remove the hashtag from tags in content body` is enabled. Each tag should be on a new line and without the `#`. **Make sure not to include the hashtag in the tag name.**',
+ 'description': 'The tags that will not be moved to the tags array or removed from the body content if Remove the hashtag from tags in content body is enabled. Each tag should be on a new line and without the #. Make sure not to include the hashtag in the tag name.',
},
},
// no-bare-urls.ts
@@ -541,7 +541,7 @@ export default {
// ordered-list-style.ts
'ordered-list-style': {
'name': 'Ordered List Style',
- 'description': 'Makes sure that ordered lists follow the style specified. **Note: that 2 spaces or 1 tab is considered to be an indentation level.**',
+ 'description': 'Makes sure that ordered lists follow the style specified. Note: that 2 spaces or 1 tab is considered to be an indentation level.',
'number-style': {
'name': 'Number Style',
'description': 'The number style used in ordered list indicators',
@@ -585,7 +585,7 @@ export default {
'name': 'Quote Style',
'description': 'Updates the quotes in the body content to be updated to the specified single and double quote styles.',
'single-quote-enabled': {
- 'name': 'Enable `Single Quote Style`',
+ 'name': 'Enable Single Quote Style',
'description': 'Specifies that the selected single quote style should be used.',
},
'single-quote-style': {
@@ -593,7 +593,7 @@ export default {
'description': 'The style of single quotes to use.',
},
'double-quote-enabled': {
- 'name': 'Enable `Double Quote Style`',
+ 'name': 'Enable Double Quote Style',
'description': 'Specifies that the selected double quote style should be used.',
},
'double-quote-style': {
@@ -604,7 +604,7 @@ export default {
// re-index-footnotes.ts
're-index-footnotes': {
'name': 'Re-Index Footnotes',
- 'description': 'Re-indexes footnote keys and footnote, based on the order of occurrence. **Note: This rule does _not_ work if there is more than one footnote for a key.**',
+ 'description': 'Re-indexes footnote keys and footnote, based on the order of occurrence. Note: This rule does not work if there is more than one footnote for a key.',
},
// remove-consecutive-list-markers.ts
'remove-consecutive-list-markers': {
@@ -664,7 +664,7 @@ export default {
// remove-space-around-characters.ts
'remove-space-around-characters': {
'name': 'Remove Space around Characters',
- 'description': 'Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). **Note: this may causes issues with markdown format in some cases.**',
+ 'description': 'Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). Note: this may causes issues with markdown format in some cases.',
'include-fullwidth-forms': {
'name': 'Include Fullwidth Forms',
'description': 'Include Fullwidth Forms Unicode block',
@@ -685,20 +685,20 @@ export default {
// remove-space-before-or-after-characters.ts
'remove-space-before-or-after-characters': {
'name': 'Remove Space Before or After Characters',
- 'description': 'Removes space before the specified characters and after the specified characters. **Note: this may causes issues with markdown format in some cases.**',
+ 'description': 'Removes space before the specified characters and after the specified characters. Note: this may causes issues with markdown format in some cases.',
'characters-to-remove-space-before': {
'name': 'Remove Space Before Characters',
- 'description': 'Removes space before the specified characters. **Note: using `{` or `}` in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.**',
+ 'description': 'Removes space before the specified characters. Note: using { or } in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.',
},
'characters-to-remove-space-after': {
'name': 'Remove Space After Characters',
- 'description': 'Removes space after the specified characters. **Note: using `{` or `}` in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.**',
+ 'description': 'Removes space after the specified characters. >Note: using { or } in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.',
},
},
// remove-trailing-punctuation-in-heading.ts
'remove-trailing-punctuation-in-heading': {
'name': 'Remove Trailing Punctuation in Heading',
- 'description': 'Removes the specified punctuation from the end of headings making sure to ignore the semicolon at the end of [HTML entity references](https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references).',
+ 'description': 'Removes the specified punctuation from the end of headings making sure to ignore the semicolon at the end of HTML entity references.',
'punctuation-to-remove': {
'name': 'Trailing Punctuation',
'description': 'The trailing punctuation to remove from the headings in the file.',
@@ -746,14 +746,14 @@ export default {
// space-between-chinese-japanese-or-korean-and-english-or-numbers.ts
'space-between-chinese-japanese-or-korean-and-english-or-numbers': {
'name': 'Space between Chinese Japanese or Korean and English or numbers',
- 'description': 'Ensures that Chinese, Japanese, or Korean and English or numbers are separated by a single space. Follows these [guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines)',
+ 'description': 'Ensures that Chinese, Japanese, or Korean and English or numbers are separated by a single space. Follows these guidelines',
'english-symbols-punctuation-before': {
'name': 'English Punctuations and Symbols Before CJK',
- 'description': 'The list of non-letter punctuation and symbols to consider to be from English when found before Chinese, Japanese, or Korean characters. **Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.**',
+ 'description': 'The list of non-letter punctuation and symbols to consider to be from English when found before Chinese, Japanese, or Korean characters. Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.',
},
'english-symbols-punctuation-after': {
'name': 'English Punctuations and Symbols After CJK',
- 'description': 'The list of non-letter punctuation and symbols to consider to be from English when found after Chinese, Japanese, or Korean characters. **Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.**',
+ 'description': 'The list of non-letter punctuation and symbols to consider to be from English when found after Chinese, Japanese, or Korean characters. Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.',
},
},
// strong-style.ts
@@ -795,7 +795,7 @@ export default {
// yaml-key-sort.ts
'yaml-key-sort': {
'name': 'YAML Key Sort',
- 'description': 'Sorts the YAML keys based on the order and priority specified. **Note: may remove blank lines as well. Only works on non-nested keys.**',
+ 'description': 'Sorts the YAML keys based on the order and priority specified. Note: may remove blank lines as well. Only works on non-nested keys.',
'yaml-key-priority-sort-order': {
'name': 'YAML Key Priority Sort Order',
'description': 'The order in which to sort keys with one on each line where it sorts in the order found in the list',
@@ -839,7 +839,7 @@ export default {
},
'format': {
'name': 'Format',
- 'description': 'Moment date format to use (see [Moment format options](https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/))',
+ 'description': 'Moment date format to use (see Moment format options)',
},
'convert-to-utc': {
'name': 'Convert Local Time to UTC',
@@ -847,7 +847,7 @@ export default {
},
'update-on-file-contents-updated': {
'name': 'Update YAML Timestamp on File Contents Update',
- 'description': 'When the currently active note is modified, `YAML Timestamp` is run on the note. This should update the modified note timestamp if it is more than 5 seconds off from the current value.',
+ 'description': 'When the currently active note is modified, YAML Timestamp is run on the note. This should update the modified note timestamp if it is more than 5 seconds off from the current value.',
},
},
// yaml-title-alias.ts
@@ -856,14 +856,14 @@ export default {
'description': 'Inserts or updates the title of the file into the YAML frontmatter\'s aliases section. Gets the title from the first H1 or filename.',
'preserve-existing-alias-section-style': {
'name': 'Preserve existing aliases section style',
- 'description': 'If set, the `YAML aliases section style` setting applies only to the newly created sections',
+ 'description': 'If set, the YAML aliases section style setting applies only to the newly created sections',
},
'keep-alias-that-matches-the-filename': {
'name': 'Keep alias that matches the filename',
'description': 'Such aliases are usually redundant',
},
'use-yaml-key-to-keep-track-of-old-filename-or-heading': {
- 'name': 'Use the YAML key specified by `Alias Helper Key` to help with filename and heading changes',
+ 'name': 'Use the YAML key specified by Alias Helper Key to help with filename and heading changes',
'description': 'If set, when the first H1 heading changes or filename if first H1 is not present changes, then the old alias stored in this key will be replaced with the new value instead of just inserting a new entry in the aliases array',
},
'alias-helper-key': {
diff --git a/src/main.ts b/src/main.ts
index bbf9861c..78877fe5 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,5 +1,5 @@
import {App, Editor, EventRef, MarkdownView, Menu, Notice, Plugin, TAbstractFile, TFile, TFolder, addIcon, htmlToMarkdown, EditorSelection, EditorChange, normalizePath, MarkdownFileInfo, debounce, Debouncer} from 'obsidian';
-import {Options, RuleType, ruleTypeToRules, rules} from './rules';
+import {Options, RuleType, ruleTypeToRules, rules, sortRules} from './rules';
import DiffMatchPatch from 'diff-match-patch';
import dedent from 'ts-dedent';
import {parseCustomReplacements, stripCr} from './utils/strings';
@@ -79,6 +79,8 @@ export default class LinterPlugin extends Plugin {
private hasLoadedMisspellingFiles = false;
async onload() {
+ sortRules();
+
setLanguage(window.localStorage.getItem('language'));
logInfo(getTextInLanguage('logs.plugin-load'));
@@ -210,12 +212,6 @@ export default class LinterPlugin extends Plugin {
void that.runLinterEditor(editor);
},
icon: iconInfo.file.id,
- hotkeys: [
- {
- modifiers: ['Mod', 'Alt'],
- key: 'L',
- },
- ],
});
this.addCommand({
diff --git a/src/option.ts b/src/option.ts
index 3f762e8f..b02e018b 100644
--- a/src/option.ts
+++ b/src/option.ts
@@ -1,7 +1,7 @@
import {Setting} from 'obsidian';
import {getTextInLanguage, LanguageStringKey} from './lang/helpers';
import LinterPlugin from './main';
-import {hideEl, parseTextToHTMLWithoutOuterParagraph, unhideEl} from './ui/helpers';
+import {hideEl, unhideEl, setElContent} from './ui/helpers';
import {LinterSettings} from './settings-data';
import {AutoCorrectFilesPickerOption} from './ui/linter-components/auto-correct-files-picker-option';
@@ -44,9 +44,9 @@ export abstract class Option {
settings.ruleConfigs[this.ruleAlias][this.configKey] = value;
}
- protected parseNameAndDescriptionAndRemoveSettingBorder(plugin: LinterPlugin) {
- parseTextToHTMLWithoutOuterParagraph(plugin.app, this.getName(), this.setting.nameEl, plugin.settingsTab.component);
- parseTextToHTMLWithoutOuterParagraph(plugin.app, this.getDescription(), this.setting.descEl, plugin.settingsTab.component);
+ protected parseNameAndDescriptionAndRemoveSettingBorder() {
+ setElContent(this.getName(), this.setting.nameEl);
+ setElContent(this.getDescription(), this.setting.descEl);
this.setting.settingEl.addClass('linter-no-border');
this.setting.descEl.addClass('linter-no-padding-top');
@@ -84,7 +84,7 @@ export class BooleanOption extends Option {
});
});
- this.parseNameAndDescriptionAndRemoveSettingBorder(plugin);
+ this.parseNameAndDescriptionAndRemoveSettingBorder();
}
}
@@ -102,7 +102,7 @@ export class TextOption extends Option {
});
});
- this.parseNameAndDescriptionAndRemoveSettingBorder(plugin);
+ this.parseNameAndDescriptionAndRemoveSettingBorder();
}
}
@@ -120,7 +120,7 @@ export class TextAreaOption extends Option {
});
});
- this.parseNameAndDescriptionAndRemoveSettingBorder(plugin);
+ this.parseNameAndDescriptionAndRemoveSettingBorder();
}
}
@@ -139,7 +139,7 @@ export class MomentFormatOption extends Option {
});
});
- this.parseNameAndDescriptionAndRemoveSettingBorder(plugin);
+ this.parseNameAndDescriptionAndRemoveSettingBorder();
}
}
@@ -188,7 +188,7 @@ export class DropdownOption extends Option {
});
});
- this.parseNameAndDescriptionAndRemoveSettingBorder(plugin);
+ this.parseNameAndDescriptionAndRemoveSettingBorder();
}
}
@@ -204,7 +204,7 @@ export class MdFilePickerOption extends Option {
this.settingEl = containerEl.createDiv();
- new AutoCorrectFilesPickerOption(this.settingEl, plugin.settingsTab.component, settings.ruleConfigs[this.ruleAlias][this.configKey], plugin.app, () => {
+ new AutoCorrectFilesPickerOption(this.settingEl, settings.ruleConfigs[this.ruleAlias][this.configKey], plugin.app, () => {
void plugin.saveSettings();
}, this.nameKey, this.descriptionKey);
}
diff --git a/src/rules.ts b/src/rules.ts
index d4552cd3..87c70dd9 100644
--- a/src/rules.ts
+++ b/src/rules.ts
@@ -166,7 +166,6 @@ export const ruleTypeToRules = new Map')) { - htmlString = htmlString.substring(3); - } - - if (htmlString.endsWith('
')) { - htmlString = htmlString.substring(0, htmlString.length - 4); - } - - containerEl.innerHTML = htmlString; -} - export function hideEl(el: HTMLElement) { el.addClass('linter-visually-hidden'); } @@ -22,3 +5,12 @@ export function hideEl(el: HTMLElement) { export function unhideEl(el: HTMLElement) { el.removeClass('linter-visually-hidden'); } + +export function setElContent(text: string, el: HTMLElement) { + if (text.includes(' void, name: LanguageStringKey, description: LanguageStringKey) { + constructor(containerEl: HTMLElement, public filesPicked: CustomAutoCorrectContent[], app: App, saveSettings: () => void, name: LanguageStringKey, description: LanguageStringKey) { super( containerEl, - parentComponent, getTextInLanguage(name), getTextInLanguage(description), getTextInLanguage('options.custom-auto-correct.warning-text').replace('{NAME}', getTextInLanguage('rules.auto-correct-common-misspellings.name')), diff --git a/src/ui/linter-components/custom-command-option.ts b/src/ui/linter-components/custom-command-option.ts index 391bf8e0..7f732df1 100644 --- a/src/ui/linter-components/custom-command-option.ts +++ b/src/ui/linter-components/custom-command-option.ts @@ -1,4 +1,4 @@ -import {Setting, App, Component} from 'obsidian'; +import {Setting, App} from 'obsidian'; import {getTextInLanguage} from 'src/lang/helpers'; import {AddCustomRow} from '../components/add-custom-row'; import CommandSuggester from '../suggesters/command-suggester'; @@ -6,9 +6,8 @@ import CommandSuggester from '../suggesters/command-suggester'; export type LintCommand = { id: string, name: string }; export class CustomCommandOption extends AddCustomRow { - constructor(containerEl: HTMLElement, parentComponent: Component, public lintCommands: LintCommand[], app: App, saveSettings: () => void) { + constructor(containerEl: HTMLElement, public lintCommands: LintCommand[], app: App, saveSettings: () => void) { super(containerEl, - parentComponent, getTextInLanguage('options.custom-command.name'), getTextInLanguage('options.custom-command.description'), getTextInLanguage('options.custom-command.warning'), diff --git a/src/ui/linter-components/custom-replace-option.ts b/src/ui/linter-components/custom-replace-option.ts index 15a27d15..626a4384 100644 --- a/src/ui/linter-components/custom-replace-option.ts +++ b/src/ui/linter-components/custom-replace-option.ts @@ -1,4 +1,4 @@ -import {App, Setting, Component} from 'obsidian'; +import {App, Setting} from 'obsidian'; import {getTextInLanguage} from 'src/lang/helpers'; import {AddCustomRow} from '../components/add-custom-row'; export type CustomReplace = {label: string, find: string, replace: string, flags: string}; @@ -6,10 +6,9 @@ export type CustomReplace = {label: string, find: string, replace: string, flags const defaultFlags = 'gm'; export class CustomReplaceOption extends AddCustomRow { - constructor(containerEl: HTMLElement, parentComponent: Component, public regexes: CustomReplace[], app: App, saveSettings: () => void) { + constructor(containerEl: HTMLElement, public regexes: CustomReplace[], app: App, saveSettings: () => void) { super( containerEl, - parentComponent, getTextInLanguage('options.custom-replace.name'), getTextInLanguage('options.custom-replace.description'), getTextInLanguage('options.custom-replace.warning'), diff --git a/src/ui/linter-components/files-to-ignore-option.ts b/src/ui/linter-components/files-to-ignore-option.ts index e50631d7..81de7812 100644 --- a/src/ui/linter-components/files-to-ignore-option.ts +++ b/src/ui/linter-components/files-to-ignore-option.ts @@ -1,4 +1,4 @@ -import {App, Setting, Component} from 'obsidian'; +import {App, Setting} from 'obsidian'; import {getTextInLanguage} from 'src/lang/helpers'; import {AddCustomRow} from '../components/add-custom-row'; export type FileToIgnore = {label: string, match: string, flags: string}; @@ -6,10 +6,9 @@ export type FileToIgnore = {label: string, match: string, flags: string}; const defaultFlags = 'i'; export class FilesToIgnoreOption extends AddCustomRow { - constructor(containerEl: HTMLElement, parentComponent: Component, public filesToIgnore: FileToIgnore[], app: App, saveSettings: () => void) { + constructor(containerEl: HTMLElement, public filesToIgnore: FileToIgnore[], app: App, saveSettings: () => void) { super( containerEl, - parentComponent, getTextInLanguage('tabs.general.files-to-ignore.name'), getTextInLanguage('tabs.general.files-to-ignore.description'), getTextInLanguage('tabs.general.files-to-ignore.warning'), diff --git a/src/ui/linter-components/folder-ignore-option.ts b/src/ui/linter-components/folder-ignore-option.ts index 487efe8f..1939b49e 100644 --- a/src/ui/linter-components/folder-ignore-option.ts +++ b/src/ui/linter-components/folder-ignore-option.ts @@ -1,13 +1,12 @@ -import {App, Setting, Component} from 'obsidian'; +import {App, Setting} from 'obsidian'; import {getTextInLanguage} from 'src/lang/helpers'; import {AddCustomRow} from '../components/add-custom-row'; import FolderSuggester from '../suggesters/folder-suggester'; export class FolderIgnoreOption extends AddCustomRow { - constructor(containerEl: HTMLElement, parentComponent: Component, public foldersToIgnore: string[], app: App, saveSettings: () => void) { + constructor(containerEl: HTMLElement, public foldersToIgnore: string[], app: App, saveSettings: () => void) { super( containerEl, - parentComponent, getTextInLanguage('tabs.general.folders-to-ignore.name'), getTextInLanguage('tabs.general.folders-to-ignore.description'), null, diff --git a/src/ui/linter-components/tab-components/custom-tab.ts b/src/ui/linter-components/tab-components/custom-tab.ts index 0028a004..e0b09220 100644 --- a/src/ui/linter-components/tab-components/custom-tab.ts +++ b/src/ui/linter-components/tab-components/custom-tab.ts @@ -12,13 +12,13 @@ export class CustomTab extends Tab { display(): void { const customCommandEl = this.contentEl.createDiv(); - const customCommands = new CustomCommandOption(customCommandEl, this.plugin.settingsTab.component, this.plugin.settings.lintCommands, this.app, () => { + const customCommands = new CustomCommandOption(customCommandEl, this.plugin.settings.lintCommands, this.app, () => { void this.plugin.saveSettings(); }); this.addSettingSearchInfo(customCommandEl, customCommands.name, customCommands.description.replaceAll('\n', ' ') + customCommands.warning.replaceAll('\n', ' ')); const customReplaceEl = this.contentEl.createDiv(); - const customRegexes = new CustomReplaceOption(customReplaceEl, this.plugin.settingsTab.component, this.plugin.settings.customRegexes, this.app, () => { + const customRegexes = new CustomReplaceOption(customReplaceEl, this.plugin.settings.customRegexes, this.app, () => { void this.plugin.saveSettings(); }); this.addSettingSearchInfo(customReplaceEl, customRegexes.name, customRegexes.description.replaceAll('\n', ' ') + customRegexes.warning.replaceAll('\n', ' ')); diff --git a/src/ui/linter-components/tab-components/debug-tab.ts b/src/ui/linter-components/tab-components/debug-tab.ts index ab223d6c..cd23134a 100644 --- a/src/ui/linter-components/tab-components/debug-tab.ts +++ b/src/ui/linter-components/tab-components/debug-tab.ts @@ -2,7 +2,7 @@ import log from 'loglevel'; import LinterPlugin from 'src/main'; import {Tab} from './tab'; import {TextBoxFull} from 'src/ui/components/text-box-full'; -import {parseTextToHTMLWithoutOuterParagraph} from 'src/ui/helpers'; +import {setElContent} from 'src/ui/helpers'; import {logsFromLastRun, setLogLevel} from 'src/utils/logger'; import {getTextInLanguage} from 'src/lang/helpers'; import {DropdownRecordInfo, DropdownSetting} from 'src/ui/components/dropdown-setting'; @@ -52,8 +52,7 @@ export class DebugTab extends Tab { settingDesc = getTextInLanguage('tabs.debug.linter-logs.description'); logDisplay = new TextBoxFull(tempDiv, settingName, ''); logDisplay.inputEl.setText(logsFromLastRun.join('\n')); - - parseTextToHTMLWithoutOuterParagraph(this.plugin.app, settingDesc, logDisplay.descEl, this.plugin.settingsTab.component); + setElContent(settingDesc, logDisplay.descEl); if (!recordLintOnSaveLogsSetting.getBoolean()) { logDisplay.hide(); diff --git a/src/ui/linter-components/tab-components/general-tab.ts b/src/ui/linter-components/tab-components/general-tab.ts index 7b8b09c6..8b5a81ce 100644 --- a/src/ui/linter-components/tab-components/general-tab.ts +++ b/src/ui/linter-components/tab-components/general-tab.ts @@ -122,14 +122,14 @@ export class GeneralTab extends Tab { this.addSettingSearchInfoForGeneralSettings(new NumberInputSetting(tempDiv, 'tabs.general.number-of-dollar-signs-to-indicate-math-block.name', 'tabs.general.number-of-dollar-signs-to-indicate-math-block.description', 'commonStyles.minimumNumberOfDollarSignsToBeAMathBlock', this.plugin)); const folderIgnoreEl = this.contentEl.createDiv(); - const folderIgnore = new FolderIgnoreOption(folderIgnoreEl, this.plugin.settingsTab.component, this.plugin.settings.foldersToIgnore, this.app, () => { + const folderIgnore = new FolderIgnoreOption(folderIgnoreEl, this.plugin.settings.foldersToIgnore, this.app, () => { void this.plugin.saveSettings(); }); this.addSettingSearchInfo(folderIgnoreEl, folderIgnore.name, folderIgnore.description.replaceAll('\n', ' ')); const filesToIgnoreEl = this.contentEl.createDiv(); - const filesToIgnore = new FilesToIgnoreOption(filesToIgnoreEl, this.plugin.settingsTab.component, this.plugin.settings.filesToIgnore, this.app, () => { + const filesToIgnore = new FilesToIgnoreOption(filesToIgnoreEl, this.plugin.settings.filesToIgnore, this.app, () => { void this.plugin.saveSettings(); }); diff --git a/src/ui/linter-components/tab-components/rule-tab.ts b/src/ui/linter-components/tab-components/rule-tab.ts index ebf90ef2..2ffa2e81 100644 --- a/src/ui/linter-components/tab-components/rule-tab.ts +++ b/src/ui/linter-components/tab-components/rule-tab.ts @@ -15,7 +15,7 @@ export class RuleTab extends Tab { const ruleDiv = this.contentEl.createDiv(); ruleDiv.id = rule.alias; - new Setting(ruleDiv).setHeading().settingEl.innerHTML = `${rule.getName()}`; + new Setting(ruleDiv).setHeading().nameEl.createEl('a', {href: rule.getURL(), text: rule.getName()}); const optionInfo = [] as SearchOptionInfo[]; let isFirstOption = true; diff --git a/src/ui/linter-components/tab-components/tab-searcher.ts b/src/ui/linter-components/tab-components/tab-searcher.ts index f801fa3b..10582591 100644 --- a/src/ui/linter-components/tab-components/tab-searcher.ts +++ b/src/ui/linter-components/tab-components/tab-searcher.ts @@ -21,7 +21,7 @@ export class TabSearcher { display() { const searchSetting = new Setting(this.containerEl); - searchSetting.settingEl.style.border = 'none'; + searchSetting.settingEl.addClass('linter-no-border'); searchSetting.addSearch((s: SearchComponent) => { this.search = s; }); diff --git a/src/ui/modals/lint-confirmation-modal.ts b/src/ui/modals/lint-confirmation-modal.ts index 8cdfa241..23811c40 100644 --- a/src/ui/modals/lint-confirmation-modal.ts +++ b/src/ui/modals/lint-confirmation-modal.ts @@ -8,10 +8,10 @@ export class LintConfirmationModal extends Modal { super(app); this.modalEl.addClass('confirm-modal'); - this.contentEl.createEl('h3', {text: getTextInLanguage('warning-text')}).style.textAlign = 'center'; + this.contentEl.createEl('h3', {text: getTextInLanguage('warning-text'), cls: 'modal-heading'}); if (showCustomCommandWarning) { - this.contentEl.createEl('p', {text: getTextInLanguage('custom-command-warning')}).style.fontWeight = 'bold'; + this.contentEl.createEl('p', {text: getTextInLanguage('custom-command-warning'), cls: 'modal-warn'}); } this.contentEl.createEl('p', diff --git a/src/ui/modals/parse-results-modal.ts b/src/ui/modals/parse-results-modal.ts index ac9ccd3d..65940efd 100644 --- a/src/ui/modals/parse-results-modal.ts +++ b/src/ui/modals/parse-results-modal.ts @@ -8,7 +8,7 @@ export class ParseResultsModal extends Modal { super(app); this.modalEl.addClass('confirm-modal'); - this.contentEl.createEl('h3', {text: getTextInLanguage('parse-results-heading-text')}).style.textAlign = 'center'; + this.contentEl.createEl('h3', {text: getTextInLanguage('parse-results-heading-text'), cls: 'modal-heading'}); if (customAutoCorrectionInfo?.customReplacements.size > 0) { this.contentEl.createEl('p', {text: getTextInLanguage('file-parse-description-text').replace('{FILE}', customAutoCorrectionInfo.filePath)}).id = 'confirm-dialog'; @@ -25,7 +25,7 @@ export class ParseResultsModal extends Modal { tableRow.createEl('td', {text: replacementInfo[1]}); } } else { - this.contentEl.createEl('p', {text: getTextInLanguage('no-parsed-values-found-text').replaceAll('{FILE}', customAutoCorrectionInfo.filePath)}).style.fontWeight = 'bold'; + this.contentEl.createEl('p', {text: getTextInLanguage('no-parsed-values-found-text').replaceAll('{FILE}', customAutoCorrectionInfo.filePath), cls: 'modal-warn'}); } this.contentEl.createDiv('modal-button-container', (buttonsEl) => { diff --git a/src/ui/settings.ts b/src/ui/settings.ts index 51bf5bd5..81999351 100644 --- a/src/ui/settings.ts +++ b/src/ui/settings.ts @@ -1,4 +1,4 @@ -import {App, Component, Platform, PluginSettingTab} from 'obsidian'; +import {App, Platform, PluginSettingTab} from 'obsidian'; import LinterPlugin from 'src/main'; import {RuleType, ruleTypeToRules} from 'src/rules'; import {hideEl} from './helpers'; @@ -14,7 +14,6 @@ export class SettingTab extends PluginSettingTab { navContainer: HTMLElement; tabNavEl: HTMLDivElement; settingsContentEl: HTMLDivElement; - component: Component; private tabNameToTab: Map