tar-dependency 0.0.3 → 0.2.0

package/.nvmrc

@@ -0,0 +1 @@
+20

package/README.md

@@ -1,26 +1,27 @@
-tar-dependency
-======================
+# tar-dependency
 
 > Installs tar archives defined in package.json to a directory
 
-This small command line tool has the following purpose:
+This is a small helper tool with the following purpose:
 
 * It fetches / extracts .tar(.gz) archives into a local folder
 * It stores the installed archive infos in `package.json`
 
-This tool is mainly used during development: The archives needed during development / as part of the package can
+This tool is mainly used for fetching git repositories as tar archives from github / gitlab: The archives needed during development / as part of the package can
 be defined in `package.json`, so this information is part of the main repo and can be distributed to source control.
-It allows adding non-git / non-npm dependencies to be installed as part of the package management.
+It allows adding non-npm dependencies to be installed as part of the package management.
 
-We created this tool to replace [Bower](https://bower.io/), where cannot use npm/yarn for non-JS/Web repositories.
+We created this tool to replace [Bower](https://bower.io/), where packages are not available as npm/yarn packages.
 
-Installation
--------------
+## Requirements
+
+This library needs at least NodeJS >= 20
+
+## Installation
 
 `npm install --save-dev tar-dependency`
 
-Usage
------
+## Usage
 
 *Note*: This tool assumes a `package.json` in the current working directory.
 
@@ -90,6 +91,16 @@ and then install them with
 
 `tar-dependency install`
 
+## Changelog
+
+### 0.2.0 - Feb 2025
+
+* [breaking] Updated to NodeJS >= 20 with ES Modules
+* [breaking] You need a NodeJS version that supports ES Modules (~ V.14.0)
+* Updated dependant packages
+
+### 0.1.0
 
+Initial release
 
-(c) 2017 alex@alexi.ch
+(c) 2017-2025 alex@alexi.ch

package/bin/cmd.js

@@ -4,34 +4,35 @@
  *
  * It assumes a package.json in the actual working directory.
  *
- * (c) 2017 alex@alexi.ch
+ * (c) 2017-2025 alex@alexi.ch
  */
 
-var lib = require('../index.js');
-var jsonfile = require('jsonfile');
-var path = require('path');
-var program = require('commander');
+import process from 'node:process';
+import lib from '../index.js';
+import jsonfile from 'jsonfile';
+import path from 'path';
+import { program } from 'commander';
 
-var setWorkingDir = function(dir) {
+function setWorkingDir(dir) {
     process.chdir(dir);
-};
+}
 
-var packageConfigPath = function() {
+function packageConfigPath() {
     return path.join(process.cwd(), 'package.json');
-};
+}
 
-var readPackageConfig = function() {
+function readPackageConfig() {
     return jsonfile.readFileSync(packageConfigPath());
-};
+}
 
-var packageConf = readPackageConfig();
+const packageConf = readPackageConfig();
 
 program.option('-w, --working-dir <path>', 'use specified working directory');
 
 program
     .command('install')
     .description('installs / updates tar dependencies defined in package.json')
-    .action(function() {
+    .action(async function () {
         setWorkingDir(this.parent.workingDir || process.cwd());
         lib.install(packageConf);
     });
@@ -45,12 +46,12 @@ program
     .description(
         'Fetches the tar from <url> and extracts it to <dest-dir>. Note that dest-dir SHOULD be relative to package.json. Updates package.json.'
     )
-    .action(function(url, destDir) {
+    .action(async function (url, destDir) {
         var strip = this.strip === undefined ? 1 : Number(this.strip);
         setWorkingDir(this.parent.workingDir || process.cwd());
         lib.add(packageConf, url, destDir, strip);
         lib.saveConfig(packageConf, packageConfigPath());
-        lib.install(packageConf, destDir);
+        await lib.install(packageConf, destDir);
     });
 
 program
@@ -58,14 +59,16 @@ program
     .description(
         'Removes an installed/extracted archive from disk as well as from package.json. Please make sure dest-dir identifies an entry in package.json.'
     )
-    .action(function(name) {
+    .action(async function (name) {
         setWorkingDir(this.parent.workingDir || process.cwd());
         lib.remove(packageConf, name);
         lib.saveConfig(packageConf, packageConfigPath());
     });
 
-program.parse(process.argv);
+(async function () {
+    await program.parseAsync(process.argv);
 
-if (!process.argv.slice(2).length) {
-    program.help();
-}
+    if (!process.argv.slice(2).length) {
+        program.help();
+    }
+})();

package/eslint.config.js

@@ -0,0 +1,46 @@
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import json from 'eslint-plugin-json';
+
+// eslint.config.js
+export default [
+    eslintPluginPrettierRecommended,
+	{
+		files: ["**/*.json"],
+		...json.configs["recommended"]
+	  },
+    {
+        // extends: ['prettier', 'plugin:json/recommended'],
+        languageOptions: {
+            ecmaVersion: 2017
+        },
+        // env: {
+        //     node: true
+        // },
+        // plugins: ['prettier', 'json'],
+        rules: {
+            'prettier/prettier': [
+                'error',
+                {
+                    singleQuote: true,
+                    tabWidth: 4,
+                    printWidth: 120
+                }
+            ],
+            'no-unused-vars': [
+                'error',
+                {
+                    vars: 'all',
+                    args: 'none'
+                }
+            ],
+            semi: ['error', 'always'],
+            curly: 'error',
+            eqeqeq: 'error',
+            'no-eval': 'error',
+            'no-loop-func': 'error',
+            radix: 'error',
+            'comma-dangle': 'error',
+            'no-undef': 'error'
+        }
+    }
+];

package/index.js

@@ -1,14 +1,16 @@
 /**
  * tar-dependency module
  *
- * (c) 2017 alex@alexi.ch
+ * (c) 2017-2025 alex@alexi.ch
  */
-var path = require('path'),
-    jsonfile = require('jsonfile'),
-    rimraf = require('rimraf'),
-    mkdirp = require('mkdirp'),
-    tar = require('tar'),
-    request = require('request');
+import process from 'node:process';
+import console from 'node:console';
+import path from 'path';
+import jsonfile from 'jsonfile';
+import { rimraf } from 'rimraf';
+import { mkdirp } from 'mkdirp';
+import * as tar from 'tar';
+import fetch from 'node-fetch';
 
 function normalizePathKey(str) {
     return (str || '').replace(/(^\/)|(\/$)/g, ''); // remove leading/trailing slashes)
@@ -27,40 +29,35 @@ function normalizePathKey(str) {
  *   ...
  * }
  *
- * Note that this function:
- * - runs SYNCHRONOUS intentionally
+ * This function returns a promise that resolves when all dependencies are installed.
  */
-var installTarDependencies = function(config, destKey) {
+async function installTarDependencies(config, destKey) {
     config = config || {};
-    var path = require('path'),
-        deps = config.tarDependencies || {};
+    const deps = config.tarDependencies || {};
 
     destKey = normalizePathKey(destKey);
-    Object.keys(deps).forEach(function(key) {
+    for (const key of Object.keys(deps)) {
         if (destKey && key !== destKey) {
             return;
         }
-        var dest = key;
-        var fullOutdir = path.join(process.cwd(), dest);
-        var url = deps[key].url;
-        var strip = deps[key].strip;
+        const fullOutdir = path.join(process.cwd(), key);
+        const url = deps[key].url;
+        const strip = deps[key].strip === undefined ? 1 : Number(deps[key].strip);
 
-        if (strip === undefined) {
-            strip = 1;
-        }
-        console.log('tar package: ' + url + ' => ' + dest);
-        rimraf.sync(fullOutdir);
-        mkdirp.sync(fullOutdir);
+        console.log('tar package: ' + url + ' => ' + key);
+        await rimraf(fullOutdir);
+        await mkdirp(fullOutdir);
 
-        request(url).pipe(
+        const response = await fetch(url);
+        response.body.pipe(
             tar.x({
                 strip: strip,
                 C: fullOutdir,
                 sync: true
             })
         );
-    });
-};
+    }
+}
 
 /*
  * Adds an archive to the list of dependencies, but does NOT install it:
@@ -70,7 +67,7 @@ var installTarDependencies = function(config, destKey) {
  *
  * The given config object is updated.
  */
-var addArchive = function(config, url, destDir, strip) {
+function addArchive(config, url, destDir, strip) {
     config = config || {};
     strip = strip === undefined ? 1 : Number(strip);
     destDir = normalizePathKey(destDir);
@@ -79,7 +76,7 @@ var addArchive = function(config, url, destDir, strip) {
     tarConfig.url = url;
     tarConfig.strip = strip;
     config.tarDependencies[destDir] = tarConfig;
-};
+}
 
 /*
  * Removes an archive identified by given path key. It removes the archive on the disk
@@ -90,7 +87,7 @@ var addArchive = function(config, url, destDir, strip) {
  *
  * The given config object is updated.
  */
-var removeArchive = function(config, destDir) {
+async function removeArchive(config, destDir) {
     config = config || {};
     config.tarDependencies = config.tarDependencies || {};
     destDir = normalizePathKey(destDir);
@@ -99,10 +96,9 @@ var removeArchive = function(config, destDir) {
         delete config.tarDependencies[destDir];
     }
 
-    var fullOutdir = path.join(process.cwd(), destDir);
-
-    rimraf.sync(fullOutdir);
-};
+    const fullOutdir = path.join(process.cwd(), destDir);
+    await rimraf(fullOutdir);
+}
 
 /*
  * Saves the given config object as json to a file. Normally, 'file'
@@ -110,12 +106,12 @@ var removeArchive = function(config, destDir) {
  *
  * See README.md for more information and examples.
  */
-var saveConf = function(config, file) {
+async function saveConf(config, file) {
     config = config || {};
-    jsonfile.writeFileSync(file, config, { spaces: 2 });
-};
+    await jsonfile.writeFile(file, config, { spaces: 2 });
+}
 
-module.exports = {
+export default {
     install: installTarDependencies,
     add: addArchive,
     remove: removeArchive,

package/package.json

@@ -1,67 +1,49 @@
 {
-    "name": "tar-dependency",
-    "version": "0.0.3",
-    "description": "Fetches .tar(.gz) archives defined in package.json and extracts them to a specific location.",
-    "main": "index.js",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
+  "name": "tar-dependency",
+  "version": "0.2.0",
+  "description": "Fetches .tar(.gz) archives defined in package.json and extracts them to a specific location.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Alexander Schenkel",
+  "email": "alex@alexi.ch",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^13.1.0",
+    "jsonfile": "^6.1.0",
+    "mkdirp": "^3.0.1",
+    "node-fetch": "^2.6.5",
+    "rimraf": "^6.0.1",
+    "tar": "^7.4.3"
+  },
+  "devDependencies": {
+    "eslint": "^9.20.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-json": "^4.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "prettier": "^3.5.0"
+  },
+  "bin": {
+    "tar-dependency": "bin/cmd.js"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "none"
+  },
+  "tarDependencies": {
+    "packages/fontawesome": {
+      "url": "http://reposerver.kp.local/lib/fontawesome-pro-6.7.2-web.tar.gz",
+      "strip": 1
     },
-    "author": "Alexander Schenkel",
-    "email": "alex@alexi.ch",
-    "license": "MIT",
-    "dependencies": {
-        "commander": "^2.11.0",
-        "jsonfile": "^4.0.0",
-        "mkdirp": "^0.5.1",
-        "request": "^2.83.0",
-        "rimraf": "^2.6.2",
-        "tar": "^4.0.2"
-    },
-    "devDependencies": {
-        "eslint": "^4.11.0",
-        "eslint-config-prettier": "^2.8.0",
-        "eslint-plugin-prettier": "^2.3.1",
-        "prettier": "^1.8.2"
-    },
-    "bin": {
-        "tar-dependency": "bin/cmd.js"
-    },
-    "eslintConfig": {
-        "root": true,
-        "extends": "prettier",
-        "env": {
-            "node": true
-        },
-        "plugins": [
-            "prettier"
-        ],
-        "rules": {
-            "prettier/prettier": [
-                "error",
-                {
-                    "singleQuote": true,
-                    "tabWidth": 4,
-                    "printWidth": 120
-                }
-            ],
-            "no-unused-vars": [
-                "error",
-                {
-                    "vars": "all",
-                    "args": "none"
-                }
-            ],
-            "semi": [
-                "error",
-                "always"
-            ],
-            "curly": "error",
-            "eqeqeq": "error",
-            "no-eval": "error",
-            "no-loop-func": "error",
-            "radix": "error",
-            "comma-dangle": "error",
-            "no-undef": "error"
-        }
+    "packages/php-injector": {
+      "url": "https://github.com/bylexus/php-injector/archive/0.0.8.tar.gz",
+      "strip": 1
     }
+  }
 }