Fix docs (#38)

walmsles · web-flow · commit 85181e019a65 · 2025-05-24T12:54:41.000+10:00
* fix(markdown): remove lint errors and fix AI hallucinations

* fix(docs): add copyright headers for slsdna
diff --git a/AmazonQ.md b/AmazonQ.md
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,21 @@
-Copyright 2025 Michael Walmsley
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -120,4 +120,6 @@ The output is a bundled file which enables Node installed in windows to run the
 
 ## License
 
-MIT
+MIT License
+
+Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
diff --git a/src/config/cache.ts b/src/config/cache.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Cache configuration for the fetch service
  */
diff --git a/src/config/web.ts b/src/config/web.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * The Powertools config 
  */
diff --git a/src/docFetcher.ts b/src/docFetcher.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { createHash } from 'crypto';
 import * as path from 'path';
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { logger } from "./services/logger/index";
 import { fetchDocPage } from "./docFetcher";
 import { searchDocuments, SearchIndexFactory } from "./searchIndex";
diff --git a/src/searchIndex.ts b/src/searchIndex.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { fetchService } from './services/fetch';
 import { ContentType } from './services/fetch/types';
 import { logger } from './services/logger';
diff --git a/src/services/fetch/cacheManager.ts b/src/services/fetch/cacheManager.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Cache Manager for handling file system operations related to caching
  */
diff --git a/src/services/fetch/fetch.ts b/src/services/fetch/fetch.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Fetch Service wrapped around "make-fetch-happen" module.
  * 
diff --git a/src/services/fetch/index.ts b/src/services/fetch/index.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Export the FetchService and related types from the fetch module
  */
diff --git a/src/services/fetch/types.ts b/src/services/fetch/types.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Represents different content types for the fetch service
  */
diff --git a/src/services/logger/fileManager.ts b/src/services/logger/fileManager.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
diff --git a/src/services/logger/formatter.ts b/src/services/logger/formatter.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import * as fs from 'fs';
 import { Transform } from 'stream';
 
diff --git a/src/services/logger/index.ts b/src/services/logger/index.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { Logger } from './logger';
 
 // Export the singleton instance
diff --git a/src/services/logger/logger.ts b/src/services/logger/logger.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { LogFileManager } from './fileManager';
 import { createFormattedFileStream } from './formatter';
 
diff --git a/src/services/markdown/converterFactory.ts b/src/services/markdown/converterFactory.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { NodeHtmlMarkdownConverter } from './nodeHtmlMarkdownConverter';
 import { HtmlToMarkdownConverter } from './types';
 
diff --git a/src/services/markdown/index.ts b/src/services/markdown/index.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 export * from './converterFactory';
 export * from './nodeHtmlMarkdownConverter';
 export * from './types';
diff --git a/src/services/markdown/nodeHtmlMarkdownConverter.ts b/src/services/markdown/nodeHtmlMarkdownConverter.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 import { HtmlToMarkdownConverter } from './types';
 
 import * as cheerio from 'cheerio';
@@ -11,28 +16,40 @@ export class NodeHtmlMarkdownConverter implements HtmlToMarkdownConverter {
   
   constructor() {
     const options: NodeHtmlMarkdownOptions = {
-      // Base configuration
-      headingStyle: 'atx',
+      preferNativeParser: false,
       codeBlockStyle: 'fenced',
+      codeFence: '```',
       bulletMarker: '*',
       emDelimiter: '*',
       strongDelimiter: '**',
-      
-      // Custom element handlers
-      customCodeBlockHandler: (element) => {
-        // Extract language from class attribute
-        const className = element.getAttribute('class') || '';
-        const language = className.match(/language-(\w+)/)?.[1] || '';
-        
-        // Get the code content
-        const content = element.textContent || '';
-        
-        // Return formatted code block
-        return `\n\`\`\`${language}\n${content}\n\`\`\`\n\n`;
-      }
+      strikeDelimiter: '~~',
+      maxConsecutiveNewlines: 3,
+      lineStartEscape: [/^(\s*)([-*+]|\d+\.)(\s)/, '$1\\$2$3'] as [RegExp, string],
+      globalEscape: [/[\\`*_~[\]]/g, '\\$&'] as [RegExp, string]
     };
     
-    this.nhm = new NodeHtmlMarkdown(options);
+    // Create instance with custom translator for code blocks
+    this.nhm = new NodeHtmlMarkdown(
+      options,
+      {
+        'pre': {
+          postprocess: (ctx) => {
+            const codeElement = ctx.node.querySelector('code');
+            if (!codeElement) return ctx.content;
+
+            // Extract language from class attribute
+            const className = codeElement.getAttribute('class') || '';
+            const language = className.match(/language-(\w+)/)?.[1] || '';
+            
+            // Get the code content
+            const content = codeElement.textContent || '';
+            
+            // Return formatted code block
+            return `\n\`\`\`${language}\n${content}\n\`\`\`\n\n`;
+          }
+        }
+      }
+    );
   }
   
   /**
diff --git a/src/services/markdown/types.ts b/src/services/markdown/types.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 /**
  * Interface for HTML-to-markdown conversion
  */
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 declare module 'html-to-markdown' {
   export function htmlToMarkdown(html: string): string;
 }
diff --git a/src/types/make-fetch-happen.d.ts b/src/types/make-fetch-happen.d.ts
@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com
+ * Licensed under the MIT License.
+ */
+
 // src/types/make-fetch-happen.d.ts
 declare module 'make-fetch-happen' {
     export interface Headers {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,8 @@`
	`1`	`+/**`
	`2`	`+ * Copyright (c) 2025 Michael Walmsley, ServerlessDNA.com`
	`3`	`+ * Licensed under the MIT License.`
	`4`	`+ */`
	`5`	`+`
`1`	`6`	`/**`
`2`	`7`	`* Fetch Service wrapped around "make-fetch-happen" module.`
`3`	`8`	`*`