wip

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

src/_helpers/mime.node.ts

@@ -21,35 +21,37 @@ import { parse as parsePath } from 'node:path'
 
 type MimeType = string
 
-const MIME_TEXT_PLAIN: MimeType = 'text/plain'
+const MIMETYPE_TEXT_PLAIN: MimeType = 'text/plain'
 
-const MAP_TEXT_EXTENSION_MIME: Readonly<Record<string, MimeType>> = {
-  '': MIME_TEXT_PLAIN,
+const MAP_TEXT_EXTENSION_MIMETYPE: Readonly<Record<string, MimeType>> = {
+  '': MIMETYPE_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,
+  '.txt': MIMETYPE_TEXT_PLAIN,
   '.rst': 'text/prs.fallenstein.rst',
   '.xml': 'text/xml', // not `application/xml` -- our scope is text!
+  // to be continued ... pullrequests welcome
   // add more mime types above this line. pull-requests welcome!
   // license-specific files
-  '.license': MIME_TEXT_PLAIN,
-  '.licence': MIME_TEXT_PLAIN
+  '.license': MIMETYPE_TEXT_PLAIN,
+  '.licence': MIMETYPE_TEXT_PLAIN,
 } as const
 
 const LICENSE_FILENAME_BASE = new Set(['licence', 'license'])
 const LICENSE_FILENAME_EXT = new Set([
   '.apache',
   '.bsd',
   '.gpl',
-  '.mit'
+  '.mit',
+  // to be continued ... pullrequests welcome
 ])
 
-export function getMimeForLicenseFile(filename: string): MimeType | undefined {
+export function getMimeTypeForLicenseFile(filename: string): MimeType | undefined {
   const {name, ext} = parsePath(filename.toLowerCase())
   return LICENSE_FILENAME_BASE.has(name) && LICENSE_FILENAME_EXT.has(ext)
-    ? MIME_TEXT_PLAIN
-    : MAP_TEXT_EXTENSION_MIME[ext]
+    ? MIMETYPE_TEXT_PLAIN
+    : MAP_TEXT_EXTENSION_MIMETYPE[ext]
 }

src/utils/licenseUtility.node.ts

@@ -20,7 +20,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 import type NATIVE_FS from 'node:fs'
 import type NATIVE_PATH from "node:path";
 
-import { getMimeForLicenseFile } from '../_helpers/mime.node'
+import { getMimeTypeForLicenseFile } from '../_helpers/mime.node'
 import { AttachmentEncoding } from '../enums/attachmentEncoding'
 import { Attachment } from '../models/attachment'
 
@@ -79,7 +79,7 @@ export class LicenseEvidenceFetcher {
         // Don't follow symlinks for security reasons!
         continue
       }
-      const contentType = getMimeForLicenseFile(file)
+      const contentType = getMimeTypeForLicenseFile(file)
       if (contentType === undefined) {
         continue
       }