license-downloader 1.2.0 → 1.3.2

package/CHANGELOG.md

@@ -2,24 +2,33 @@
 
 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.
 
-## [1.2.0](https://github.com/BePo65/license-downloader/compare/v1.1.0...v1.2.0) (2024-09-12)
+## [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)
+
+### Bug Fixes
 
+- update packages to fix github dependabot security warnings ([91ff3d9](https://github.com/BePo65/license-downloader/commit/91ff3d99861db72264b7230f64cf3c7fce9461e3))
+- update packages to fix github dependabot security warnings ([f7e3ec2](https://github.com/BePo65/license-downloader/commit/f7e3ec202e0790ff79ca2088ec92d9490873a7ef))
+
+## [1.3.0](https://github.com/BePo65/license-downloader/compare/v1.2.0...v1.3.0) (2024-09-17)
+
+## [1.2.0](https://github.com/BePo65/license-downloader/compare/v1.1.0...v1.2.0) (2024-09-12)
 
 ### Features
 
-* support GITHUB_TOKEN env variable by default ([258f8e0](https://github.com/BePo65/license-downloader/commit/258f8e02c39e61cd4c3b5e85df68f068b85bea84))
+- support GITHUB_TOKEN env variable by default ([258f8e0](https://github.com/BePo65/license-downloader/commit/258f8e02c39e61cd4c3b5e85df68f068b85bea84))
 
 ## [1.1.0](https://github.com/BePo65/license-downloader/compare/v1.0.12...v1.1.0) (2024-06-30)
 
-
 ### Features
 
-* add --help flag for cli to show short documentation ([cb02040](https://github.com/BePo65/license-downloader/commit/cb020408288e857f8dab5802fbbe7d192e0e0477))
+- add --help flag for cli to show short documentation ([cb02040](https://github.com/BePo65/license-downloader/commit/cb020408288e857f8dab5802fbbe7d192e0e0477))
 
 ### Bug Fixes
 
-* fix handling of authorization
-* fix handling of packages with long package path or not ending with '.git'
+- fix handling of authorization
+- fix handling of packages with long package path or not ending with '.git'
 
 ## [1.0.12](https://github.com/BePo65/license-downloader/compare/v1.0.11...v1.0.12) (2024-06-22)
 
@@ -43,42 +52,37 @@ All notable changes to this project will be documented in this file. See [commit
 
 ### [1.0.2](https://github.com/BePo65/license-downloader/compare/v1.0.1...v1.0.2) (2021-05-12)
 
-
 ### Bug Fixes
 
-* index.js needs shebang for use with npx ([415b986](https://github.com/BePo65/license-downloader/commit/415b98621c2ddb50f5d07cc3586dedf816e2c810))
+- index.js needs shebang for use with npx ([415b986](https://github.com/BePo65/license-downloader/commit/415b98621c2ddb50f5d07cc3586dedf816e2c810))
 
 ### [1.0.1](https://github.com/BePo65/license-downloader/compare/v1.0.0...v1.0.1) (2021-05-12)
 
-
 ### Bug Fixes
 
-* add bin property to run program with npx ([43443f7](https://github.com/BePo65/license-downloader/commit/43443f7c83e2b76d9f2f8c41c43f475ff35ddb79))
+- add bin property to run program with npx ([43443f7](https://github.com/BePo65/license-downloader/commit/43443f7c83e2b76d9f2f8c41c43f475ff35ddb79))
 
 ## [1.0.0](https://github.com/BePo65/license-downloader/compare/v0.3.1...v1.0.0) (2021-05-12)
 
 ### [0.3.1](https://github.com/BePo65/license-downloader/compare/v0.3.0...v0.3.1) (2021-05-12)
 
-
 ### Bug Fixes
 
-* convert readme-updater to commonjs file ([4a5d1dd](https://github.com/BePo65/license-downloader/commit/4a5d1dd8abd89ea8b8d52372f529cdb60fa1ac61))
+- convert readme-updater to commonjs file ([4a5d1dd](https://github.com/BePo65/license-downloader/commit/4a5d1dd8abd89ea8b8d52372f529cdb60fa1ac61))
 
 ## 0.3.0 (2021-05-12)
 
-
 ### Features
 
-* add authorization for github accesses ([e022c52](https://github.com/BePo65/license-downloader/commit/e022c52a9de32287cd4c974384a3d5ca141de972))
-* add default export to modules ([e05aa5a](https://github.com/BePo65/license-downloader/commit/e05aa5a9eabca7ec74c75e57de2a0b08bdb8f4c4))
-* add license file ([9da79f5](https://github.com/BePo65/license-downloader/commit/9da79f5c6b9b3253ca0f0b48f35a06ef64034ec8))
-* get license files and export extended list fo file ([0a818bc](https://github.com/BePo65/license-downloader/commit/0a818bc2797e14219f9f1050fdec9013b2c052f1))
-* rename license files to '<packageName>.LICENSE.txt ([2029f4a](https://github.com/BePo65/license-downloader/commit/2029f4a5694f39a96bd145167f6b9ed18da91590))
-
+- add authorization for github accesses ([e022c52](https://github.com/BePo65/license-downloader/commit/e022c52a9de32287cd4c974384a3d5ca141de972))
+- add default export to modules ([e05aa5a](https://github.com/BePo65/license-downloader/commit/e05aa5a9eabca7ec74c75e57de2a0b08bdb8f4c4))
+- add license file ([9da79f5](https://github.com/BePo65/license-downloader/commit/9da79f5c6b9b3253ca0f0b48f35a06ef64034ec8))
+- get license files and export extended list fo file ([0a818bc](https://github.com/BePo65/license-downloader/commit/0a818bc2797e14219f9f1050fdec9013b2c052f1))
+- rename license files to '<packageName>.LICENSE.txt ([2029f4a](https://github.com/BePo65/license-downloader/commit/2029f4a5694f39a96bd145167f6b9ed18da91590))
 
 ### Bug Fixes
 
-* log to stderr improved when no license file found ([c1a4534](https://github.com/BePo65/license-downloader/commit/c1a45346e2aeb3fdb7812bb104d2bb83f2b19f74))
-* no error when directory already exists on mkdir ([5736c2f](https://github.com/BePo65/license-downloader/commit/5736c2f302e030e43ede3c436edd2b861617d023))
-* overwrite output json file when already exists ([ee89151](https://github.com/BePo65/license-downloader/commit/ee8915128cc261743e94189a81a5e439a8602e91))
-* update readme file ([6fbe174](https://github.com/BePo65/license-downloader/commit/6fbe174635c8a72c14e38f8d0fd410be797ff929))
+- log to stderr improved when no license file found ([c1a4534](https://github.com/BePo65/license-downloader/commit/c1a45346e2aeb3fdb7812bb104d2bb83f2b19f74))
+- no error when directory already exists on mkdir ([5736c2f](https://github.com/BePo65/license-downloader/commit/5736c2f302e030e43ede3c436edd2b861617d023))
+- overwrite output json file when already exists ([ee89151](https://github.com/BePo65/license-downloader/commit/ee8915128cc261743e94189a81a5e439a8602e91))
+- update readme file ([6fbe174](https://github.com/BePo65/license-downloader/commit/6fbe174635c8a72c14e38f8d0fd410be797ff929))

package/README.md

@@ -1,120 +1,133 @@
-# license-downloader - an add-on to license-report tool
-![Version](https://img.shields.io/badge/version-1.2.0-blue.svg?cacheSeconds=2592000)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)
-
-> Download the license files of the dependencies of a project based on the json report from the package 'license-report'.
-
-## Install
-
-```sh
-npm install license-downloader
-```
-
-## Usage
-
-'license-downloader' uses the github REST API to find the location of the license files of the project (dev-) dependencies. The license file location does not depend on the package version. Details about how the license file is detected can be found in [licensee/licensee > What we look at](https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md) and [licensee/licensee > README](https://github.com/licensee/licensee/tree/master/docs).
-
-Optionally it downloads these files to a given directory.
-
-### Usage with downloading the license files:
-```sh
-cd your/project/
-npx license-report > ./license-report.json
-npx license-downloader --source ./license-report.json --licDir ./license-files --download
-```
-
-A copy of the 'license-report.json' file with properties 'licenseFileLink' added is saved to the './license-files' directory (defined in option `--licDir`). The downloaded licenses are save in a subdirectory named 'licenses' in the directory defined in `--licDir`.
-
-If option `--licDir` is missing, the modified 'license-report.json' file and the 'licenses' subdirectory are written to the path of the source file.
-
-### Usage without downloading the license files:
-```sh
-cd your/project/
-npx license-report > ./license-report.json
-npx license-downloader --source ./license-report.json
-```
-
-The copy of the 'license-report.json' file with properties 'licenseFileLink' added is saved to the directory of the source file.
-
-## Authorization in GitHub
-
-License-downloader uses the github api to collect information about the license file of a project. If the rate limit for anonymous access to this api is exceeded (60 accesses per hour) you will get warnings like this:
-```
-kessler/node-tableify: License query failed. Rate limit of 60 requests per hour exceeded. please wait 1534 seconds before trying again.
-caolan/async: License query failed. Rate limit of 60 requests per hour exceeded. please wait 1534 seconds before trying again.
-```
-
-To avoid this problem you can use a github personal access token to use the higher limits of your personal github plan. As an alternative you can use fine-grained access tokens; details can be found in the github documentation for "Get the license for a repository".
-
-There are 2 possibilities:
-
-**use a file (recommended)**
-
-write the github token, generated in your github developer settings, to a file.
-
-The full path to this file is written to an environment variable and the name of this environment variable is set in the config parameter 'githubToken.tokenFileEnvVar':
-```sh
-export GITHUB_TOKEN_FILE=/run/secrets/github_pat.txt
-cd your/project/
-npx license-report > ./license-report.json
-npx license-downloader --source ./license-report.json --licDir ./license-files --githubToken.tokenFileEnvVar GITHUB_TOKEN_FILE --download
-```
-This is the most secure variant, as access rights can be and should be set for this file to prevent unauthorized access.
-
-**use an environment variable**
-
-Generate a github token in your github developer settings and write it to an environment variable.
-
-If the environment variable name is `GITHUB_TOKEN`, then it will be used automatically.
-If you want to use another environment variable, you can set it with the parameter `--githubToken.tokenEnvVar`.
-
-Examples:
-```sh
-export GITHUB_TOKEN=yourgithubtoken
-cd your/project/
-npx license-report > ./license-report.json
-npx license-downloader --source ./license-report.json --licDir ./license-files --download
-```
-
-Or with a different environment variable name:
-```sh
-export MY_GITHUB_TOKEN=yourgithubtoken
-cd your/project/
-npx license-report > ./license-report.json
-npx license-downloader --source ./license-report.json --licDir ./license-files --githubToken.tokenEnvVar MY_GITHUB_TOKEN --download
-```
-
-## Show debug log
-
-Use in linux shell
-```sh
-export DEBUG=license-downloader
-```
-or in windows command line
-```sh
-SET DEBUG=license-downloader
-```
-
-## Development
-
-This repo uses standard-changelog to create the CHANGELOG. To ensure that the commit messages follow the standard-changelog rules, husky is used for git hooks.
-
-To initialize the git hooks after checking out the repo, run `npx husky install`.
-
-Allowed types for commit messages are:
-+ build
-+ ci
-+ docs
-+ feat
-+ fix
-+ perf
-+ refactor
-+ release
-+ revert
-+ style
-+ test
-
-Allowed scopes are:
-+ app
-+ hacks
-+ tools
+# 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)](#)
+
+> Download the license files of the dependencies of a project based on the json report from the package 'license-report'.
+
+## Install
+
+```sh
+npm install license-downloader
+```
+
+## Usage
+
+'license-downloader' uses the github REST API to find the location of the license files of the project (dev-) dependencies. The license file location does not depend on the package version. Details about how the license file is detected can be found in [licensee/licensee > What we look at](https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md) and [licensee/licensee > README](https://github.com/licensee/licensee/tree/master/docs).
+
+Optionally it downloads these files to a given directory.
+
+### Usage with downloading the license files:
+
+```sh
+cd your/project/
+npx license-report > ./license-report.json
+npx license-downloader --source ./license-report.json --licDir ./license-files --download
+```
+
+A copy of the 'license-report.json' file with properties 'licenseFileLink' added is saved to the './license-files' directory (defined in option `--licDir`). The downloaded licenses are save in a subdirectory named 'licenses' in the directory defined in `--licDir`.
+
+If option `--licDir` is missing, the modified 'license-report.json' file and the 'licenses' subdirectory are written to the path of the source file.
+
+### Usage without downloading the license files:
+
+```sh
+cd your/project/
+npx license-report > ./license-report.json
+npx license-downloader --source ./license-report.json
+```
+
+The copy of the 'license-report.json' file with properties 'licenseFileLink' added is saved to the directory of the source file.
+
+## Authorization in GitHub
+
+License-downloader uses the github api to collect information about the license file of a project. If the rate limit for anonymous access to this api is exceeded (60 accesses per hour) you will get warnings like this:
+
+```
+kessler/node-tableify: License query failed. Rate limit of 60 requests per hour exceeded. please wait 1534 seconds before trying again.
+caolan/async: License query failed. Rate limit of 60 requests per hour exceeded. please wait 1534 seconds before trying again.
+```
+
+To avoid this problem you can use a github personal access token to use the higher limits of your personal github plan. As an alternative you can use fine-grained access tokens; details can be found in the github documentation for "Get the license for a repository".
+
+There are 2 possibilities:
+
+**use a file (recommended)**
+
+write the github token, generated in your github developer settings, to a file.
+
+The full path to this file is written to an environment variable and the name of this environment variable is set in the config parameter 'githubToken.tokenFileEnvVar':
+
+```sh
+export GITHUB_TOKEN_FILE=/run/secrets/github_pat.txt
+cd your/project/
+npx license-report > ./license-report.json
+npx license-downloader --source ./license-report.json --licDir ./license-files --githubToken.tokenFileEnvVar GITHUB_TOKEN_FILE --download
+```
+
+This is the most secure variant, as access rights can be and should be set for this file to prevent unauthorized access.
+
+**use an environment variable**
+
+Generate a github token in your github developer settings and write it to an environment variable.
+
+If the environment variable name is `GITHUB_TOKEN`, then it will be used automatically.
+If you want to use another environment variable, you can set it with the parameter `--githubToken.tokenEnvVar`.
+
+Examples:
+
+```sh
+export GITHUB_TOKEN=yourgithubtoken
+cd your/project/
+npx license-report > ./license-report.json
+npx license-downloader --source ./license-report.json --licDir ./license-files --download
+```
+
+Or with a different environment variable name:
+
+```sh
+export MY_GITHUB_TOKEN=yourgithubtoken
+cd your/project/
+npx license-report > ./license-report.json
+npx license-downloader --source ./license-report.json --licDir ./license-files --githubToken.tokenEnvVar MY_GITHUB_TOKEN --download
+```
+
+## Show debug log
+
+Use in linux shell
+
+```sh
+export DEBUG=license-downloader
+```
+
+or in windows command line
+
+```sh
+SET DEBUG=license-downloader
+```
+
+## Development
+
+This repo uses standard-changelog to create the CHANGELOG. To ensure that the commit messages follow the standard-changelog rules, husky is used for git hooks.
+
+To initialize the git hooks after checking out the repo, run `npx husky install`.
+
+Allowed types for commit messages are:
+
+- build
+- ci
+- docs
+- feat
+- fix
+- perf
+- refactor
+- release
+- revert
+- style
+- test
+
+Allowed scopes are:
+
+- app
+- hacks
+- tools

package/index.js

@@ -5,7 +5,11 @@ import path from 'path';
 import config from './lib/config.js';
 import FsService from './lib/filesystem-service.js';
 import WebService from './lib/web-service.js';
-import { helpText, licenseFilesTargetFolder, sourceToTargetFilename } from './lib/util.js';
+import {
+  helpText,
+  licenseFilesTargetFolder,
+  sourceToTargetFilename,
+} from './lib/util.js';
 
 (async () => {
   if (config.help) {
@@ -16,17 +20,32 @@ import { helpText, licenseFilesTargetFolder, sourceToTargetFilename } from './li
   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);
-      await WebService.downloadLicenseFiles(json, targetDirectory, config.httpRetryOptions, config.githubToken);
+      const targetDirectory = licenseFilesTargetFolder(
+        config.licDir,
+        sourceDirectory,
+      );
+      await WebService.downloadLicenseFiles(
+        json,
+        targetDirectory,
+        config.httpRetryOptions,
+        config.githubToken,
+      );
     }
   } catch (e) {
     console.error(e.message);
-    process.exit(1);  // eslint-disable-line n/no-process-exit
+    process.exit(1); // eslint-disable-line n/no-process-exit
   }
 })();

package/lib/config.js

@@ -1,47 +1,46 @@
-import rc from 'rc';
-
-export default rc('license-downloader', {
-
-  /*
-		full path to json file generated by 'license-report'
-    describing all packages to handle
-	*/
-  source: '',
-
-  /*
-    Download license files if true,
-    if false, only the paths of the license files are added to a copy
-    of the source file
-  */
-  download: false,
-
-  /*
-		target directory for downloaded license files;
-    on null or undefined a directory named 'licenses' in the directory of the
-    source is used
-	*/
-  licDir: null,
-
-  /*
-		Name of the environment variable holding the access token ('tokenEnvVar')
-    or the name of the file containing the token ('tokenFileEnvVar') for
-    accessing the github api for downloading the license files;
-    tokenFileEnvVar has precedence over tokenEnvVar
-    Example 1: export GITHUB_TOKEN=abcdefghi
-    and then: tokenEnvVar: 'GITHUB_TOKEN'
-    Example 2: export GITHUB_TOKEN=/run/secrets/github_pat.txt
-    content of file /run/secrets/github_pat.txt: abcdefghi
-    and then: tokenFileEnvVar: 'GITHUB_TOKEN_FILE'
-	*/
-  githubToken: {
-    tokenEnvVar: 'GITHUB_TOKEN',
-    tokenFileEnvVar: ''
-  },
-
-  /*
-		retry options for 'got'
-	*/
-  httpRetryOptions: {
-    maxAttempts: 3
-  }
-});
+import rc from 'rc';
+
+export default rc('license-downloader', {
+  /*
+		full path to json file generated by 'license-report'
+    describing all packages to handle
+	*/
+  source: '',
+
+  /*
+    Download license files if true,
+    if false, only the paths of the license files are added to a copy
+    of the source file
+  */
+  download: false,
+
+  /*
+		target directory for downloaded license files;
+    on null or undefined a directory named 'licenses' in the directory of the
+    source is used
+	*/
+  licDir: null,
+
+  /*
+		Name of the environment variable holding the access token ('tokenEnvVar')
+    or the name of the file containing the token ('tokenFileEnvVar') for
+    accessing the github api for downloading the license files;
+    tokenFileEnvVar has precedence over tokenEnvVar
+    Example 1: export GITHUB_TOKEN=abcdefghi
+    and then: tokenEnvVar: 'GITHUB_TOKEN'
+    Example 2: export GITHUB_TOKEN=/run/secrets/github_pat.txt
+    content of file /run/secrets/github_pat.txt: abcdefghi
+    and then: tokenFileEnvVar: 'GITHUB_TOKEN_FILE'
+	*/
+  githubToken: {
+    tokenEnvVar: 'GITHUB_TOKEN',
+    tokenFileEnvVar: '',
+  },
+
+  /*
+		retry options for 'got'
+	*/
+  httpRetryOptions: {
+    maxAttempts: 3,
+  },
+});

package/lib/filesystem-service.js

@@ -1,60 +1,62 @@
-import fs from 'fs';
-import path from '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
- */
-export const readJson = async (filePath) => {
-  if (!filePath) {
-    throw new Error('license-downloader must be called with a "--source <license-report-json-file>" parameter');
-  }
-
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`Source file '${filePath}' does not exist`);
-  }
-
-  const json = await jsonfile.readFile(filePath);
-  return json;
-}
-
-/**
- * Writes javascript object array as json string to file overwriting existing file
- * @param {object} json - object array to be written as json file
- * @param {string} filePath - full path to the output file to be generated
- */
-export const writeJson = async (json, filePath) =>  {
-  if (!filePath) {
-    throw new Error('No target filename defined');
-  }
-
-  await jsonfile.writeFile(filePath, json);
-}
-
-/**
- * Create directory for given path if not exist
- * @param {string} dirPath - full path of the directory
- */
-export const createDirIfNotExists = (dirPath) => {
-  if (!fs.existsSync(dirPath)) {
-    fs.mkdirSync(dirPath, { recursive: true });
-  }
-}
-
-/**
- * Create directory for given file if not exist
- * @param {string} fullFilename - full path to a file
- */
-export const createDirFromFilename = (fullFilename) => {
-  createDirIfNotExists(path.dirname(fullFilename));
-}
-
-export default {
-  readJson,
-  writeJson,
-  createDirIfNotExists,
-  createDirFromFilename
-};
+import fs from 'fs';
+import path from '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
+ */
+export const readJson = async (filePath) => {
+  if (!filePath) {
+    throw new Error(
+      'license-downloader must be called with a "--source <license-report-json-file>" parameter',
+    );
+  }
+
+  if (!fs.existsSync(filePath)) {
+    throw new Error(`Source file '${filePath}' does not exist`);
+  }
+
+  const json = await jsonfile.readFile(filePath);
+  return json;
+};
+
+/**
+ * Writes javascript object array as json string to file overwriting existing file
+ * @param {object} json - object array to be written as json file
+ * @param {string} filePath - full path to the output file to be generated
+ */
+export const writeJson = async (json, filePath) => {
+  if (!filePath) {
+    throw new Error('No target filename defined');
+  }
+
+  await jsonfile.writeFile(filePath, json);
+};
+
+/**
+ * Create directory for given path if not exist
+ * @param {string} dirPath - full path of the directory
+ */
+export const createDirIfNotExists = (dirPath) => {
+  if (!fs.existsSync(dirPath)) {
+    fs.mkdirSync(dirPath, { recursive: true });
+  }
+};
+
+/**
+ * Create directory for given file if not exist
+ * @param {string} fullFilename - full path to a file
+ */
+export const createDirFromFilename = (fullFilename) => {
+  createDirIfNotExists(path.dirname(fullFilename));
+};
+
+export default {
+  readJson,
+  writeJson,
+  createDirIfNotExists,
+  createDirFromFilename,
+};