addonova 1.0.0 → 1.0.2

package/README.md

@@ -1,2 +1,95 @@
 # addonova
+
 Next-Generation Web Extension Framework
+
+Scaffold and build cross-browser WebExtensions with a modern toolchain.
+
+## Usage
+
+```bash
+npx addonova init my-extension
+cd my-extension
+npm run release
+```
+
+## Supported Browsers
+
+- Chrome (MV3)
+- Firefox
+- Microsoft Edge
+- Opera
+- Naver Whale
+- Thunderbird
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `init <name>` | Scaffold a new extension project |
+| `update` | Update workspace/build files to latest template |
+| `build [options]` | Build the extension |
+| `zip` | Create zip bundles |
+| `--help` | Show help |
+
+## Build Targets
+
+```bash
+npm run release                         # Release build (all)
+npm run release:chrome                  # Release (Chrome)
+npm run release:firefox                 # Release (Firefox)
+npm run debug                           # Debug build (all)
+npm run debug:chrome                    # Debug (Chrome)
+npm run watch                           # Watch mode
+npm run zip                             # Create zip bundles
+npx addonova build --all --release      # Build via CLI
+npx addonova --help                     # Show help
+```
+
+## Project Structure
+
+```
+my-extension/
+├── config/                  # Build config per browser
+│   ├── chrome.js
+│   ├── firefox.js
+│   └── ...
+├── platform/                # Platform-specific polyfills
+│   ├── chrome/platform.js
+│   ├── firefox/platform.js
+│   └── ...
+├── src/
+│   ├── _locales/            # i18n locale files (.i18n)
+│   ├── assets/              # Static assets (icons, etc.)
+│   ├── css/                 # Stylesheets
+│   ├── html/                # HTML pages
+│   ├── js/                  # JavaScript source
+│   │   ├── background.js
+│   │   ├── popup.js
+│   │   └── lib/             # Shared runtime libs
+│   └── manifest/            # Manifest JSON templates
+├── .output/                 # Build output
+│   ├── release/             # Release builds
+│   └── debug/               # Debug builds
+└── package.json
+```
+
+## Locales / i18n
+
+Locale files use the `.i18n` format:
+
+```
+@extensionName
+My Extension
+@extensionDescription
+This is my extension description.
+```
+
+Run the interactive message manager:
+
+```bash
+node node_modules/addonova/workspace/tools/translate.js
+```
+
+## Requirements
+
+- Node.js >= 18

package/bin/index.js

@@ -1,6 +1,13 @@
 #!/usr/bin/env node
+import { fork } from 'node:child_process';
 import process from 'node:process';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { existsSync } from 'node:fs';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
 import { init } from '../src/commands/init.js';
+import { update } from '../src/commands/update.js';
 
 const [command, ...args] = process.argv.slice(2);
 
