license-downloader 1.3.2 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [2.0.0](https://github.com/BePo65/license-downloader/compare/v1.3.3...v2.0.0) (2026-05-02)
+
+
+### ⚠ BREAKING CHANGES
+
+* requires node version >= 22
+
+### Features
+
+* set minimal node version to 22 ([779d017](https://github.com/BePo65/license-downloader/commit/779d017efe09b5f95bc48f6967aa69a7a7d038d5))
+
+
+### Bug Fixes
+
+* update packages to fix dependabot security warnings ([1222a97](https://github.com/BePo65/license-downloader/commit/1222a977bd4e294a51d39fc837fee9b9934c78af))
+* update packages to fix dependabot security warnings ([d746f3b](https://github.com/BePo65/license-downloader/commit/d746f3b1eb87c6091d857eb973ec5f6ea98d1211))
+* update packages to fix dependabot security warnings ([2c86a69](https://github.com/BePo65/license-downloader/commit/2c86a696a641f03a256afcacba7cc4ca57818620))
+* update packages to fix github dependabot security warnings ([2c97082](https://github.com/BePo65/license-downloader/commit/2c97082d5ac99d0b9f9fab840f3d2f614a8536f7))
+
+## [1.3.3](https://github.com/BePo65/license-downloader/compare/v1.3.2...v1.3.3) (2025-10-24)
+
+### Bug Fixes
+
+- update packages to remove security warnings ([ed33513](https://github.com/BePo65/license-downloader/commit/ed335136b83d817e8ebeb2ecd6a5baadba8e5757))
+- use "node:" in imports ([dc35d48](https://github.com/BePo65/license-downloader/commit/dc35d480f30f4508ceeae9de7c83f5a5f26c09b9))
+
 ## [1.3.2](https://github.com/BePo65/license-downloader/compare/v1.3.1...v1.3.2) (2025-05-02)
 
 ## [1.3.1](https://github.com/BePo65/license-downloader/compare/v1.3.0...v1.3.1) (2024-12-10)

package/README.md

@@ -1,7 +1,7 @@
 # license-downloader - an add-on to license-report tool
 
-![Version](https://img.shields.io/badge/version-1.3.2-blue.svg?cacheSeconds=2592000)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)
+[![Version](https://img.shields.io/badge/version-2.0.0-blue.svg?cacheSeconds=86400)](https://github.com/BePo65/license-downloader/blob/main/CHANGELOG.md)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?cacheSeconds=86400)](https://github.com/BePo65/license-downloader/blob/main/LICENSE)
 
 > Download the license files of the dependencies of a project based on the json report from the package 'license-report'.
 

package/index.js

@@ -1,42 +1,28 @@
 #!/usr/bin/env node
 
-import path from 'path';
+import path from 'node:path';
 
 import config from './lib/config.js';
 import FsService from './lib/filesystem-service.js';
+import { helpText, licenseFilesTargetFolder, sourceToTargetFilename } from './lib/util.js';
 import WebService from './lib/web-service.js';
-import {
-  helpText,
-  licenseFilesTargetFolder,
-  sourceToTargetFilename,
-} from './lib/util.js';
 
 (async () => {
   if (config.help) {
-    console.log(helpText); // eslint-disable-line security-node/detect-crlf
+    console.log(helpText);
     return;
   }
 
   try {
     const sourceFilename = config.source;
     const json = await FsService.readJson(sourceFilename);
-    await WebService.addLicenseFilePath(
-      json,
-      config.httpRetryOptions,
-      config.githubToken,
-    );
-    const targetFilename = sourceToTargetFilename(
-      sourceFilename,
-      config.licDir,
-    );
+    await WebService.addLicenseFilePath(json, config.httpRetryOptions, config.githubToken);
+    const targetFilename = sourceToTargetFilename(sourceFilename, config.licDir);
     FsService.createDirFromFilename(targetFilename);
     await FsService.writeJson(json, targetFilename);
     if (config.download) {
       const sourceDirectory = path.dirname(sourceFilename);
-      const targetDirectory = licenseFilesTargetFolder(
-        config.licDir,
-        sourceDirectory,
-      );
+      const targetDirectory = licenseFilesTargetFolder(config.licDir, sourceDirectory);
       await WebService.downloadLicenseFiles(
         json,
         targetDirectory,
@@ -46,6 +32,6 @@ import {
     }
   } catch (e) {
     console.error(e.message);
-    process.exit(1); // eslint-disable-line n/no-process-exit
+    process.exit(1);
   }
 })();

package/lib/filesystem-service.js

@@ -1,12 +1,12 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import jsonfile from 'jsonfile';
 
 /**
  * Reads json file generated by license-report (with option "--output=json")
  * and generates javascript object array from it
  * @param {string} filePath - full path to the license-report generated json file
- * @returns {*} content of the license-report generated json file as object array
+ * @returns {object} content of the license-report generated json file as object array
  */
 export const readJson = async (filePath) => {
   if (!filePath) {

package/lib/util.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 
 const defaultTargetSubdirectory = 'licenses';
 
@@ -13,26 +13,15 @@ const defaultTargetSubdirectory = 'licenses';
 export const sourceToTargetFilename = (sourceFilename, targetDirectory) => {
   if (typeof sourceFilename === 'string' && sourceFilename.trim().length > 0) {
     const extension = path.extname(sourceFilename);
-    const fileBasename = path
-      .basename(sourceFilename)
-      .slice(0, -1 * extension.length);
+    const fileBasename = path.basename(sourceFilename).slice(0, -1 * extension.length);
     let targetDir = targetDirectory;
-    if (
-      targetDir === undefined ||
-      targetDir === null ||
-      targetDir.trim().length === 0
-    ) {
+    if (targetDir === undefined || targetDir === null || targetDir.trim().length === 0) {
       targetDir = path.dirname(sourceFilename);
     }
-    const targetFilename = path.join(
-      targetDir,
-      `${fileBasename}.ext${extension}`,
-    );
+    const targetFilename = path.join(targetDir, `${fileBasename}.ext${extension}`);
     return targetFilename;
   } else {
-    throw new Error(
-      'Source filename must not be empty to generate target filename',
-    );
+    throw new Error('Source filename must not be empty to generate target filename');
   }
 };
 
@@ -44,18 +33,10 @@ export const sourceToTargetFilename = (sourceFilename, targetDirectory) => {
  */
 export const licenseFilesTargetFolder = (licenseDirectory, sourceDirectory) => {
   let targetFolder = '';
-  if (
-    licenseDirectory !== undefined &&
-    licenseDirectory !== null &&
-    licenseDirectory.length > 0
-  ) {
+  if (licenseDirectory !== undefined && licenseDirectory !== null && licenseDirectory.length > 0) {
     targetFolder = licenseDirectory;
   } else {
-    if (
-      sourceDirectory !== undefined &&
-      sourceDirectory !== null &&
-      sourceDirectory.length > 0
-    ) {
+    if (sourceDirectory !== undefined && sourceDirectory !== null && sourceDirectory.length > 0) {
       targetFolder = path.join(sourceDirectory, defaultTargetSubdirectory);
     } else {
       targetFolder = defaultTargetSubdirectory;

package/lib/web-service.js

@@ -1,9 +1,9 @@
-import fs from 'fs';
-import path from 'path';
-import stream from 'stream';
-import { promisify } from 'util';
-import got from 'got';
+import fs from 'node:fs';
+import path from 'node:path';
+import stream from 'node:stream';
+import { promisify } from 'node:util';
 import debug from 'debug';
+import got from 'got';
 
 import FsService from './filesystem-service.js';
 
@@ -42,7 +42,6 @@ const tokenFromConfigObject = (githubTokenConfig) => {
     typeof tokenFileEnvVar === 'string' &&
     tokenFileEnvVar.length > 0
   ) {
-    // eslint-disable-next-line security/detect-object-injection
     const tokenFile = process.env[tokenFileEnvVar];
     if (tokenFile !== undefined && tokenFile.length > 0) {
       if (fs.existsSync(tokenFile)) {
@@ -58,12 +57,7 @@ const tokenFromConfigObject = (githubTokenConfig) => {
     }
   } else {
     const tokenEnvVar = githubTokenConfig.tokenEnvVar;
-    if (
-      tokenEnvVar !== undefined &&
-      typeof tokenEnvVar === 'string' &&
-      tokenEnvVar.length > 0
-    ) {
-      // eslint-disable-next-line security/detect-object-injection
+    if (tokenEnvVar !== undefined && typeof tokenEnvVar === 'string' && tokenEnvVar.length > 0) {
       const tempToken = process.env[tokenEnvVar];
       if (tempToken !== undefined && tempToken.trim().length > 0) {
         token = tempToken;
@@ -87,8 +81,7 @@ const gotGithubJsonOptions = (maxAttempts, name, githubTokenConfig = {}) => {
     retry: { limit: maxAttempts },
     hooks: {
       beforeRetry: [
-        // eslint-disable-next-line no-unused-vars
-        (error, retryCount) => {
+        (_error, _retryCount) => {
           debugForApp(
             `http request to github api for package "${name}" license info failed, retrying again soon...`,
           );
@@ -99,7 +92,6 @@ const gotGithubJsonOptions = (maxAttempts, name, githubTokenConfig = {}) => {
 
   const token = tokenFromConfigObject(githubTokenConfig);
   // no idea how to prevent timing attacks for the download operations
-  // eslint-disable-next-line security/detect-possible-timing-attacks
   if (token !== undefined) {
     gotOptions.headers = {
       Authorization: `Bearer ${token}`,
@@ -116,17 +108,12 @@ const gotGithubJsonOptions = (maxAttempts, name, githubTokenConfig = {}) => {
  * @param {object} githubTokenConfig - object with authorization data {tokenEnvVar, tokenFileEnvVar}
  * @returns {object} object with the options for 'got' request
  */
-const gotGithubLicenseFileOptions = (
-  maxAttempts,
-  url,
-  githubTokenConfig = {},
-) => {
+const gotGithubLicenseFileOptions = (maxAttempts, url, githubTokenConfig = {}) => {
   const gotOptions = {
     retry: { limit: maxAttempts },
     hooks: {
       beforeRetry: [
-        // eslint-disable-next-line no-unused-vars
-        (error, retryCount) => {
+        (_error, _retryCount) => {
           debugForApp(
             `http request to github for license file at "${url}" failed, retrying again soon...`,
           );
@@ -143,7 +130,6 @@ const gotGithubLicenseFileOptions = (
 
   const token = tokenFromConfigObject(githubTokenConfig);
   // no idea how to prevent timing attacks for the download operations
-  // eslint-disable-next-line security/detect-possible-timing-attacks
   if (token !== undefined) {
     gotOptions.headers = {
       Authorization: `Bearer ${token}`,
@@ -161,9 +147,7 @@ const gotGithubLicenseFileOptions = (
  */
 const getPackageNameFromLinkGit = (link) => {
   let packageName = '';
-  const results = link.match(
-    /.+github\.com\/([^/]+\/[^/#]+?)(?:\.git)?(?=\/|#|$)/i,
-  );
+  const results = link.match(/.+github\.com\/([^/]+\/[^/#]+?)(?:\.git)?(?=\/|#|$)/i);
   if (results !== null && results.length === 2) {
     packageName = results[1];
   }
@@ -211,7 +195,7 @@ const getPackageNameFromLink = (link) => {
 
 /**
  * Adds path to license file to object array
- * @param {*} packagesInfos - array of objects generated from the license-report generated json file
+ * @param {object[]} packagesInfos - array of objects generated from the license-report generated json file
  * @param {object} httpRetryOptions - http retry options for 'got' requests ({maxAttempts})
  * @param {object} authorizationOptions - authorization options for 'got' requests {tokenEnvVar, tokenFileEnvVar}
  */
@@ -220,11 +204,7 @@ export const addLicenseFilePath = async (
   httpRetryOptions = {},
   authorizationOptions = {},
 ) => {
-  if (
-    packagesInfos !== undefined &&
-    Array.isArray(packagesInfos) &&
-    packagesInfos.length > 0
-  ) {
+  if (packagesInfos !== undefined && Array.isArray(packagesInfos) && packagesInfos.length > 0) {
     await Promise.all(
       packagesInfos.map(async (element) => {
         element.licenseFileLink = '';
@@ -241,10 +221,7 @@ export const addLicenseFilePath = async (
               );
               const result = await got(licenseInfoAdr, options);
               const licenseInfo = result.body;
-              if (
-                licenseInfo.download_url !== undefined &&
-                licenseInfo.download_url.length > 0
-              ) {
+              if (licenseInfo.download_url !== undefined && licenseInfo.download_url.length > 0) {
                 element.licenseFileLink = licenseInfo.download_url;
               }
             } catch (error) {
@@ -253,8 +230,8 @@ export const addLicenseFilePath = async (
                 const { headers } = response;
                 if (headers['x-ratelimit-remaining'] === '0') {
                   const timeForRateLimitReset =
-                    parseInt(error.response.headers['x-ratelimit-reset']) -
-                    Math.floor(new Date().getTime() / 1000);
+                    parseInt(error.response.headers['x-ratelimit-reset'], 10) -
+                    Math.floor(Date.now() / 1000);
                   const resetMsg = timeForRateLimitReset
                     ? ` please wait ${timeForRateLimitReset} seconds before trying again.`
                     : '';
@@ -265,18 +242,14 @@ export const addLicenseFilePath = async (
                     console.error(
                       'You can increase the rate limit by providing a github token. See the README for more information.',
                     );
-                  debugForApp(
-                    `Failed query '${licenseInfoAdr}' ('${error.message}')`,
-                  );
+                  debugForApp(`Failed query '${licenseInfoAdr}' ('${error.message}')`);
                   return;
                 }
               }
               console.error(
-                `the project '${githubPackageName}' does not contain a license file on github`,
-              );
-              debugForApp(
-                `no license file on '${licenseInfoAdr}' ('${error.message}')`,
+                `the project '${githubPackageName}' does not contain a license file on github; request returned ${response.statusCode} ( ${response.statusMessage})`,
               );
+              debugForApp(`no license file on '${licenseInfoAdr}' ('${error.message}')`);
             }
           }
         }
@@ -289,7 +262,7 @@ export const addLicenseFilePath = async (
 
 /**
  * Download all license files to target directory
- * @param {*} packagesInfos - array of objects with package infos including path to license file
+ * @param {object[]} packagesInfos - array of objects with package infos including path to license file
  * @param {string} targetDirectory - path of directory for downloaded license files
  * @param {object} httpRetryOptions - http retry options for 'got' requests ({maxAttempts})
  * @param {object} authorizationOptions - authorization options for 'got' requests {tokenEnvVar, tokenFileEnvVar}
@@ -324,11 +297,7 @@ export const downloadLicenseFiles = async (
       await pipeline(
         got.stream(
           url,
-          gotGithubLicenseFileOptions(
-            httpRetryOptions.maxAttempts,
-            url,
-            authorizationOptions,
-          ),
+          gotGithubLicenseFileOptions(httpRetryOptions.maxAttempts, url, authorizationOptions),
         ),
         fileWriterStream,
       );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "license-downloader",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "description": "Download the license files of the dependencies of a project",
   "main": "index.js",
   "bin": {
@@ -8,7 +8,7 @@
   },
   "type": "module",
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "files": [
     "index.js",
@@ -21,8 +21,9 @@
   },
   "bugs": "https://github.com/BePo65/license-downloader/issues",
   "scripts": {
-    "lint": "npx eslint index.js lib/**/*.js test/**/*.js **/*.json",
-    "test": "npx mocha -R spec",
+    "lint": "npx @biomejs/biome check .",
+    "lint:fix": "npx @biomejs/biome check --write .",
+    "test": "node --test --test-reporter=spec",
     "lint-commits": "commitlint --from d6a731d70b4f2 --to HEAD --verbose",
     "init-changelog": "commit-and-tag-version -i CHANGELOG.md --same-file --prerelease pre --first-release",
     "release": "commit-and-tag-version -i CHANGELOG.md --same-file",
@@ -36,33 +37,23 @@
   "author": "BePo65",
   "license": "MIT",
   "dependencies": {
-    "debug": "^4.4.0",
-    "got": "^14.4.7",
-    "jsonfile": "^6.1.0",
+    "debug": "^4.4.3",
+    "got": "^15.0.3",
+    "jsonfile": "^6.2.1",
     "rc": "^1.2.8"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.0",
-    "@commitlint/config-angular": "^19.8.0",
-    "chai": "^5.2.0",
-    "commit-and-tag-version": "^12.5.1",
-    "eslint": "^9.25.1",
-    "eslint-plugin-chai-expect": "^3.1.0",
-    "eslint-plugin-jsdoc": "^50.6.11",
-    "eslint-plugin-json": "^4.0.1",
-    "eslint-plugin-mocha": "^11.0.0",
-    "eslint-plugin-n": "^17.17.0",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-security": "^3.0.1",
-    "eslint-plugin-security-node": "^1.1.4",
+    "@biomejs/biome": "^2.4.5",
+    "@commitlint/cli": "^20.4.3",
+    "@commitlint/config-angular": "^20.4.3",
+    "commit-and-tag-version": "^12.7.1",
+    "conventional-commits-filter": "^5.0.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.5.1",
-    "mocha": "^11.2.2",
-    "prettier": "^3.5.3",
+    "lint-staged": "^16.4.0",
     "temp": "^0.9.4"
   },
   "lint-staged": {
-    "**/*": "prettier --write --ignore-unknown"
+    "**/*": "npx @biomejs/biome check --write ."
   },
   "commit-and-tag-version": {
     "packageFiles": [