Merge pull request #191 from koloml/feature/build-extension-for-local-philomena

Added build option to build it against local Philomena

.vite/pack-extension.js

@@ -69,6 +69,12 @@ export async function packExtension(settings) {
   })
 
   switch (process.env.SITE) {
+    case 'localhost':
+      manifest.replaceHostTo('localhost');
+      manifest.replaceBooruNameWith('Philomena');
+      manifest.setGeckoIdentifier('philomena-tagging-assistant@thecore.city');
+      break;
+
     case 'derpibooru':
       manifest.replaceHostTo([
         'derpibooru.org',

package.json

@@ -7,6 +7,7 @@
         "build": "npm run build:popup && npm run build:extension",
         "build:derpibooru": "cross-env SITE=derpibooru npm run build",
         "build:tantabus": "cross-env SITE=tantabus npm run build",
+        "build:local": "cross-env SITE=localhost npm run build",
         "build:popup": "vite build",
         "build:extension": "node build-extension.js",
         "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",

src/content/components/base/BaseComponent.ts

@@ -77,7 +77,7 @@ export class BaseComponent<ContainerType extends HTMLElement = HTMLElement> {
   ): () => void {
     this.#container.addEventListener(event, listener, options);
 
-    return () => this.#container.removeEventListener(event, listener, options);
+    return () => void this.#container.removeEventListener(event, listener, options);
   }
 
   /**

src/content/components/extension/FullscreenViewer.ts

@@ -11,15 +11,15 @@ import type { TaggingProfilePopup } from "$content/components/extension/profiles
 
 export class FullscreenViewer extends BaseComponent {
   #currentMediaBox: MediaBox | null = null;
-  readonly #videoElement: HTMLVideoElement = document.createElement('video');
-  readonly #imageElement: HTMLImageElement = document.createElement('img');
-  readonly #spinnerElement: HTMLElement = document.createElement('i');
-  readonly #sizeSelectorElement: HTMLSelectElement = document.createElement('select');
-  readonly #closeButtonElement: HTMLElement = document.createElement('i');
-  readonly #tagsPopupElement: HTMLElement = document.createElement('div');
-  readonly #imageTagsToggler: TagsListToggler = TagsListToggler.create();
-  readonly #profileTagsToggler: TagsListToggler = TagsListToggler.create();
-  readonly #tagsPopupHider: HTMLElement = document.createElement('div');
+  #videoElement: HTMLVideoElement = document.createElement('video');
+  #imageElement: HTMLImageElement = document.createElement('img');
+  #spinnerElement: HTMLElement = document.createElement('i');
+  #sizeSelectorElement: HTMLSelectElement = document.createElement('select');
+  #closeButtonElement: HTMLElement = document.createElement('i');
+  #tagsPopupElement: HTMLElement = document.createElement('div');
+  #imageTagsToggler: TagsListToggler = TagsListToggler.create();
+  #profileTagsToggler: TagsListToggler = TagsListToggler.create();
+  #tagsPopupHider: HTMLElement = document.createElement('div');
   #activeProfileListenerUnsubscriber: UnsubscribeFunction | null = null;
   #touchId: number | null = null;
   #startX: number | null = null;
@@ -412,7 +412,7 @@ export class FullscreenViewer extends BaseComponent {
   }
 
   #togglePopupVisibility(maybeState: boolean | undefined = undefined) {
-    if (maybeState === undefined) {
+    if (typeof maybeState === 'undefined') {
       const isHidden = this.#tagsPopupElement.classList.toggle(FullscreenViewer.#collapsedPopupState);
       void FullscreenViewer.#preferences.fullscreenViewerPopupShown.set(!isHidden);
       return;
@@ -425,21 +425,21 @@ export class FullscreenViewer extends BaseComponent {
     return url.endsWith('.mp4') || url.endsWith('.webm');
   }
 
-  static readonly #preferences = new MiscPreferences();
+  static #preferences = new MiscPreferences();
 
-  static readonly #offsetProperty = '--offset';
-  static readonly #opacityProperty = '--opacity';
-  static readonly #shownState = 'shown';
-  static readonly #swipeState = 'swiped';
-  static readonly #minRequiredDistance = 50;
-  static readonly #collapsedPopupState = 'is-collapsed';
+  static #offsetProperty = '--offset';
+  static #opacityProperty = '--opacity';
+  static #shownState = 'shown';
+  static #swipeState = 'swiped';
+  static #minRequiredDistance = 50;
+  static #collapsedPopupState = 'is-collapsed';
 
-  static readonly #previewSizes: Record<FullscreenViewerSize, string> = {
+  static #previewSizes: Record<FullscreenViewerSize, string> = {
     full: 'Full',
     large: 'Large',
     medium: 'Medium',
     small: 'Small'
   }
 
-  static readonly #fallbackSize = 'large';
+  static #fallbackSize = 'large';
 }

src/content/components/extension/ImageShowFullscreenButton.ts

@@ -81,5 +81,5 @@ export class ImageShowFullscreenButton extends BaseComponent {
     return viewer;
   }
 
-  static readonly #preferences = new MiscPreferences();
+  static #preferences = new MiscPreferences();
 }

src/content/components/extension/presets/EditorPresetsBlock.ts

@@ -5,8 +5,8 @@ import { createFontAwesomeIcon } from "$lib/dom-utils";
 import { sortEntitiesByField } from "$lib/utils";
 
 export default class EditorPresetsBlock extends BaseComponent {
-  readonly #presetsTable = document.createElement('table');
-  readonly #presetBlocks: PresetTableRow[] = [];
+  #presetsTable = document.createElement('table');
+  #presetBlocks: PresetTableRow[] = [];
   #tags: Set<string> = new Set();
 
   protected build() {

src/content/components/extension/presets/PresetTableRow.ts

@@ -207,6 +207,6 @@ export default class PresetTableRow extends BaseComponent {
     return new this(document.createElement('tr'), preset);
   }
 
-  static readonly #tagMissingClassName = 'is-missing';
-  static readonly #presetWarningClassName = 'has-warning';
+  static #tagMissingClassName = 'is-missing';
+  static #presetWarningClassName = 'has-warning';
 }

src/content/components/extension/profiles/TaggingProfilePopup.ts

@@ -16,14 +16,14 @@ import { EVENT_TAG_TOGGLED } from "$content/components/events/tags-list-toggler-
 
 
 export class TaggingProfilePopup extends BaseComponent {
-  readonly #tagsListToggler = TagsListToggler.create();
+  #tagsListToggler = TagsListToggler.create();
   #activeProfile: TaggingProfile | null = null;
   #mediaBoxTools: MediaBoxTools | null = null;
   #isSubmissionLocked: boolean = false;
   #isPlanningToSubmit: boolean = false;
   #isSubmitting: boolean = false;
   #tagsSubmissionTimer: Timeout | null = null;
-  readonly #emitter = emitterAt(this);
+  #emitter = emitterAt(this);
 
   /**
    * @protected
@@ -211,7 +211,7 @@ export class TaggingProfilePopup extends BaseComponent {
       return;
     }
 
-    this.#tagsListToggler.prependTags(tagsBlacklist.filter(tagName => activeTags.has(tagName)), activeTags);
+    this.#tagsListToggler.prependTags(tagsBlacklist, activeTags);
   }
 
   static create(): HTMLElement {
@@ -226,7 +226,7 @@ export class TaggingProfilePopup extends BaseComponent {
   /**
    * Controller with maintenance settings.
    */
-  static readonly #preferences = new TaggingProfilesPreferences();
+  static #preferences = new TaggingProfilesPreferences();
 
   /**
    * Subscribe to all necessary feeds to watch for every active profile change. Additionally, will execute the callback
@@ -298,9 +298,9 @@ export class TaggingProfilePopup extends BaseComponent {
     });
   }
 
-  static readonly #scrapedAPI = new ScrapedAPI();
+  static #scrapedAPI = new ScrapedAPI();
 
-  static readonly #delayBeforeSubmissionMs = 500;
+  static #delayBeforeSubmissionMs = 500;
 
   /**
    * Amount of pending submissions or NULL if logic was not yet initialized.

src/content/components/extension/profiles/TagsListToggler.ts

@@ -10,7 +10,6 @@ export default class TagsListToggler extends BaseComponent {
   #invalidTagsList: Map<string, HTMLElement> = new Map();
   #tagsToAdd: Set<string> = new Set();
   #tagsToRemove: Set<string> = new Set();
-  #renderedTags: Set<string> = new Set();
 
   protected build() {
     this.container.classList.add('tags-list');
@@ -35,7 +34,6 @@ export default class TagsListToggler extends BaseComponent {
 
     this.#tagsList = [];
     this.#invalidTagsList = new Map();
-    this.#renderedTags = new Set();
 
     this.#renderAndInsertTags(tags, activeTags);
   }
@@ -60,18 +58,14 @@ export default class TagsListToggler extends BaseComponent {
   #renderAndInsertTags(toggleableTags: string[], activeTags: Set<string>, shouldPrepend: boolean = false) {
     toggleableTags.sort((a, b) => a.localeCompare(b));
 
-    let lastInserted: HTMLElement | null = null;
+    let lastInserted: HTMLElement|null = null;
 
     const hasStoredChanges = this.hasChanges;
 
-    for (const tagName of toggleableTags) {
-      if (this.#renderedTags.has(tagName)) {
-        continue;
-      }
-
-      this.#renderedTags.add(tagName);
-
+    for (let tagIndex = 0; tagIndex < toggleableTags.length; tagIndex++) {
+      const tagName = toggleableTags[tagIndex];
       const tagElement = TagsListToggler.#buildTagElement(tagName);
+
       this.#tagsList.push(tagElement);
 
       const isPresent = activeTags.has(tagName);
@@ -212,6 +206,7 @@ export default class TagsListToggler extends BaseComponent {
    */
   static #markTagElementWithCategory(tagElement: HTMLElement, category: string) {
     tagElement.dataset.tagCategory = category;
+    tagElement.setAttribute('data-tag-category', category);
   }
 
   static create(): TagsListToggler {
@@ -219,11 +214,11 @@ export default class TagsListToggler extends BaseComponent {
     return new TagsListToggler(tagsListContainer);
   }
 
-  static readonly #containsClass = 'is-present';
-  static readonly #missingClass = 'is-missing';
+  static #containsClass = 'is-present';
+  static #missingClass = 'is-missing';
 
-  static readonly #addedClass = 'is-added';
-  static readonly #removedClass = 'is-removed';
+  static #addedClass = 'is-added';
+  static #removedClass = 'is-removed';
 }
 
 export class BlackListedTagsEncounteredError extends Error {

src/content/components/philomena/BlockCommunication.ts

@@ -112,14 +112,14 @@ export class BlockCommunication extends BaseComponent {
       );
   }
 
-  static readonly #preferences = new TagsPreferences();
+  static #preferences = new TagsPreferences();
 
   /**
    * Map of links to their original texts. These texts need to be stored here to make them restorable. Keys is a link
    * element and value is a text.
    * @private
    */
-  static readonly #originalTagLinkTexts: WeakMap<HTMLElement, string> = new WeakMap();
+  static #originalTagLinkTexts: WeakMap<HTMLElement, string> = new WeakMap();
 
   static findAndInitializeAll() {
     for (const container of document.querySelectorAll<HTMLElement>('.block.communication')) {

src/content/components/philomena/TagDropdown.ts

@@ -88,12 +88,14 @@ export class TagDropdown extends BaseComponent {
     // Make sure original category is properly stored.
     this.originalCategory;
 
+    this.container.dataset.tagCategory = targetCategory;
+
     if (targetCategory) {
-      this.container.dataset.tagCategory = targetCategory;
+      this.container.setAttribute('data-tag-category', targetCategory);
       return;
     }
 
-    delete this.container.dataset.tagCategory;
+    this.container.removeAttribute('data-tag-category');
   }
 
   /**
@@ -201,7 +203,7 @@ export class TagDropdown extends BaseComponent {
     await this.#activeProfile.save();
   }
 
-  static readonly #preferences = new TaggingProfilesPreferences();
+  static #preferences = new TaggingProfilesPreferences();
 
   /**
    * Watch for changes to active profile.
@@ -260,8 +262,8 @@ export class TagDropdown extends BaseComponent {
     return dropdownLink;
   }
 
-  static readonly #categoriesResolver = new CustomCategoriesResolver();
-  static readonly #processedElements: WeakSet<HTMLElement> = new WeakSet();
+  static #categoriesResolver = new CustomCategoriesResolver();
+  static #processedElements: WeakSet<HTMLElement> = new WeakSet();
 
   static #findAll(parentNode: ParentNode = document): NodeListOf<HTMLElement> {
     return parentNode.querySelectorAll('.tag.dropdown');

src/content/components/philomena/TagsForm.ts

@@ -7,8 +7,8 @@ import EditorPresetsBlock from "$content/components/extension/presets/EditorPres
 import { EVENT_PRESET_TAG_CHANGE_APPLIED, type PresetTagChange } from "$content/components/events/preset-block-events";
 
 export class TagsForm extends BaseComponent {
-  readonly #togglePresetsButton: HTMLButtonElement = document.createElement('button');
-  readonly #presetsList = EditorPresetsBlock.create();
+  #togglePresetsButton: HTMLButtonElement = document.createElement('button');
+  #presetsList = EditorPresetsBlock.create();
   #plainEditorTextarea: HTMLTextAreaElement | null = null;
   #fancyEditorInput: HTMLInputElement | null = null;
   #tagsSet: Set<string> = new Set();
@@ -127,6 +127,7 @@ export class TagsForm extends BaseComponent {
       const categoryName = tagCategories.get(tagName)!;
 
       tagElement.dataset.tagCategory = categoryName;
+      tagElement.setAttribute('data-tag-category', categoryName);
     }
   }
 

src/content/components/philomena/dupe/DupeDiff.ts

@@ -104,7 +104,7 @@ export default class DupeDiff extends BaseComponent {
    *
    * Keys are the icons and values are the patterns extension should check for each URL.
    */
-  static readonly #iconsToPatternsMap = new Map<string[] | string, string[] | string>([
+  static #iconsToPatternsMap = new Map<string[] | string, string[] | string>([
     [
       ['artstation', brandsSubtype],
       'artstation.com'

src/content/components/philomena/dupe/DupeReportRow.ts

@@ -4,9 +4,9 @@ import DupeImage from "$content/components/philomena/dupe/DupeImage";
 import { ratingTags } from "$config/tags";
 
 export default class DupeReportRow extends BaseComponent {
-  readonly #leftImage: DupeImage;
-  readonly #rightImage: DupeImage;
-  readonly #difference: DupeDiff;
+  #leftImage: DupeImage;
+  #rightImage: DupeImage;
+  #difference: DupeDiff;
 
   constructor(leftCell: HTMLElement, rightCell: HTMLElement, diffCell: HTMLElement, reportOptions: HTMLElement) {
     super(reportOptions);

src/content/components/philomena/listing/ImageListInfo.ts

@@ -2,8 +2,8 @@ import { BaseComponent } from "$content/components/base/BaseComponent";
 
 export class ImageListInfo extends BaseComponent {
   #tagElement: HTMLElement | null = null;
-  readonly #impliedTags: string[] = [];
-  readonly #showUntaggedImplicationsButton: HTMLAnchorElement = document.createElement('a');
+  #impliedTags: string[] = [];
+  #showUntaggedImplicationsButton: HTMLAnchorElement = document.createElement('a');
 
   protected build() {
     const sectionAfterImage = this.container.querySelector('.tag-info__image + .flex__grow');
@@ -71,5 +71,5 @@ export class ImageListInfo extends BaseComponent {
     location.assign(url.href);
   }
 
-  static readonly #implicationsStarterText = 'Implies:';
+  static #implicationsStarterText = 'Implies:';
 }

src/content/deps/amd.ts

@@ -38,7 +38,7 @@ amdLite.define = (name, dependencies, originalCallback) => {
 
     // Workaround for the entry script not returning anything causing AMD-Lite to send warning about modules not
     // being loaded/not existing.
-    return callbackResult !== undefined ? callbackResult : {};
+    return typeof callbackResult !== 'undefined' ? callbackResult : {};
   });
 
   // Schedule the auto run on the next available frame. Firefox and Chromium have a lot of differences in how they

src/lib/extension/BulkEntitiesTransporter.ts

@@ -101,7 +101,7 @@ export default class BulkEntitiesTransporter {
       && Array.isArray(targetObject.elements);
   }
 
-  static readonly #transporters: TransportersMapping = {
+  static #transporters: TransportersMapping = {
     profiles: new EntitiesTransporter(TaggingProfile),
     groups: new EntitiesTransporter(TagGroup),
     presets: new EntitiesTransporter(TagEditorPreset),

src/lib/extension/CustomCategoriesResolver.ts

@@ -5,9 +5,9 @@ import { emit } from "$content/components/events/comms";
 import { EVENT_TAG_GROUP_RESOLVED } from "$content/components/events/tag-dropdown-events";
 
 export default class CustomCategoriesResolver {
-  readonly #exactGroupMatches = new Map<string, TagGroup>();
-  readonly #regExpGroupMatches = new Map<RegExp, TagGroup>();
-  readonly #tagDropdowns: TagDropdown[] = [];
+  #exactGroupMatches = new Map<string, TagGroup>();
+  #regExpGroupMatches = new Map<RegExp, TagGroup>();
+  #tagDropdowns: TagDropdown[] = [];
   #nextQueuedUpdate: Timeout | null = null;
 
   constructor() {
@@ -125,5 +125,5 @@ export default class CustomCategoriesResolver {
     );
   }
 
-  static readonly #unprocessedTagsTimeout = 0;
+  static #unprocessedTagsTimeout = 0;
 }

src/lib/extension/EntitiesTransporter.ts

@@ -2,6 +2,7 @@ import { validateImportedEntity } from "$lib/extension/transporting/validators";
 import { exportEntityToObject } from "$lib/extension/transporting/exporters";
 import StorageEntity from "$lib/extension/base/StorageEntity";
 import { compressToEncodedURIComponent, decompressFromEncodedURIComponent } from "lz-string";
+import type { ImportableElement } from "$lib/extension/transporting/importables";
 
 /**
  * Status of the last import.

src/lib/philomena/scraping/parsing/PostParser.ts

@@ -78,5 +78,5 @@ export default class PostParser extends PageParser {
     );
   }
 
-  static readonly tagsInputName = 'image[tag_input]';
+  static tagsInputName = 'image[tag_input]';
 }