Merge pull request platers#1231 from pjkaufman/master

Feat: Add Ability to Enable/Disable Custom Commands and Custom Replacements

Author: pjkaufman

__integration__/custom-commands.test.ts

@@ -13,6 +13,7 @@ export const customCommandTestCases: IntegrationTestCase[] = [
       plugin.plugin.settings.lintCommands = [{
         'id': 'table-editor-obsidian:format-all-tables',
         'name': 'Format all tables in this file',
+        'enabled': true,
       }];
     },
   },

__tests__/rules-runner.test.ts

@@ -2,6 +2,7 @@ import {Command} from 'obsidian';
 import {RulesRunner} from '../src/rules-runner';
 import {CustomReplace} from '../src/ui/linter-components/custom-replace-option';
 import dedent from 'ts-dedent';
+import {LintCommand} from 'src/ui/linter-components/custom-command-option';
 
 const rulesRunner = new RulesRunner();
 const appCommandsMock = {
@@ -31,7 +32,7 @@ const appCommandsMock = {
 
 type CustomCommandTestCase = {
   testName: string,
-  listOfCommands: Command[],
+  listOfCommands: LintCommand[],
   expectedCommandCount: Map<string, number>;
   expectedNumberOfCommandsRun: number;
   skipFileValue: boolean
@@ -48,8 +49,8 @@ const customCommandTestCases: CustomCommandTestCase[] = [
   {
     testName: 'When an app lint command is run it should be executed',
     listOfCommands: [
-      {id: 'first id', name: 'command name'},
-      {id: 'second id', name: 'command name 2'},
+      {id: 'first id', name: 'command name', enabled: true},
+      {id: 'second id', name: 'command name 2', enabled: true},
     ],
     expectedCommandCount: new Map([
       ['first id', 1],
@@ -61,7 +62,7 @@ const customCommandTestCases: CustomCommandTestCase[] = [
   {
     testName: 'A lint command with an empty id should not get run',
     listOfCommands: [
-      {id: '', name: ''},
+      {id: '', name: '', enabled: true},
     ],
     expectedCommandCount: new Map([
       ['', 0],
@@ -72,8 +73,8 @@ const customCommandTestCases: CustomCommandTestCase[] = [
   {
     testName: 'When custom commands are run with two of the same command, the second command instance is skipped',
     listOfCommands: [
-      {id: 'first id', name: 'command name'},
-      {id: 'first id', name: 'command name'},
+      {id: 'first id', name: 'command name', enabled: true},
+      {id: 'first id', name: 'command name', enabled: true},
     ],
     expectedCommandCount: new Map([
       ['first id', 1],
@@ -84,13 +85,23 @@ const customCommandTestCases: CustomCommandTestCase[] = [
   {
     testName: 'When the file is listed to be skipped, no custom commands are run',
     listOfCommands: [
-      {id: 'first id', name: 'command name'},
-      {id: 'second id', name: 'command name 2'},
+      {id: 'first id', name: 'command name', enabled: true},
+      {id: 'second id', name: 'command name 2', enabled: true},
     ],
     expectedCommandCount: new Map<string, number>(),
     expectedNumberOfCommandsRun: 0,
     skipFileValue: true,
   },
+  {
+    testName: 'When the custom commands are not enabled, nothing gets run',
+    listOfCommands: [
+      {id: 'first id', name: 'command name', enabled: false},
+      {id: 'second id', name: 'command name 2', enabled: false},
+    ],
+    expectedCommandCount: new Map<string, number>(),
+    expectedNumberOfCommandsRun: 0,
+    skipFileValue: false,
+  },
 ];
 
 
@@ -106,7 +117,7 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace with no find value does not affect the text',
     listOfRegexReplacements: [
       {
-        label: '', find: '', replace: 'hello', flags: 'g',
+        label: '', find: '', replace: 'hello', flags: 'g', enabled: true,
       },
     ],
     before: dedent`
@@ -122,10 +133,10 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace with a null or undefined find value does not affect the text',
     listOfRegexReplacements: [
       {
-        label: '', find: 'How', replace: null, flags: '',
+        label: '', find: 'How', replace: null, flags: '', enabled: true,
       },
       {
-        label: 'Replace 2', find: 'look', replace: undefined, flags: '',
+        label: 'Replace 2', find: 'look', replace: undefined, flags: '', enabled: true,
       },
     ],
     before: dedent`
@@ -141,7 +152,7 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace searching for multiple blank lines in a row works (has proper escaping of a slash)',
     listOfRegexReplacements: [
       {
-        label: 'condense multiple blanks into 1', find: '\n{3,}', replace: '\n\n', flags: 'g',
+        label: 'condense multiple blanks into 1', find: '\n{3,}', replace: '\n\n', flags: 'g', enabled: true,
       },
     ],
     before: dedent`
@@ -160,7 +171,7 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace using capture groups works',
     listOfRegexReplacements: [
       {
-        label: 'Remove a question mark proceeded by a k or an e', find: '(k|e)(\\?)', replace: '$1', flags: 'g',
+        label: 'Remove a question mark proceeded by a k or an e', find: '(k|e)(\\?)', replace: '$1', flags: 'g', enabled: true,
       },
     ],
     before: dedent`
@@ -176,7 +187,7 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace using ^ and $ works',
     listOfRegexReplacements: [
       {
-        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm',
+        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm', enabled: true,
       },
     ],
     before: dedent`
@@ -192,7 +203,7 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace should respect linter ignore ranges',
     listOfRegexReplacements: [
       {
-        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm',
+        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm', enabled: true,
       },
     ],
     before: dedent`
@@ -212,23 +223,23 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
     testName: 'A custom replace with an undefined label should still run.',
     listOfRegexReplacements: [
       {
-        label: undefined, find: 'lobo', replace: 'hello', flags: 'g',
+        label: undefined, find: 'lobo', replace: 'hello', flags: 'g', enabled: true,
       },
     ],
     before: dedent`
-      How does this look?
+      How does this lobo?
       Did it stay the same?
     `,
     after: dedent`
-      How does this look?
+      How does this hello?
       Did it stay the same?
     `,
   },
   { // relates for https://github.com/platers/obsidian-linter/issues/1121
     testName: 'A custom replace should respect linter ignore ranges that use the Obsidian comment format',
     listOfRegexReplacements: [
       {
-        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm',
+        label: 'Replace Did at the start of a line or look? at the end of a line', find: '(^Did)|(look\\?$)', replace: 'swapped', flags: 'gm', enabled: true,
       },
     ],
     before: dedent`
@@ -244,6 +255,22 @@ const customReplaceTestCases: CustomReplaceTestCase[] = [
       %% linter-enable %%
     `,
   },
+  {
+    testName: 'A custom replace that is not enabled should not run',
+    listOfRegexReplacements: [
+      {
+        label: undefined, find: 'lobo', replace: 'hello', flags: 'g', enabled: false,
+      },
+    ],
+    before: dedent`
+      How does this look?
+      Did it stay the same?
+    `,
+    after: dedent`
+      How does this look?
+      Did it stay the same?
+    `,
+  },
 ];
 
 describe('Rules Runner', () => {

docs/docs/assets/files-to-ignore.jpg

@@ -675,6 +675,22 @@ export default class LinterPlugin extends Plugin {
       }
     }
 
+    // make sure that all custom replacements have the enabled property
+    for (const customReplace of this.settings.customRegexes) {
+      if (!Object.hasOwn(customReplace, 'enabled')) {
+        customReplace.enabled = true;
+        updateMade = true;
+      }
+    }
+
+    // make sure that all custom commands have the enabled property
+    for (const customCommand of this.settings.lintCommands) {
+      if (!Object.hasOwn(customCommand, 'enabled')) {
+        customCommand.enabled = true;
+        updateMade = true;
+      }
+    }
+
     if (updateMade) {
       await this.saveSettings();
     }
@@ -1074,7 +1090,7 @@ export default class LinterPlugin extends Plugin {
 
   private updateHasCustomCommandStatus() {
     for (const customCommand of this.settings.lintCommands) {
-      if (customCommand.id && customCommand.id.trim() != '') {
+      if (customCommand.id && customCommand.id.trim() != '' && customCommand.enabled) {
         this.hasCustomCommands = true;
         return;
       }

docs/docs/assets/folders-to-ignore.jpg

@@ -219,7 +219,7 @@ export class RulesRunner {
     logDebug(getTextInLanguage('logs.running-custom-lint-command'));
     const commandsRun = new Set<string>();
     for (const commandInfo of lintCommands) {
-      if (!commandInfo.id) {
+      if (!commandInfo.id || !commandInfo.enabled) {
         continue;
       } else if (commandsRun.has(commandInfo.id)) {
         logWarn(getTextInLanguage('logs.custom-lint-duplicate-warning').replace('{COMMAND_NAME}', commandInfo.name));
@@ -244,7 +244,7 @@ export class RulesRunner {
       for (const eachRegex of customRegexes) {
         const findIsEmpty = eachRegex.find === undefined || eachRegex.find == '' || eachRegex.find === null;
         const replaceIsEmpty = eachRegex.replace === undefined || eachRegex.replace === null;
-        if (findIsEmpty || replaceIsEmpty) {
+        if (findIsEmpty || replaceIsEmpty || !eachRegex.enabled) {
           continue;
         }
 

src/main.ts

@@ -101,7 +101,7 @@ export class AutoCorrectFilesPickerOption extends AddCustomRefreshableRow {
           }
         })
         .addExtraButton((cb) => {
-          cb.setIcon('cross')
+          cb.setIcon('trash')
               .setTooltip(getTextInLanguage('options.custom-auto-correct.delete-tooltip'))
               .onClick(() => {
                 this.filesPicked.splice(index, 1);

src/rules-runner.ts

@@ -3,7 +3,7 @@ import {getTextInLanguage} from 'src/lang/helpers';
 import {AddCustomRow} from '../components/add-custom-row';
 import CommandSuggester from '../suggesters/command-suggester';
 
-export type LintCommand = { id: string, name: string };
+export type LintCommand = { id: string, name: string, enabled: boolean };
 
 export class CustomCommandOption extends AddCustomRow {
   constructor(containerEl: HTMLElement, public lintCommands: LintCommand[], app: App, saveSettings: () => void) {
@@ -15,7 +15,7 @@ export class CustomCommandOption extends AddCustomRow {
         app,
         saveSettings,
         () => {
-          const newCommand = {id: '', name: ''};
+          const newCommand = {id: '', name: '', enabled: true};
           this.lintCommands.push(newCommand);
           this.saveSettings();
           this.addCommand(newCommand, this.lintCommands.length - 1, true);
@@ -37,7 +37,7 @@ export class CustomCommandOption extends AddCustomRow {
           cb.setPlaceholder(getTextInLanguage('options.custom-command.command-search-placeholder-text'))
               .setValue(command.name)
               .onChange((newCommandName) => {
-                const newCommand = {id: cb.inputEl.getAttribute('commandId'), name: newCommandName};
+                const newCommand = {id: cb.inputEl.getAttribute('commandId'), name: newCommandName, enabled: command.enabled};
 
                 // make sure that the command is valid before making any attempt to save the value
                 if (newCommand.name && newCommand.id) {
@@ -75,13 +75,18 @@ export class CustomCommandOption extends AddCustomRow {
               });
         })
         .addExtraButton((cb) => {
-          cb.setIcon('cross')
+          cb.setIcon('trash')
               .setTooltip(getTextInLanguage('options.custom-command.delete-tooltip'))
               .onClick(() => {
                 this.lintCommands.splice(index, 1);
                 this.saveSettings();
                 this.resetInputEls();
               });
+        }).addToggle((cb) => {
+          cb.setValue(command.enabled)
+              .onChange((status: boolean) => {
+                command.enabled = status;
+              });
         });
   }
 

src/ui/linter-components/auto-correct-files-picker-option.ts

@@ -1,7 +1,7 @@
 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};
+export type CustomReplace = {label: string, find: string, replace: string, flags: string, enabled: boolean};
 
 const defaultFlags = 'gm';
 
@@ -16,7 +16,7 @@ export class CustomReplaceOption extends AddCustomRow {
         app,
         saveSettings,
         ()=>{
-          const newRegex = {label: '', find: '', replace: '', flags: defaultFlags};
+          const newRegex = {label: '', find: '', replace: '', flags: defaultFlags, enabled: true};
           this.regexes.push(newRegex);
           this.saveSettings();
           this.addRegex(newRegex, this.regexes.length - 1, true);
@@ -101,13 +101,18 @@ export class CustomReplaceOption extends AddCustomRow {
             this.resetInputEls();
           });
     }).addExtraButton((cb)=>{
-      cb.setIcon('cross')
+      cb.setIcon('trash')
           .setTooltip(getTextInLanguage('options.custom-replace.delete-tooltip'))
           .onClick(()=>{
             this.regexes.splice(index, 1);
             this.saveSettings();
             this.resetInputEls();
           });
+    }).addToggle((cb) => {
+      cb.setValue(regex.enabled)
+          .onChange((status: boolean) => {
+            regex.enabled = status;
+          });
     });
 
     setting.settingEl.addClass('linter-custom-regex-replacement-row2');

src/ui/linter-components/custom-command-option.ts

@@ -64,7 +64,7 @@ export class FilesToIgnoreOption extends AddCustomRow {
 
       cb.inputEl.addClass('linter-files-to-ignore-flags');
     }).addExtraButton((cb)=>{
-      cb.setIcon('cross')
+      cb.setIcon('trash')
           .setTooltip(getTextInLanguage('tabs.general.files-to-ignore.delete-tooltip'))
           .onClick(()=>{
             this.filesToIgnore.splice(index, 1);