Merge branch 'master' into feat/default-cdx1.6

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

CONTRIBUTING.md

@@ -18,7 +18,7 @@ This will install process automatically build the project from source.
 ## Build from source
 
 ```shell
-npm run build
+npm run build-dev
 ```
 
 ## Testing

HISTORY.md

@@ -8,9 +8,13 @@ All notable changes to this project will be documented in this file.
 
 * BREAKING changes
   * Option `specVersion` defaults to `"1.6"`, was `"1.4"` ([#1329] via [#1333])
+* Fixed
+  * Properly detect license evidences like `LICEN[CS]E.{Apache,BSD,GPL,MIT}` ([#1337] via [#1339])
 
 [#1329]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/issues/1329
 [#1333]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1333
+[#1337]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/issues/1337
+[#1339]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1339
 
 ## 3.15.0 - 2024-10-19
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyclonedx/webpack-plugin",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "description": "Creates CycloneDX Software Bill of Materials (SBoM) from webpack projects",
   "license": "Apache-2.0",
   "copyright": "Copyright OWASP Foundation",
@@ -96,9 +96,9 @@
     "prepublish": "npm run build",
     "prepublishOnly": "run-s -lc build setup-tests test",
     "lint": "tsc --noEmit",
-    "build": "run-p --aggregate-output -l 'build:*'",
-    "prebuild:node": "node -r fs -e 'fs.rmSync(\"dist\",{recursive:true,force:true})'",
-    "build:node": "tsc -b ./tsconfig.json",
+    "prebuild": "node -r fs -e 'fs.rmSync(\"dist\",{recursive:true,force:true})'",
+    "build": "tsc -b ./tsconfig.json",
+    "build-dev": "npm run -- build --sourceMap",
     "setup-tests": "node tests/integration/setup.js",
     "test": "run-p --aggregate-output -lc 'test:*'",
     "test:jest": "c8 jest",

src/_helpers.ts

@@ -18,7 +18,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
 import { existsSync, readFileSync } from 'fs'
-import { dirname, extname, isAbsolute, join, sep } from 'path'
+import { dirname, extname, isAbsolute, join, parse, sep } from 'path'
 
 export function isNonNullable<T> (value: T): value is NonNullable<T> {
   // NonNullable: not null and not undefined
@@ -92,18 +92,41 @@ export function loadJsonFile (path: string): any {
 
 export type MimeType = string
 
+const MIME_TEXT_PLAIN: MimeType = 'text/plain'
+
 const MAP_TEXT_EXTENSION_MIME: Readonly<Record<string, MimeType>> = {
-  '': 'text/plain',
-  '.license': 'text/plain',
-  '.licence': 'text/plain',
+  '': MIME_TEXT_PLAIN,
+  // https://www.iana.org/assignments/media-types/media-types.xhtml
+  '.csv': 'text/csv',
+  '.htm': 'text/html',
+  '.html': 'text/html',
   '.md': 'text/markdown',
+  '.txt': MIME_TEXT_PLAIN,
   '.rst': 'text/prs.fallenstein.rst',
-  '.txt': 'text/plain',
-  '.xml': 'text/xml' // not `application/xml` -- our scope is text!
+  '.xml': 'text/xml', // not `application/xml` -- our scope is text!
+  // add more mime types above this line. pull-requests welcome!
+  // license-specific files
+  '.license': MIME_TEXT_PLAIN,
+  '.licence': MIME_TEXT_PLAIN
 } as const
 
 export function getMimeForTextFile (filename: string): MimeType | undefined {
   return MAP_TEXT_EXTENSION_MIME[extname(filename).toLowerCase()]
 }
 
+const LICENSE_FILENAME_BASE = new Set(['licence', 'license'])
+const LICENSE_FILENAME_EXT = new Set([
+  '.apache',
+  '.bsd',
+  '.gpl',
+  '.mit'
+])
+
+export function getMimeForLicenseFile (filename: string): MimeType | undefined {
+  const { name, ext } = parse(filename.toLowerCase())
+  return LICENSE_FILENAME_BASE.has(name) && LICENSE_FILENAME_EXT.has(ext)
+    ? MIME_TEXT_PLAIN
+    : MAP_TEXT_EXTENSION_MIME[ext]
+}
+
 // endregion MIME

src/extractor.ts

@@ -23,7 +23,7 @@ import * as normalizePackageJson from 'normalize-package-data'
 import { dirname, join } from 'path'
 import type { Compilation, Module } from 'webpack'
 
-import { getMimeForTextFile, getPackageDescription, isNonNullable, type PackageDescription, structuredClonePolyfill } from './_helpers'
+import { getMimeForLicenseFile, getPackageDescription, isNonNullable, type PackageDescription, structuredClonePolyfill } from './_helpers'
 
 type WebpackLogger = Compilation['logger']
 
@@ -148,7 +148,7 @@ export class Extractor {
         continue
       }
 
-      const contentType = getMimeForTextFile(pci.name)
+      const contentType = getMimeForLicenseFile(pci.name)
       if (contentType === undefined) {
         continue
       }