@simplelocalize/cli 1.0.7 → 1.0.8

package/README.md

@@ -0,0 +1,41 @@
+# SimpleLocalize CLI via npm (work in progress)
+
+The main goal of this project is to give fronted developers
+an easier way to use [SimpleLocalize CLI](https://github.com/simplelocalize/simplelocalize-cli)
+in their workflows. 
+
+## Installation
+
+```
+npm install @simplelocalize/cli@1.0.8
+```
+
+After installing the package, it should automatically choose the right binary for 
+your system and install it into `node_modules/.bin` directory, to make it available for your
+scripts in `package.json`.
+
+> The work on this package is in progress, and at time of writing this documentation, the plugin installs the newest version of the CLI, which is 2.8.0
+
+## Usage
+
+Package SimpleLocalize CLI in your project and makes it available in `package.json` scripts.
+
+
+```
+{
+  "name": "My project",
+  "version": "1.0.0",
+  "private": true,
+  "dependencies": {
+    "@simplelocalize/cli": "^1.0.8",
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "sl:download": "simplelocalize downlaod",
+    "sl:upload": "simplelocalize upload",
+    "sl:autotranslate": "simplelocalize autotranslate"
+  },
+}
+```
+
+Learn more about [SimpleLocalize CLI commands](https://github.com/simplelocalize/simplelocalize-cli)

package/index.cjs

@@ -1,114 +1,114 @@
-#!/usr/bin/env node
-const { execSync } = require("child_process");
-const path = require("path");
-const fs = require('fs');
-const axios = require('axios');
-const os = require('os');
-
-let binaryPath = path.join(__dirname, 'bin', 'simplelocalize');
-if (os.platform() === 'win32') {
-    binaryPath += '.exe';
-}
-
-const isBinaryInstalled = () => {
-    try {
-        execSync(binaryPath + ' --version', { stdio: 'ignore' });
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-
-const printBinaryVersion = () => {
-    try {
-        console.log(execSync(binaryPath + ' --version').toString());
-    }
-    catch (error) {
-        console.error('Error running SimpleLocalize CLI');
-        process.exit(1);
-    }
-}
-
-const buildDownloadBinaryUrl = (version) => {
-    let platform = "";
-    if (os.platform() === "win32") {
-        platform = "windows.exe"
-    }
-
-    if (os.platform() === "darwin") {
-        platform = "mac"
-    }
-
-    if (os.platform() === "linux") {
-        platform = "linux"
-    }
-
-    let arch = "";
-    if (os.arch() === "arm64") {
-        arch = "-arm64"
-    }
-    console.log(`Downloading SimpleLocalize CLI ${version} for ${platform}${arch}...`);
-    return `https://github.com/simplelocalize/simplelocalize-cli/releases/download/${version}/simplelocalize-cli-${platform}${arch}`
-}
-
-async function installBinary() {
-    const cliVersion = "2.8.0";
-    const downloadUrl = buildDownloadBinaryUrl(cliVersion);
-    if (!fs.existsSync(path.join(__dirname, 'bin'))) {
-        fs.mkdirSync(path.join(__dirname, 'bin'));
-    }
-
-    const response = await axios({
-        url: downloadUrl,
-        method: 'GET',
-        responseType: 'stream'
-    });
-
-    const writer = fs.createWriteStream(binaryPath);
-    response.data.pipe(writer);
-    await new Promise((resolve, reject) => {
-        writer.on('finish', resolve);
-        writer.on('error', reject);
-    });
-
-    // Make it executable (only on Unix-based systems)
-    if (os.platform() !== 'win32') {
-        console.log('Making binary executable...');
-        fs.chmodSync(binaryPath, 0o755);
-    }
-}
-
-const linkToNodeModulesBin = () => {
-    let nodeModulesBinPath = path.join(__dirname, '..', '..', '.bin', 'simplelocalize');
-    
-    if (os.platform() === 'win32') {
-        nodeModulesBinPath += '.exe';
-    }
-
-    if (fs.existsSync(nodeModulesBinPath)) {
-        fs.unlinkSync(nodeModulesBinPath);
-    }
-    fs.symlinkSync(binaryPath, nodeModulesBinPath);
-    console.log('Link to node_modules/.bin created.');
-}
-
-const init = async () => {
-    console.log("Checking if SimpleLocalize CLI is installed...");
-    if (!isBinaryInstalled()) {
-        console.log("SimpleLocalize CLI not installed. Installing...");
-        await installBinary();
-        if (!isBinaryInstalled()) {
-            console.error('Error installing SimpleLocalize CLI');
-            process.exit(1);
-        }
-        console.log("SimpleLocalize CLI installed successfully!");
-    } else {
-        console.log("SimpleLocalize CLI already installed.");
-    }
-    printBinaryVersion();
-    linkToNodeModulesBin();
-    process.exit(0);
-}
-
-init();
+#!/usr/bin/env node
+const { execSync } = require("child_process");
+const path = require("path");
+const fs = require('fs');
+const axios = require('axios');
+const os = require('os');
+
+let binaryPath = path.join(__dirname, 'bin', 'simplelocalize');
+if (os.platform() === 'win32') {
+    binaryPath += '.exe';
+}
+
+const isBinaryInstalled = () => {
+    try {
+        execSync(binaryPath + ' --version', { stdio: 'ignore' });
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+
+const printBinaryVersion = () => {
+    try {
+        console.log(execSync(binaryPath + ' --version').toString());
+    }
+    catch (error) {
+        console.error('Error running SimpleLocalize CLI');
+        process.exit(1);
+    }
+}
+
+const buildDownloadBinaryUrl = (version) => {
+    let platform = "";
+    if (os.platform() === "win32") {
+        platform = "windows.exe"
+    }
+
+    if (os.platform() === "darwin") {
+        platform = "mac"
+    }
+
+    if (os.platform() === "linux") {
+        platform = "linux"
+    }
+
+    let arch = "";
+    if (os.arch() === "arm64") {
+        arch = "-arm64"
+    }
+    console.log(`Downloading SimpleLocalize CLI ${version} for ${platform}${arch}...`);
+    return `https://github.com/simplelocalize/simplelocalize-cli/releases/download/${version}/simplelocalize-cli-${platform}${arch}`
+}
+
+async function installBinary() {
+    const cliVersion = "2.8.0";
+    const downloadUrl = buildDownloadBinaryUrl(cliVersion);
+    if (!fs.existsSync(path.join(__dirname, 'bin'))) {
+        fs.mkdirSync(path.join(__dirname, 'bin'));
+    }
+
+    const response = await axios({
+        url: downloadUrl,
+        method: 'GET',
+        responseType: 'stream'
+    });
+
+    const writer = fs.createWriteStream(binaryPath);
+    response.data.pipe(writer);
+    await new Promise((resolve, reject) => {
+        writer.on('finish', resolve);
+        writer.on('error', reject);
+    });
+
+    // Make it executable (only on Unix-based systems)
+    if (os.platform() !== 'win32') {
+        console.log('Making binary executable...');
+        fs.chmodSync(binaryPath, 0o755);
+    }
+}
+
+const linkToNodeModulesBin = () => {
+    let nodeModulesBinPath = path.join(__dirname, '..', '..', '.bin', 'simplelocalize');
+    
+    if (os.platform() === 'win32') {
+        nodeModulesBinPath += '.exe';
+    }
+
+    if (fs.existsSync(nodeModulesBinPath)) {
+        fs.unlinkSync(nodeModulesBinPath);
+    }
+    fs.symlinkSync(binaryPath, nodeModulesBinPath);
+    console.log('Link to node_modules/.bin created.');
+}
+
+const init = async () => {
+    console.log("Checking if SimpleLocalize CLI is installed...");
+    if (!isBinaryInstalled()) {
+        console.log("SimpleLocalize CLI not installed. Installing...");
+        await installBinary();
+        if (!isBinaryInstalled()) {
+            console.error('Error installing SimpleLocalize CLI');
+            process.exit(1);
+        }
+        console.log("SimpleLocalize CLI installed successfully!");
+    } else {
+        console.log("SimpleLocalize CLI already installed.");
+    }
+    printBinaryVersion();
+    linkToNodeModulesBin();
+    process.exit(0);
+}
+
+init();

package/package.json

@@ -1,20 +1,24 @@
-{
-  "name": "@simplelocalize/cli",
-  "version": "1.0.7",
-  "description": "SimpleLocalize CLI for NPM",
-  "main": "index.cjs",
-  "type": "module",
-  "scripts": {
-    "start": "node index.cjs",
-    "postinstall": "node index.cjs install"
-  },
-  "bin": {
-    "install": "index.cjs",
-    "simplelocalize": "bin/simplelocalize"
-  },
-  "dependencies": {
-    "axios": "^1.8.3"
-  },
-  "author": "Jakub Pomykała",
-  "license": "MIT"
-}
+{
+  "name": "@simplelocalize/cli",
+  "version": "1.0.8",
+  "description": "SimpleLocalize CLI for NPM",
+  "main": "index.cjs",
+  "type": "module",
+  "scripts": {
+    "start": "node index.cjs",
+    "postinstall": "node index.cjs install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/simplelocalize/simplelicalize-cli-npm.git"
+  },
+  "bin": {
+    "install": "index.cjs",
+    "simplelocalize": "bin/simplelocalize"
+  },
+  "dependencies": {
+    "axios": "^1.8.3"
+  },
+  "author": "Jakub Pomykała",
+  "license": "MIT"
+}