@uxland/harmonix-cli 0.0.3 → 0.0.5

package/README.md

@@ -0,0 +1,113 @@
+# 📦 Documentació de `harmonix-cli`
+
+`harmonix-cli` és una eina de línia de comandes per publicar plugins al plugin store de Harmonix.
+
+## 🔧 Instal·lació
+
+Assegura’t de tenir `node` i `npm` instal·lats. Afegeix `harmonix-cli` com a dependència del teu projecte o de forma global:
+
+```bash
+npm install -g @uxland/harmonix-cli
+```
+
+---
+
+## 🚀 Publicació d’un plugin
+
+### Comanda principal
+
+```bash
+harmonix publish
+```
+
+Aquesa comanda llegeix la informació del `package.json` i puja el fitxer compilat especificat al registry (plugin store) configurat.
+
+---
+
+## 📁 Estructura requerida
+
+### `package.json`
+
+El fitxer `package.json` del teu plugin ha de contenir obligatòriament els següents camps:
+
+```json
+{
+  "name": "plugin-id",
+  "version": "1.0.0",
+  "module": "dist/plugin.js"
+}
+```
+
+- `name`: identificador únic del plugin (id del plugin).
+- `version`: versió que es publicarà.
+- `module`: ruta al fitxer compilat que es pujarà.
+
+---
+
+## ⚙️ Configuració amb `.harmonixrc`
+
+Crea un fitxer `.harmonixrc` a la carpeta arrel del projecte (en cas de monorepo també serveix) amb el següent contingut:
+
+```
+registry=https://plugins.harmonix.dev/upload
+apiKey=la_teva_clau_api
+```
+
+- `registry`: URL del plugin store.
+- `apiKey`: clau API per a l’autenticació.
+
+> 🛑   **Important**: El fitxer `.harmonixrc` conté credencials sensibles. No l’incloguis al repositori de codi. Afegeix-lo al `.gitignore`:
+>
+> ```
+> .harmonixrc
+> ```
+
+---
+
+## 🧰 Paràmetres opcionals (substitueixen `.harmonixrc`)
+
+També pots passar les opcions directament per línia de comandes:
+
+```bash
+harmonix publish --registry https://plugins.harmonix.dev/upload --api-key la_teva_clau_api
+```
+
+- `--registry`: URL del servidor.
+- `--api-key`: clau API d’autenticació.
+
+---
+
+## 🫠 Errors comuns i solucions
+
+| Error                                      | Possible causa                                                             | Solució                                                  |
+| ------------------------------------------ | -------------------------------------------------------------------------- | -------------------------------------------------------- |
+| `package.json not found`                   | No s’ha trobat el fitxer `package.json` a la carpeta actual                | Executa `harmonix publish` des de la carpeta del plugin  |
+| `'module' field not found in package.json` | Falta el camp `module` al `package.json`                                   | Afegeix "module": "ruta/al/fitxer.js"                    |
+| `Compiled bundle file not found`           | El fitxer indicat al `module` no existeix                                  | Compila el plugin abans de publicar o verifica la ruta   |
+| `No registry configured`                   | No s’ha especificat `registry` ni a `.harmonixrc` ni per línia de comandes | Afegeix `registry=` a `.harmonixrc` o passa `--registry` |
+| `No api key configured`                    | Falta la clau API (`apiKey`)                                               | Afegeix-la a `.harmonixrc` o passa `--api-key`           |
+
+---
+
+## 📖 Ajuda
+
+Per veure els comandaments disponibles:
+
+```bash
+npx harmonix --help
+```
+
+---
+
+## ✅ Exemple complet
+
+```bash
+npx harmonix publish --registry https://plugins.harmonix.dev/upload --api-key ABC123XYZ
+```
+
+O bé, si tens `.harmonixrc` configurat:
+
+```bash
+npx harmonix publish
+```
+

package/index.js

