feat: add prettier for code formatting and enhance build process with local externals plugin

Author: leandromqrs

esbuild.ts

@@ -1,61 +1,111 @@
+import type { Plugin } from 'esbuild';
 import { build } from 'esbuild';
-import { copyFileSync, readFileSync, existsSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
+import {
+  copyFileSync,
+  readFileSync,
+  readdirSync,
+  writeFileSync,
+  existsSync,
+} from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import AdmZip from 'adm-zip';
+import { format } from 'prettier';
 
 interface ExtensionMetadata {
   name: string;
   version: string;
   uuid: string;
 }
 
+// Externalize local .ts imports and rewrite paths to .js
+const localExternals: Plugin = {
+  name: 'local-externals',
+  setup(ctx) {
+    ctx.onResolve({ filter: /\.ts$/ }, (args) => {
+      if (args.kind === 'entry-point') return;
+      if (args.path.startsWith('.')) {
+        return {
+          path: args.path.replace(/\.ts$/, '.js'),
+          external: true,
+        };
+      }
+    });
+  },
+};
+
 const currentDir = dirname(fileURLToPath(import.meta.url));
 const metadataPath = resolve(currentDir, 'metadata.json');
 const metadata = JSON.parse(readFileSync(metadataPath, 'utf8')) as ExtensionMetadata;
 
+const srcDir = resolve(currentDir, 'src');
+const entryPoints = (readdirSync(srcDir, { recursive: true }) as string[])
+  .filter((file) => file.endsWith('.ts') && !file.endsWith('.d.ts'))
+  .map((file) => join('src', file));
+
 console.debug(`Building ${metadata.name} v${metadata.version}...`);
 
-build({
-  entryPoints: ['src/extension.ts', 'src/prefs.ts'],
+const sharedOptions = {
   outdir: 'dist',
+  outbase: 'src',
   bundle: true,
+  plugins: [localExternals],
   // Do not remove the functions `enable()`, `disable()` and `init()`
   treeShaking: false,
   // firefox60  // Since GJS 1.53.90
   // firefox68  // Since GJS 1.63.90
   // firefox78  // Since GJS 1.65.90
   // firefox91  // Since GJS 1.71.1
   // firefox102 // Since GJS 1.73.2
-  target: 'firefox102',
-  format: 'esm',
+  target: 'firefox102' as const,
+  format: 'esm' as const,
   alias: {
     // Not exported in @girs/gnome-shell v49; map directly to runtime resource
     '@girs/gnome-shell/ui/dash': 'resource:///org/gnome/shell/ui/dash.js',
   },
   external: ['gi://*', 'resource://*', 'system', 'gettext', 'cairo'],
-})
-  .then(() => {
-    const metaDist = resolve(currentDir, 'dist/metadata.json');
-    const extensionSrc = resolve(currentDir, 'dist/extension.js');
-    const prefsSrc = resolve(currentDir, 'dist/prefs.js');
+};
+
+Promise.all(
+  entryPoints.map((entryPoint) =>
+    build({ ...sharedOptions, entryPoints: [entryPoint] }),
+  ),
+)
+  .then(async () => {
+    const distDir = resolve(currentDir, 'dist');
+    const metaDist = resolve(distDir, 'metadata.json');
     const schemasSrc = resolve(currentDir, 'schemas');
     const styleFiles = [
-      'dist/stylesheet.css',
-      'dist/stylesheet-light.css',
-      'dist/stylesheet-dark.css',
-    ].map((file) => resolve(currentDir, file));
+      'stylesheet.css',
+      'stylesheet-light.css',
+      'stylesheet-dark.css',
+    ];
     const zipFilename = `${metadata.uuid}.zip`;
-    const zipDist = resolve(currentDir, 'dist', zipFilename);
+    const zipDist = resolve(distDir, zipFilename);
+
+    // Format output files with prettier
+    const jsFiles = (readdirSync(distDir, { recursive: true }) as string[])
+      .filter((file) => file.endsWith('.js'));
+
+    for (const file of jsFiles) {
+      const filePath = resolve(distDir, file);
+      const content = readFileSync(filePath, 'utf8');
+      const formatted = await format(content, { parser: 'babel', filepath: filePath });
+      writeFileSync(filePath, formatted);
+    }
 
     copyFileSync(metadataPath, metaDist);
 
     const zip: AdmZip = new AdmZip();
-    zip.addLocalFile(extensionSrc);
-    if (existsSync(prefsSrc)) {
-      zip.addLocalFile(prefsSrc);
+
+    for (const file of jsFiles) {
+      const filePath = resolve(distDir, file);
+      const dir = dirname(file);
+      zip.addLocalFile(filePath, dir === '.' ? '' : dir);
     }
-    styleFiles.forEach((stylePath) => {
+
+    styleFiles.forEach((styleFile) => {
+      const stylePath = resolve(distDir, styleFile);
       if (existsSync(stylePath)) {
         zip.addLocalFile(stylePath);
       }

package.json

@@ -26,6 +26,7 @@
     "esbuild": "^0.25.11",
     "eslint": "^9.39.1",
     "jiti": "^2.6.1",
+    "prettier": "^3.8.1",
     "sass": "^1.93.2",
     "tsx": "^4.20.6",
     "typescript": "^5.9.3",

yarn.lock

@@ -1650,6 +1650,7 @@ __metadata:
     esbuild: "npm:^0.25.11"
     eslint: "npm:^9.39.1"
     jiti: "npm:^2.6.1"
+    prettier: "npm:^3.8.1"
     sass: "npm:^1.93.2"
     tsx: "npm:^4.20.6"
     typescript: "npm:^5.9.3"
@@ -2832,6 +2833,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"prettier@npm:^3.8.1":
+  version: 3.8.1
+  resolution: "prettier@npm:3.8.1"
+  bin:
+    prettier: bin/prettier.cjs
+  checksum: 10c0/33169b594009e48f570471271be7eac7cdcf88a209eed39ac3b8d6d78984039bfa9132f82b7e6ba3b06711f3bfe0222a62a1bfb87c43f50c25a83df1b78a2c42
+  languageName: node
+  linkType: hard
+
 "proc-log@npm:^6.0.0":
   version: 6.1.0
   resolution: "proc-log@npm:6.1.0"