@@ -8,15 +15,47 @@ switch (command) {
   case 'init':
     await init(args);
     break;
+  case 'update':
+    await update();
+    break;
+  case 'build':
+  case 'zip': {
+    const cliPath = resolve(__dirname, '../workspace/tasks/cli.js');
+    if (!existsSync(cliPath)) {
+      console.error('[*] Addonova workspace not found. Reinstall the package.');
+      process.exit(1);
+    }
+    const child = fork(cliPath, [command, ...args], {
+      execArgv: ['--max-old-space-size=3072']
+    });
+    process.on('SIGINT', () => {
+      child.kill('SIGKILL');
+      process.exit(130);
+    });
+    await new Promise((resolve, reject) =>
+      child.on('error', reject).on('close', (code) => {
+        if (code !== 0) process.exit(code);
+        resolve();
+      })
+    );
+    break;
+  }
   case '--help':
   case '-h':
   default:
     console.log(`
-  addonova — Cross-browser WebExtension toolkit
+  Addonova — browser extension toolkit
 
   Usage:
-    npx addonova init <project-name>   Scaffold a new extension project
-    npx addonova --help                 Show this help
+    npx addonova init <my-extension>   Scaffold a new extension project
+    npx addonova update                Update workspace/build files in existing project
+    npx addonova build [options]       Build the extension
+    npx addonova zip                   Create zip bundles
+    npx addonova --help                Show this help
+
+  Build options:
+    --all, --chrome, --firefox, --edge, --opera, --naver, --thunderbird
+    --release, --debug, --watch, --test, --version=x.x.x
     `);
     break;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "addonova",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Web Extension Framework",
   "type": "module",
   "bin": {
@@ -13,10 +13,32 @@
   "files": [
     "bin/",
     "src/",
+    "workspace/",
     "template/"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "addonova-release": "node --max-old-space-size=3072 workspace/tasks/cli.js build --all --release",
+    "addonova-release:chrome": "node --max-old-space-size=3072 workspace/tasks/cli.js build --chrome --release",
+    "addonova-release:edge": "node --max-old-space-size=3072 workspace/tasks/cli.js build --edge --release",
+    "addonova-release:opera": "node --max-old-space-size=3072 workspace/tasks/cli.js build --opera --release",
+    "addonova-release:firefox": "node --max-old-space-size=3072 workspace/tasks/cli.js build --firefox --release",
+    "addonova-release:thunderbird": "node --max-old-space-size=3072 workspace/tasks/cli.js build --thunderbird --release",
+    "addonova-release:naver": "node --max-old-space-size=3072 workspace/tasks/cli.js build --naver --release",
+    "addonova-debug": "node --max-old-space-size=3072 workspace/tasks/cli.js build --all --debug",
+    "addonova-debug:chrome": "node --max-old-space-size=3072 workspace/tasks/cli.js build --chrome --debug",
+    "addonova-debug:edge": "node --max-old-space-size=3072 workspace/tasks/cli.js build --edge --debug",
+    "addonova-debug:opera": "node --max-old-space-size=3072 workspace/tasks/cli.js build --opera --debug",
+    "addonova-debug:firefox": "node --max-old-space-size=3072 workspace/tasks/cli.js build --firefox --debug",
+    "addonova-debug:thunderbird": "node --max-old-space-size=3072 workspace/tasks/cli.js build --thunderbird --debug",
+    "addonova-debug:naver": "node --max-old-space-size=3072 workspace/tasks/cli.js build --naver --debug",
+    "addonova-watch": "node --max-old-space-size=3072 workspace/tasks/cli.js build --all --debug --watch"
+  },
+  "dependencies": {
+    "@craftamap/esbuild-plugin-html": "^0.9.0",
+    "chokidar": "^5.0.0",
+    "esbuild": "^0.27.3",
+    "globby": "^16.1.0",
+    "yazl": "^3.3.1"
   },
   "keywords": [
     "webextension",

package/src/commands/init.js

@@ -9,21 +9,31 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const TEMPLATE_DIR = path.resolve(__dirname, '../../template');
 
 const VARIABLE_RE = /\{\{\s*(\w+)\s*\}\}/g;
+const SKIP_DIRS = new Set(['workspace']);
 
 function render(template, vars) {
   return template.replace(VARIABLE_RE, (_, key) => vars[key] ?? `{{${key}}}`);
 }
 
-async function copyDir(src, dest, vars) {
+async function copyDir(src, dest, vars, selected = []) {
   await fs.mkdir(dest, { recursive: true });
   const entries = await fs.readdir(src, { withFileTypes: true });
+  const dirName = path.basename(src);
 
   for (const entry of entries) {
+    const entryName = path.basename(entry.name, path.extname(entry.name));
+
+    if (entry.isDirectory() && SKIP_DIRS.has(entry.name)) continue;
+
+    if ((dirName === 'config' || dirName === 'platform') && selected.length > 0 && !selected.includes(entryName)) {
+      continue;
+    }
+
     const srcPath = path.join(src, entry.name);
     const destPath = path.join(dest, entry.name.replace(/\.tpl$/, ''));
 
     if (entry.isDirectory()) {
-      await copyDir(srcPath, destPath, vars);
+      await copyDir(srcPath, destPath, vars, selected);
     } else if (entry.name.endsWith('.tpl')) {
       const content = await fs.readFile(srcPath, 'utf-8');
       await fs.writeFile(destPath, render(content, vars), 'utf-8');
@@ -34,20 +44,11 @@ async function copyDir(src, dest, vars) {
 }
 
 async function installDependencies(projectDir) {
-  console.log('\n⚡ Installing dependencies...');
+  console.log('\n[+] Installing dependencies...');
   const { execSync } = await import('node:child_process');
   execSync('npm install', { cwd: projectDir, stdio: 'inherit' });
 }
 
-async function detectPackageManager() {
-  const hasLock = f => existsSync(path.join(process.cwd(), f));
-
-  if (hasLock('pnpm-lock.yaml')) return 'pnpm';
-  if (hasLock('yarn.lock')) return 'yarn';
-  if (hasLock('package-lock.json') || hasLock('bun.lock')) return 'npm';
-  return 'npm';
-}
-
 export async function init(args) {
   let projectName = args[0];
 
@@ -56,14 +57,14 @@ export async function init(args) {
   }
 
   if (!projectName) {
-    console.error('❌ Project name is required.');
+    console.error('[*] Project name is required.');
     process.exit(1);
   }
 
   const projectDir = path.resolve(process.cwd(), projectName);
 
   if (existsSync(projectDir)) {
-    console.error(`❌ Directory "${projectName}" already exists.`);
+    console.error(`[*] Directory "${projectName}" already exists.`);
     process.exit(1);
   }
 
@@ -72,37 +73,36 @@ export async function init(args) {
 
   const vars = {
     name: projectName,
-    description: 'A cross-browser WebExtension',
+    description: 'A Browser Extension',
     version: '1.0.0',
     browsers: JSON.stringify(selected),
     browsersList: selected.join(', '),
     year: new Date().getFullYear().toString(),
   };
 
-  console.log(`\n📁 Scaffolding "${projectName}" for: ${selected.join(', ')}`);
-  await copyDir(TEMPLATE_DIR, projectDir, vars);
+  console.log(`\n[+] Scaffolding "${projectName}" for: ${selected.join(', ')}`);
+  await copyDir(TEMPLATE_DIR, projectDir, vars, selected);
 
-  console.log('✔ Template files created.');
+  console.log('[+] Template files created.');
 
-  const pm = detectPackageManager();
   const shouldInstall = await askQuestion('\nRun npm install now? (Y/n): ');
   if (shouldInstall.toLowerCase() !== 'n') {
     await installDependencies(projectDir);
   }
 
   console.log(`
-┌──────────────────────────────────────────────┐
-│  ✅  "${projectName}" is ready!                │
-│                                              │
+┌──────────────────────────────────────────────
+│  [+] "${projectName}" is ready!             
+│                                              
 │  ${projectDir}               │
-│                                              │
-│  Next steps:                                 │
-│    cd ${projectName}                          │
-│    npm run build -- --all                     │
-│    npm run build -- --chrome --debug          │
-│    npm run build -- --firefox --watch         │
-│                                              │
-│  Targets: ${selected.join(', ').padEnd(30)}│
-└──────────────────────────────────────────────┘
+│                                              
+│  Next steps:                                 
+│    cd ${projectName}                          
+│    npm run release                           
+│    npm run debug:chrome                      
+│    npm run watch                             
+│                                              
+│  Targets: ${selected.join(', ').padEnd(30)}
+└──────────────────────────────────────────────
 `);
 }

package/src/commands/update.js

@@ -0,0 +1,67 @@
+import { existsSync } from 'node:fs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import process from 'node:process';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const TEMPLATE_DIR = path.resolve(__dirname, '../../template');
+const VARIABLE_RE = /\{\{\s*(\w+)\s*\}\}/g;
+const SKIP_DIRS = new Set(['config', 'src', 'platform', 'workspace']);
+
+function render(template, vars) {
+  return template.replace(VARIABLE_RE, (_, key) => vars[key] ?? `{{${key}}}`);
+}
+
+async function copyDir(src, dest, vars) {
+  await fs.mkdir(dest, { recursive: true });
+  const entries = await fs.readdir(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    if (entry.isDirectory() && SKIP_DIRS.has(entry.name)) continue;
+
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name.replace(/\.tpl$/, ''));
+
+    if (entry.isDirectory()) {
+      await copyDir(srcPath, destPath, vars);
+    } else if (entry.name.endsWith('.tpl')) {
+      const content = await fs.readFile(srcPath, 'utf-8');
+      await fs.writeFile(destPath, render(content, vars), 'utf-8');
+    } else {
+      await fs.copyFile(srcPath, destPath);
+    }
+  }
+}
+
+export async function update() {
+  const cwd = process.cwd();
+  const pkgPath = path.join(cwd, 'package.json');
+
+  if (!existsSync(pkgPath)) {
+    console.error('[*] No package.json found. Run this command inside an addonova project.');
+    process.exit(1);
+  }
+
+  let pkg;
+  try {
+    pkg = JSON.parse(await fs.readFile(pkgPath, 'utf-8'));
+  } catch {
+    console.error('[*] Invalid package.json.');
+    process.exit(1);
+  }
+
+  const vars = {
+    name: pkg.name || 'extension',
+    description: pkg.description || 'A cross-browser WebExtension',
+    version: pkg.version || '1.0.0',
+    browsers: JSON.stringify([]),
+    browsersList: '',
+    year: new Date().getFullYear().toString(),
+  };
+
+  console.log(`[+] Updating "${pkg.name}" (keeping config/, src/, platform/)`);
+  await copyDir(TEMPLATE_DIR, cwd, vars);
+
+  console.log('[+] Update complete.');
+}

package/src/index.js

@@ -1 +1,2 @@
 export { init } from './commands/init.js';
+export { update } from './commands/update.js';

package/template/config/chrome.js

@@ -1,15 +1,23 @@
 export default {
   js: {
     entry: {
-      '': ['src/js/background.js', 'src/js/popup.js'],
+      '': ['src/js/background.js'],
+      'lib': [
+          'platform/chrome/platform.js', 
+          'src/js/lib/browser.js', 
+          'src/js/lib/runtime.js', 
+          'src/js/lib/config.js', 
+          'src/js/lib/common.js'
+      ],
+      'data/interface': ['src/js/popup.js'],
     },
     filename: '[name]',
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      'data/interface': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,
@@ -17,13 +25,13 @@ export default {
   },
   html: {
     entry: {
-      '': ['src/html/popup.html'],
+      'data/interface': ['src/html/popup.html'],
     },
     filename: '[name]',
   },
   assets: {
     entry: {
-      '': ['src/assets/**/*'],
+      'data/icons': ['src/assets/icons'],
     },
   },
 };

package/template/config/edge.js

@@ -1,15 +1,23 @@
 export default {
   js: {
     entry: {
-      '': ['src/js/background.js', 'src/js/popup.js'],
+      '': ['src/js/background.js'],
+      'lib': [
+          'platform/edge/platform.js', 
+          'src/js/lib/browser.js', 
+          'src/js/lib/runtime.js', 
+          'src/js/lib/config.js', 
+          'src/js/lib/common.js'
+      ],
+      'data/interface': ['src/js/popup.js'],
     },
     filename: '[name]',
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      'data/interface': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,
@@ -17,13 +25,13 @@ export default {
   },
   html: {
     entry: {
-      '': ['src/html/popup.html'],
+      'data/interface': ['src/html/popup.html'],
     },
     filename: '[name]',
   },
   assets: {
     entry: {
-      '': ['src/assets/**/*'],
+      'data/icons': ['src/assets/icons'],
     },
   },
-};
+};

package/template/config/firefox.js

@@ -7,9 +7,9 @@ export default {
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      '': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,

package/template/config/naver.js

@@ -1,15 +1,23 @@
 export default {
   js: {
     entry: {
-      '': ['src/js/background.js', 'src/js/popup.js'],
+      '': ['src/js/background.js'],
+      'lib': [
+          'platform/naver/platform.js', 
+          'src/js/lib/browser.js', 
+          'src/js/lib/runtime.js', 
+          'src/js/lib/config.js', 
+          'src/js/lib/common.js'
+      ],
+      'data/interface': ['src/js/popup.js'],
     },
     filename: '[name]',
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      'data/interface': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,
@@ -17,13 +25,13 @@ export default {
   },
   html: {
     entry: {
-      '': ['src/html/popup.html'],
+      'data/interface': ['src/html/popup.html'],
     },
     filename: '[name]',
   },
   assets: {
     entry: {
-      '': ['src/assets/**/*'],
+      'data/icons': ['src/assets/icons'],
     },
   },
-};
+};

package/template/config/opera.js

@@ -1,15 +1,23 @@
 export default {
   js: {
     entry: {
-      '': ['src/js/background.js', 'src/js/popup.js'],
+      '': ['src/js/background.js'],
+      'lib': [
+          'platform/opera/platform.js', 
+          'src/js/lib/browser.js', 
+          'src/js/lib/runtime.js', 
+          'src/js/lib/config.js', 
+          'src/js/lib/common.js'
+      ],
+      'data/interface': ['src/js/popup.js'],
     },
     filename: '[name]',
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      'data/interface': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,
@@ -17,13 +25,13 @@ export default {
   },
   html: {
     entry: {
-      '': ['src/html/popup.html'],
+      'data/interface': ['src/html/popup.html'],
     },
     filename: '[name]',
   },
   assets: {
     entry: {
-      '': ['src/assets/**/*'],
+      'data/icons': ['src/assets/icons'],
     },
   },
-};
+};

package/template/config/thunderbird.js

@@ -7,9 +7,9 @@ export default {
     minify: true,
     sourcemap: false,
   },
-  scss: {
+  css: {
     entry: {
-      '': ['src/scss/popup.scss'],
+      '': ['src/css/popup.css'],
     },
     filename: '[name]',
     minify: true,