@@ -3,35 +3,58 @@
 const { program } = require('commander');
 const path = require('path');
 const fs = require('fs');
+const os = require('os');
 const axios = require('axios');
 const FormData = require('form-data');
 
 console.log("reached index");
 
 function getConfig() {
-  const configPath = path.resolve(process.cwd(), ".harmonixrc");
   const config = {};
-  
-  if (fs.existsSync(configPath)) {
-    try {
-      const content = fs.readFileSync(configPath, 'utf8');
-      content.split('\n').forEach(line => {
-        if (line.trim()) {
-          const [key, value] = line.split('=');
-          if (key && value) {
-            config[key.trim()] = value.trim();
-          }
-        }
-      });
-      console.log(config)
-    } catch (err) {
-      console.warn("⚠️ Warning: Error reading .harmonixrc:", err.message);
+  let dir = process.cwd();
+  let steps = 0;
+  const maxSteps = 10;
+
+  while (steps < maxSteps) {
+    const configPath = path.join(dir, '.harmonixrc');
+    if (fs.existsSync(configPath)) {
+      Object.assign(config, parseConfigFile(configPath));
+      break; // stop at first .harmonixrc found
     }
+
+    const parent = path.dirname(dir);
+    if (parent === dir) break; // reached filesystem root
+    dir = parent;
+    steps++;
+  }
+
+  // Also merge user-level config (~/.harmonixrc)
+  const homeConfigPath = path.join(os.homedir(), '.harmonixrc');
+  if (fs.existsSync(homeConfigPath)) {
+    Object.assign(config, parseConfigFile(homeConfigPath));
   }
-  
+
   return config;
 }
 
+function parseConfigFile(filePath) {
+  const result = {};
+  try {
+    const content = fs.readFileSync(filePath, 'utf8');
+    content.split('\n').forEach(line => {
+      if (line.trim() && !line.startsWith('#')) {
+        const [key, value] = line.split('=');
+        if (key && value) {
+          result[key.trim()] = value.trim();
+        }
+      }
+    });
+  } catch (err) {
+    console.warn(`⚠️ Error reading ${filePath}:`, err.message);
+  }
+  return result;
+}
+
 program
   .command('publish')
   .option('--registry <registry>', 'Backend URL (overrides .harmonixrc)')
@@ -42,7 +65,7 @@ program
       const packageJsonPath = path.resolve(process.cwd(), "package.json");
 
       if (!fs.existsSync(packageJsonPath)) {
-        console.error(`package.json not found in: ${process.cwd()}`);
+        console.error(`❌ package.json not found in: ${process.cwd()}`);
         process.exit(1);
       }
 
@@ -56,30 +79,29 @@ program
 
       const filePath = path.resolve(process.cwd(), module);
       if (!fs.existsSync(filePath)) {
-        console.error(`Compiled bundle file not found: ${filePath}`);
+        console.error(`❌ Compiled bundle file not found: ${filePath}`);
         process.exit(1);
       }
 
       const formData = new FormData();
       formData.append("versionNumber", versionNumber);
       formData.append("pluginId", pluginId);
-      formData.append('file', fs.createReadStream(filePath));
+      formData.append("file", fs.createReadStream(filePath));
 
       const registry = opts.registry || config.registry;
       const apiKey = opts.apiKey || config.apiKey;
 
-      if(!registry){
-        throw new Error("No registry configured")
+      if (!registry) {
+        throw new Error("No registry configured");
       }
-      if(!apiKey){
-        throw new Error("No api key configured")
+      if (!apiKey) {
+        throw new Error("No API key configured");
       }
-      
-      const headers =  {
+
+      const headers = {
         'x-api-key': apiKey
       };
       const response = await axios.post(registry, formData, { headers });
-
       console.log('✅ Plugin published:', response.data);
     } catch (err) {
       console.error('❌ Failed to publish:', err.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxland/harmonix-cli",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "bin": {
     "harmonix": "index.js"
   },