chore: restructure src/features/ directory (#1820)

Co-authored-by: marcustyphoon <[email protected]>

Author: AprilSylph

docs/Chapter 3 - Repository structure.md

@@ -3,7 +3,7 @@ const configSectionLink = document.querySelector('a[href="#configuration"]');
 const scriptsDiv = configSection.querySelector('.scripts');
 
 const getInstalledScripts = async function () {
-  const url = browser.runtime.getURL('/features/_index.json');
+  const url = browser.runtime.getURL('/features/index.json');
   const file = await fetch(url);
   const installedScripts = await file.json();
 
@@ -135,7 +135,7 @@ const renderScripts = async function () {
   const disabledScripts = installedScripts.filter(scriptName => enabledScripts.includes(scriptName) === false);
 
   for (const scriptName of [...orderedEnabledScripts, ...disabledScripts]) {
-    const url = browser.runtime.getURL(`/features/${scriptName}.json`);
+    const url = browser.runtime.getURL(`/features/${scriptName}/feature.json`);
     const file = await fetch(url);
     const {
       title = scriptName,

docs/Chapter 4.0 - Feature framework.md

@@ -15,15 +15,15 @@
       stylesheet,
       styleElement,
       onStorageChanged
-    } = await import(browser.runtime.getURL(`/features/${name}.js`));
+    } = await import(browser.runtime.getURL(`/features/${name}/index.js`));
 
     if (main) {
       main().catch(console.error);
     }
     if (stylesheet) {
       const link = Object.assign(document.createElement('link'), {
         rel: 'stylesheet',
-        href: browser.runtime.getURL(`/features/${name}.css?t=${timestamp}`)
+        href: browser.runtime.getURL(`/features/${name}/index.css?t=${timestamp}`)
       });
       link.className = 'xkit';
       document.documentElement.appendChild(link);
@@ -55,13 +55,13 @@
       clean,
       stylesheet,
       styleElement
-    } = await import(browser.runtime.getURL(`/features/${name}.js`));
+    } = await import(browser.runtime.getURL(`/features/${name}/index.js`));
 
     if (clean) {
       clean().catch(console.error);
     }
     if (stylesheet) {
-      document.querySelector(`link[href^="${browser.runtime.getURL(`/features/${name}.css`)}"]`)?.remove();
+      document.querySelector(`link[href^="${browser.runtime.getURL(`/features/${name}/index.css`)}"]`)?.remove();
     }
     if (styleElement) {
       styleElement.remove();
@@ -90,7 +90,7 @@
   };
 
   const getInstalledScripts = async function () {
-    const url = browser.runtime.getURL('/features/_index.json');
+    const url = browser.runtime.getURL('/features/index.json');
     const file = await fetch(url);
     const installedScripts = await file.json();
 

docs/Chapter 4.1 - Feature manifests.md renamed to docs/Chapter 4.1 - Feature metadata.md

@@ -1,9 +1,9 @@
-import { getPreferences } from '../utils/preferences.js';
+import { getPreferences } from '../../utils/preferences.js';
 
 let enabledOptions;
 
 const runOption = async function (name) {
-  const { main: run, styleElement } = await import(`./accesskit/${name}.js`);
+  const { main: run, styleElement } = await import(`./${name}.js`);
   if (run) {
     run().catch(console.error);
   }
@@ -14,7 +14,7 @@ const runOption = async function (name) {
 };
 
 const destroyOption = async function (name) {
-  const { clean: destroy, styleElement } = await import(`./accesskit/${name}.js`);
+  const { clean: destroy, styleElement } = await import(`./${name}.js`);
   if (destroy) {
     destroy().catch(console.error);
   }

src/action/render_scripts.js

@@ -1,7 +1,7 @@
-import { keyToCss } from '../utils/css_map.js';
-import { buildStyle, getTimelineItemWrapper } from '../utils/interface.js';
-import { pageModifications } from '../utils/mutations.js';
-import { getPreferences } from '../utils/preferences.js';
+import { keyToCss } from '../../utils/css_map.js';
+import { buildStyle, getTimelineItemWrapper } from '../../utils/interface.js';
+import { pageModifications } from '../../utils/mutations.js';
+import { getPreferences } from '../../utils/preferences.js';
 
 const hiddenAttribute = 'data-anti-capitalism-hidden';