Merge pull request #637 from TobyAndToby/copilot/fix-635

Fix omitVersions config parsing and documentation

Author: tobysmith568

README.md

@@ -89,7 +89,7 @@ E.g. `.glf.json`, `.glfrc.yml`, `.generatelicensefile.jsonc`, `.config/glf.js`,
   "exclude": ["your-package", "[email protected]", "/.*prettier.*/i"],
 
   // Omit the version number in the output file
-  "omitVersion": false
+  "omitVersions": false
 }
 ```
 

e2e/config-file/test/cli/append/append.e2e.spec.ts

@@ -6,7 +6,6 @@ import { output as outputFileName } from "./config.js";
 const execAsync = promisify(exec);
 
 describe("cli", () => {
-  beforeEach(async () => {});
 
   it("should match snapshot when content is appended", async () => {
     const configPath = "./test/cli/append/config.js";

e2e/config-file/test/cli/exclude/exclude.e2e.spec.ts

@@ -6,7 +6,6 @@ import { output as outputFileName } from "./config.js";
 const execAsync = promisify(exec);
 
 describe("cli", () => {
-  beforeEach(async () => {});
 
   it("should match snapshot when content is excluded", async () => {
     const configPath = "./test/cli/exclude/config.js";

e2e/config-file/test/cli/inputs-output/inputs-output.e2e.spec.ts

@@ -6,7 +6,6 @@ import { output as outputFileName } from "./config.js";
 const execAsync = promisify(exec);
 
 describe("cli", () => {
-  beforeEach(async () => {});
 
   it("should match snapshot when inputs and outputs are provided via config file", async () => {
     const configPath = "./test/cli/inputs-output/config.js";

e2e/config-file/test/cli/omit-versions/__snapshots__/omit-versions.e2e.spec.ts.snap

@@ -0,0 +1,73 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`cli should omit versions when omitVersions is true in config 1`] = `
+"This file was generated with the generate-license-file npm package!
+https://www.npmjs.com/package/generate-license-file
+
+The following npm package may be included in this product:
+
+ - dep-four
+
+This package contains the following license:
+
+# Dep Four
+
+This license file is spelt \`LICENCE\`.
+This license should be found.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - dep-one
+
+This package contains the following license:
+
+# Dep One
+
+This license file is spelt \`LICENSE.md\`.
+This license should be found.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - dep-three
+
+This package contains the following license:
+
+# Dep Three
+
+This license file is spelt \`LICENSE\`.
+This license should be found.
+
+-----------
+
+The following npm packages may be included in this product:
+
+ - dep-two
+ - dep-two-duplicate
+
+These packages each contain the following license:
+
+# Dep Two
+
+This license file is spelt \`LICENCE.md\`.
+This license should be found.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - dep-five
+
+This package contains the following license:
+
+MIT
+
+-----------
+
+This file was generated with the generate-license-file npm package!
+https://www.npmjs.com/package/generate-license-file
+"
+`;

e2e/config-file/test/cli/omit-versions/config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  inputs: ["./package.json"],
+  output: "omit-versions-config-output.txt",
+
+  // Test that versions are omitted from the output file.
+  omitVersions: true,
+};

e2e/config-file/test/cli/omit-versions/omit-versions.e2e.spec.ts

@@ -0,0 +1,27 @@
+import { exec } from "child_process";
+import fs from "fs/promises";
+import { promisify } from "util";
+import { output as outputFileName } from "./config.js";
+
+const execAsync = promisify(exec);
+
+describe("cli", () => {
+
+  it("should omit versions when omitVersions is true in config", async () => {
+    const configPath = "./test/cli/omit-versions/config.js";
+
+    await execAsync(`npx generate-license-file -c ${configPath}`);
+
+    const result = await fs.readFile(outputFileName, "utf8");
+
+    // Check that the output doesn't contain version numbers
+    // Should not contain patterns like "@1.0.0" or "[email protected]"
+    expect(result).not.toMatch(/@\d+\.\d+\.\d+/);
+
+    // Should contain package names without versions
+    expect(result).toMatch(/dep-one/);
+    expect(result).toMatchSnapshot();
+
+    await fs.unlink(outputFileName);
+  });
+});

e2e/config-file/test/cli/replacement/replacement.e2e.spec.ts

@@ -6,7 +6,6 @@ import { output as outputFileName } from "./config.js";
 const execAsync = promisify(exec);
 
 describe("cli", () => {
-  beforeEach(async () => {});
 
   it("should match snapshot when a package is replaced", async () => {
     const configPath = "./test/cli/replacement/config.js";

src/packages/generate-license-file/README.md

@@ -89,7 +89,7 @@ E.g. `.glf.json`, `.glfrc.yml`, `.generatelicensefile.jsonc`, `.config/glf.js`,
   "exclude": ["your-package", "[email protected]", "/.*prettier.*/i"],
 
   // Omit the version number in the output file
-  "omitVersion": false
+  "omitVersions": false
 }
 ```
 

src/packages/generate-license-file/src/lib/cli/config/schema.ts

@@ -19,6 +19,7 @@ export const configSchema = z
     replace: z.record(z.string().nonempty(), z.string().nonempty()).optional(),
     exclude: z.string().nonempty().array().optional(),
     append: z.string().nonempty().array().optional(),
+    omitVersions: z.boolean().optional(),
   })
   .optional();