Merge pull request platers#1247 from pjkaufman/easier-ignore

Feat: Add Ability to Ignore Files and Folders from Popup Menu and Commands

Author: pjkaufman

src/lang/locale/en.ts

@@ -32,12 +32,24 @@ export default {
     'paste-as-plain-text': {
       'name': 'Paste as Plain Text & without Modifications',
     },
+    'ignore-folder': {
+      'name': 'Ignore folder',
+    },
+    'ignore-file': {
+      'name': 'Ignore file',
+    },
     'lint-file-pop-up-menu-text': {
       'name': 'Lint file',
     },
     'lint-folder-pop-up-menu-text': {
       'name': 'Lint folder',
     },
+    'ignore-file-pop-up-menu-text': {
+      'name': 'Ignore file in Linter',
+    },
+    'ignore-folder-pop-up-menu-text': {
+      'name': 'Ignore folder in Linter',
+    },
   },
 
   'logs': {

src/main.ts

@@ -11,7 +11,7 @@ import {createRunLinterRulesOptions, RulesRunner} from './rules-runner';
 import {LinterError} from './linter-error';
 import {LintConfirmationModal} from './ui/modals/lint-confirmation-modal';
 import {SettingTab} from './ui/settings';
-import {urlRegex} from './utils/regex';
+import {escapeRegExp, urlRegex} from './utils/regex';
 import {getTextInLanguage, LanguageStringKey, setLanguage} from './lang/helpers';
 import {RuleAliasSuggest} from './cm6/rule-alias-suggester';
 import {AfterFileChangeLintTimes, DEFAULT_SETTINGS, LinterSettings} from './settings-data';
@@ -215,6 +215,36 @@ export default class LinterPlugin extends Plugin {
         void this.pasteAsPlainText(editor);
       },
     });
+
+    this.addCommand({
+      id: 'ignore-folder',
+      name: getTextInLanguage('commands.ignore-folder.name'),
+      icon: iconInfo.ignoreFolder.id,
+      editorCheckCallback: (checking: boolean, _, ctx) => {
+        if (checking) {
+          if (ctx && ctx.file && ctx.file instanceof TFile && ctx.file.parent) {
+            return !ctx.file.parent.isRoot() && !this.settings.foldersToIgnore.includes(ctx.file.parent.path);
+          }
+
+          return false;
+        }
+
+        void this.addFolderToIgnoreList(ctx.file.parent);
+      },
+    });
+
+    this.addCommand({
+      id: 'ignore-file',
+      name: getTextInLanguage('commands.ignore-file.name'),
+      editorCheckCallback(checking, _, ctx) {
+        if (checking && ctx.file) {
+          return that.isMarkdownFile(ctx.file) && !that.shouldIgnoreFile(ctx.file);
+        }
+
+        void this.addFileToIgnoreList(ctx.file);
+      },
+      icon: iconInfo.ignoreFile.id,
+    });
   }
 
   registerEventsAndSaveCallback() {
@@ -365,26 +395,43 @@ export default class LinterPlugin extends Plugin {
 
   onMenuOpenCallback(menu: Menu, file: TAbstractFile, _source: string) {
     if (file instanceof TFile && this.isMarkdownFile(file)) {
-      menu.addItem((item) => {
-        item.setIcon(iconInfo.file.id)
-            .setTitle(getTextInLanguage('commands.lint-file-pop-up-menu-text.name'))
-            .onClick(() => {
-              const activeFile = this.app.workspace.getActiveFile();
-              const editor = this.getEditor();
-              if (activeFile === file && editor && editor.cm) {
-                void this.runLinterEditor(editor);
-              } else {
-                void this.runLinterFile(file);
-              }
-            });
-      });
+      if (!this.shouldIgnoreFile(file)) {
+        menu.addItem((item) => {
+          item.setIcon(iconInfo.file.id)
+              .setTitle(getTextInLanguage('commands.lint-file-pop-up-menu-text.name'))
+              .onClick(() => {
+                const activeFile = this.app.workspace.getActiveFile();
+                const editor = this.getEditor();
+                if (activeFile === file && editor && editor.cm) {
+                  void this.runLinterEditor(editor);
+                } else {
+                  void this.runLinterFile(file);
+                }
+              });
+        });
+
+        menu.addItem((item) => {
+          item.setIcon(iconInfo.ignoreFile.id)
+              .setTitle(getTextInLanguage('commands.ignore-file-pop-up-menu-text.name'))
+              .onClick(() => {
+                void this.addFileToIgnoreList(file);
+              });
+        });
+      }
     } else if (file instanceof TFolder) {
-      menu.addItem((item) => {
-        item
-            .setTitle(getTextInLanguage('commands.lint-folder-pop-up-menu-text.name'))
-            .setIcon(iconInfo.folder.id)
-            .onClick(() => this.createFolderLintModal(file));
-      });
+      if (!this.settings.foldersToIgnore.includes(file.path)) {
+        menu.addItem((item) => {
+          item.setTitle(getTextInLanguage('commands.lint-folder-pop-up-menu-text.name'))
+              .setIcon(iconInfo.folder.id)
+              .onClick(() => this.createFolderLintModal(file));
+        });
+
+        menu.addItem((item) => {
+          item.setTitle(getTextInLanguage('commands.ignore-folder-pop-up-menu-text.name'))
+              .setIcon(iconInfo.ignoreFolder.id)
+              .onClick(() => void this.addFolderToIgnoreList(file));
+        });
+      }
     }
   }
 
@@ -1118,4 +1165,20 @@ export default class LinterPlugin extends Plugin {
       this.activeFileChangeDebouncer.get(file.path).originalText = newText;
     }
   }
+
+  private async addFileToIgnoreList(file: TFile) {
+    this.settings.filesToIgnore.push({
+      match: '^' + escapeRegExp(file.path) + '$',
+      flags: '',
+      label: '',
+    });
+
+    await this.saveSettings();
+  }
+
+  private async addFolderToIgnoreList(folder: TFolder) {
+    this.settings.foldersToIgnore.push(folder.path);
+
+    await this.saveSettings();
+  }
 }

src/ui/icons.ts

@@ -136,10 +136,27 @@ const successSVG = `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="
   <polyline points="20 6 9 17 4 12"/>
 </svg>`;
 
+// https://lucide.dev/icons/file-x
+const ignoreFileSVG = `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-file-x">
+  <path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"/>
+  <path d="M14 2v4a2 2 0 0 0 2 2h4"/>
+  <path d="m14.5 12.5-5 5"/>
+  <path d="m9.5 12.5 5 5"/>
+</svg>`;
+
+// https://lucide.dev/icons/folder-x
+const ignoreFolderSVG = `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-folder-x">
+  <path d="M20 20a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-7.9a2 2 0 0 1-1.69-.9L9.6 3.9A2 2 0 0 0 7.93 3H4a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2Z"/>
+  <path d="m9.5 10.5 5 5"/>
+  <path d="m14.5 10.5-5 5"/>
+</svg>`;
+
 // exported SVG info
 export const iconInfo: Record<string, {id: string, source: string}> = {
   folder: {id: 'lint-folder', source: lintFolderSVG},
+  ignoreFolder: {id: 'lint-ignore-folder', source: ignoreFolderSVG},
   file: {id: 'lint-file', source: lintFileSVG},
+  ignoreFile: {id: 'lint-ignored-file', source: ignoreFileSVG},
   vault: {id: 'lint-vault', source: lintVaultSVG},
   whitespace: {id: 'lint-whitespace', source: whitespaceSVG},
   math: {id: 'lint-math', source: mathSVG},