@uxland/harmonix-cli 0.0.5 → 0.0.7

package/README.md

@@ -1,113 +1,31 @@
-# 📦 Documentació de `harmonix-cli`
+# @uxland/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:
+The [Harmonix](https://harmonixframework.dev) command-line tool. Its command, `harmonix publish`, uploads a built plugin to a Plugin Store. It does not build the plugin or change its version: run your build first and set `version` in `package.json` yourself.
 
 ```bash
-harmonix publish --registry https://plugins.harmonix.dev/upload --api-key la_teva_clau_api
+npm install --save-dev @uxland/harmonix-cli
+npm run build
+npx harmonix publish
 ```
 
-- `--registry`: URL del servidor.
-- `--api-key`: clau API d’autenticació.
-
----
+Run it from the plugin folder. From its `package.json` it reads `name` (the plugin id), `version` and `module` (the built file to upload).
 
-## 🫠 Errors comuns i solucions
+## Configuration
 
-| 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`           |
+The registry URL and the API key go in a `.harmonixrc` file, in the plugin folder or any folder above it (one at the root of a monorepo works for all its plugins), or in your home folder:
 
----
-
-## 📖 Ajuda
-
-Per veure els comandaments disponibles:
-
-```bash
-npx harmonix --help
+```ini
+registry=https://your-plugin-store.example.com/upload
+apiKey=your-api-key
 ```
 
----
-
-## ✅ Exemple complet
+The `--registry` and `--api-key` options override the file. A project `.harmonixrc` (the nearest one above the plugin folder) overrides the one in your home folder.
 
-```bash
-npx harmonix publish --registry https://plugins.harmonix.dev/upload --api-key ABC123XYZ
-```
+`harmonix publish` exits with code `1` when the upload fails (for example, the plugin does not exist in the store or the version is already published), so scripts can stop on errors.
 
-O bé, si tens `.harmonixrc` configurat:
+> `.harmonixrc` contains credentials: never commit it. Projects made with `npm create @uxland/harmonix-plugin@latest` already ignore it.
 
-```bash
-npx harmonix publish
-```
+## Documentation
 
+- [This package](https://harmonixframework.dev/docs/packages/cli/): configuration order, the request it sends, errors and exit codes.
+- [Build and publish a plugin](https://harmonixframework.dev/docs/create-plugin/build-and-publish/).

package/index.js

@@ -1,22 +1,27 @@
 #!/usr/bin/env node
 
-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");
+const { program } = require("commander");
+const path = require("node:path");
+const fs = require("node:fs");
+const os = require("node:os");
+const axios = require("axios");
+const FormData = require("form-data");
 
 function getConfig() {
   const config = {};
+
+  // User-level config (~/.harmonixrc) first, so the project's .harmonixrc overrides it
+  const homeConfigPath = path.join(os.homedir(), ".harmonixrc");
+  if (fs.existsSync(homeConfigPath)) {
+    Object.assign(config, parseConfigFile(homeConfigPath));
+  }
+
   let dir = process.cwd();
   let steps = 0;
   const maxSteps = 10;
 
   while (steps < maxSteps) {
-    const configPath = path.join(dir, '.harmonixrc');
+    const configPath = path.join(dir, ".harmonixrc");
     if (fs.existsSync(configPath)) {
       Object.assign(config, parseConfigFile(configPath));
       break; // stop at first .harmonixrc found
@@ -28,27 +33,24 @@ function getConfig() {
     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('=');
+    const content = fs.readFileSync(filePath, "utf8");
+    for (const line of content.split("\n")) {
+      if (line.trim() && !line.startsWith("#")) {
+        // Split on the first '=' only: a value may contain '=' (e.g. base64 padding)
+        const separator = line.indexOf("=");
+        const key = separator === -1 ? "" : line.slice(0, separator).trim();
+        const value = separator === -1 ? "" : line.slice(separator + 1).trim();
         if (key && value) {
-          result[key.trim()] = value.trim();
+          result[key] = value;
         }
       }
-    });
+    }
   } catch (err) {
     console.warn(`⚠️ Error reading ${filePath}:`, err.message);
   }
@@ -56,9 +58,9 @@ function parseConfigFile(filePath) {
 }
 
 program
-  .command('publish')
-  .option('--registry <registry>', 'Backend URL (overrides .harmonixrc)')
-  .option('--api-key <apiKey>', 'API Key (overrides .harmonixrc)')
+  .command("publish")
+  .option("--registry <registry>", "Backend URL (overrides .harmonixrc)")
+  .option("--api-key <apiKey>", "API Key (overrides .harmonixrc)")
   .action(async (opts) => {
     try {
       const config = getConfig();
@@ -99,12 +101,19 @@ program
       }
 
       const headers = {
-        'x-api-key': apiKey
+        "x-api-key": apiKey,
       };
       const response = await axios.post(registry, formData, { headers });
-      console.log('✅ Plugin published:', response.data);
+      if (response.data?.success === false) {
+        throw new Error(response.data.error || response.data.message || "Plugin Store rejected the upload");
+      }
+      console.log(`✅ Plugin published: ${pluginId}@${versionNumber}`, response.data);
     } catch (err) {
-      console.error('❌ Failed to publish:', err.message);
+      // Exit non-zero so scripts and CI can tell a failed publish from a successful one
+      const serverError = err.response?.data?.error || err.response?.data?.message;
+      const status = err.response ? ` (HTTP ${err.response.status})` : "";
+      console.error(`❌ Failed to publish${status}:`, serverError || err.message);
+      process.exit(1);
     }
   });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxland/harmonix-cli",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "bin": {
     "harmonix": "index.js"
   },
@@ -8,7 +8,8 @@
     "index.js"
   ],
   "main": "index.js",
-  "description": "CLI tool for Harmonix",
+  "description": "The Harmonix command-line tool: publishes a built plugin to a Plugin Store.",
+  "homepage": "https://harmonixframework.dev/docs/packages/cli/",
   "author": "Cristian Payet <cpayet@uxland.cat>",
   "publishConfig": {
     "access": "public"
@@ -19,7 +20,7 @@
     "harmonix"
   ],
   "dependencies": {
-    "axios": "^1.0.0",
+    "axios": "^1.12.2",
     "commander": "^9.4.0",
     "form-data": "^4.0.0"
   }