linting

Author: ndbroadbent

.prettierignore

@@ -1,10 +1,12 @@
+# Don't need to check Ruby / RBI files
+sorbet/
+tasks/
+
 site/.next
 site/out
 
-# Keep this formatting since it's more concise
 site/lib/log-generation/sample-data.ts
-
-# Don't format generated files
+site/lib/log-generation/log-keys.json
 site/lib/log-generation/log-types.ts
 site/public/coverage
 site/public/yard

site/app/docs/integrations/page.tsx

@@ -64,7 +64,9 @@ export default function IntegrationsPage() {
         events with detailed information about the job.
       </p>
 
-      <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.ACTIVEJOB))}</CodeBlock>
+      <CodeBlock language="json">
+        {formatLog(logGenerator.generateLog(LogType.ACTIVEJOB))}
+      </CodeBlock>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">Sidekiq Integration</h2>
       <p className="text-neutral-600 dark:text-neutral-400 mb-4">
@@ -107,7 +109,9 @@ export default function IntegrationsPage() {
       <RubyCodeExample name="lograge_custom_options" />
 
       <div className="mt-4">
-        <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.REQUEST))}</CodeBlock>
+        <CodeBlock language="json">
+          {formatLog(logGenerator.generateLog(LogType.REQUEST))}
+        </CodeBlock>
       </div>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">Shrine Integration</h2>
@@ -116,15 +120,19 @@ export default function IntegrationsPage() {
         other Shrine operations, including file metadata and operation duration.
       </p>
 
-      <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.SHRINE))}</CodeBlock>
+      <CodeBlock language="json">
+        {formatLog(logGenerator.generateLog(LogType.SHRINE))}
+      </CodeBlock>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">CarrierWave Integration</h2>
       <p className="text-neutral-600 dark:text-neutral-400 mb-4">
         Similar to the Shrine integration, the CarrierWave integration adds
         structured logging for file upload operations.
       </p>
 
-      <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.CARRIERWAVE))}</CodeBlock>
+      <CodeBlock language="json">
+        {formatLog(logGenerator.generateLog(LogType.CARRIERWAVE))}
+      </CodeBlock>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">
         ActiveStorage Integration
@@ -135,7 +143,9 @@ export default function IntegrationsPage() {
         storage service.
       </p>
 
-      <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.ACTIVESTORAGE))}</CodeBlock>
+      <CodeBlock language="json">
+        {formatLog(logGenerator.generateLog(LogType.ACTIVESTORAGE))}
+      </CodeBlock>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">Rack Error Handler</h2>
       <p className="text-neutral-600 dark:text-neutral-400 mb-4">
@@ -157,7 +167,9 @@ export default function IntegrationsPage() {
         potential security issues.
       </p>
 
-      <CodeBlock language="json">{formatLog(logGenerator.generateLog(LogType.SECURITY))}</CodeBlock>
+      <CodeBlock language="json">
+        {formatLog(logGenerator.generateLog(LogType.SECURITY))}
+      </CodeBlock>
 
       <h2 className="text-2xl font-bold mt-10 mb-4">Sorbet Integration</h2>
       <p className="text-neutral-600 dark:text-neutral-400 mb-4">
@@ -172,7 +184,7 @@ export default function IntegrationsPage() {
           <TabsTrigger value="config">Configuration</TabsTrigger>
           <TabsTrigger value="error">Type Error Example</TabsTrigger>
         </TabsList>
-        
+
         <TabsContent value="config">
           <div className="rounded-lg bg-neutral-100 p-4 dark:bg-neutral-900">
             <CodeBlock language="ruby" unwrapped={true}>
@@ -187,7 +199,7 @@ config.integrations.enable_sorbet_error_handlers = true
             </CodeBlock>
           </div>
         </TabsContent>
-        
+
         <TabsContent value="error">
           <div className="rounded-lg bg-neutral-100 p-4 dark:bg-neutral-900">
             <CodeBlock language="json" unwrapped={true}>

site/components/code-block.tsx

@@ -71,9 +71,7 @@ export function CodeBlock({
       {title && (
         <div className="font-medium text-sm mb-2 text-gray-700">{title}</div>
       )}
-      <div className="overflow-hidden rounded-lg">
-        {highlighter}
-      </div>
+      <div className="overflow-hidden rounded-lg">{highlighter}</div>
     </div>
   );
 }

site/components/log-scroller.tsx

@@ -28,7 +28,7 @@ export function LogScroller() {
       .replace(/(\w"):/g, '$1: ')
       .replace(/({)(?!})/g, '$1 ') // Add space after opening brace only if not followed by closing brace
       .replace(/(?<!{)(})/g, ' $1') // Add space before closing brace only if not preceded by opening brace
-      .replace(/\{\s+\}/g, '{}');   // Remove spaces between empty braces
+      .replace(/\{\s+\}/g, '{}'); // Remove spaces between empty braces
 
     return jsonStr;
   }, []);

site/lib/__tests__/codeExamples.test.ts

@@ -62,24 +62,25 @@ describe('Code Examples Integration', () => {
   it('should provide list of all example IDs', () => {
     const ids = getAllExampleIds();
     expect(ids.length).toBeGreaterThan(0);
-    
+
     // A few key examples that should be found
     expect(ids).toContain('rails_initializer');
     expect(ids).toContain('basic_configuration');
     expect(ids).toContain('custom_string_scrubber');
   });
-  
+
   it('should preserve indentation in code examples relative to first line', () => {
     // Check a real example to see if it's properly unindented
     const example = getCodeExample('basic_configuration');
     expect(example).not.toBeNull();
-    
+
     // Split the code into lines
     const lines = example.code.split('\n');
-    
+
     // This should be true: comment line at first level, code line at first level
     // The actual indentation after unindenting should preserve the relative structure
-    expect(lines[0]).toBe('# Configure LogStruct with a block');
-    expect(lines[1]).toBe('LogStruct.configure do |config|');
+    expect(lines[0]).toBe('LogStruct.configure do |config|');
+    expect(lines[1]).toBe('');
+    expect(lines[2]).toBe('  # your configuration here');
   });
 });

site/lib/codeExamples.ts

@@ -22,26 +22,26 @@ const RELOAD_INTERVAL_MS = 1000; // 1 second
 function unindentCode(code: string): string {
   // Split into lines for processing
   const lines = code.split('\n');
-  
+
   // Find non-empty lines to determine minimum indentation
-  const nonEmptyLines = lines.filter(line => line.trim().length > 0);
+  const nonEmptyLines = lines.filter((line) => line.trim().length > 0);
   if (!nonEmptyLines.length) return code;
-  
+
   // Calculate the minimum indentation across all non-empty lines
-  const indentSizes = nonEmptyLines.map(line => {
+  const indentSizes = nonEmptyLines.map((line) => {
     const match = line.match(/^(\s*)/);
     return match ? match[1].length : 0;
   });
-  
+
   const minIndent = Math.min(...indentSizes);
-  
+
   // If no common indentation found, return the original code
   if (minIndent === 0) return code;
-  
+
   // Remove the common indentation from each line, but only if the line
   // has enough characters to avoid cutting into content
   return lines
-    .map(line => {
+    .map((line) => {
       // Only remove indentation from non-empty lines
       if (line.trim().length === 0) return line;
       // Only remove up to the amount of leading whitespace
@@ -75,10 +75,10 @@ export function extractCodeExample(content: string, id: string): string | null {
 
   // Extract the code between markers without trimming (leading spaces are important)
   const extractedCode = contentAfterStart.slice(0, endMatch.index);
-  
+
   // Remove empty lines at the beginning and end
   const trimmedCode = extractedCode.replace(/^\s*\n/, '').replace(/\s*$/, '');
-  
+
   // Unindent the code by removing consistent whitespace from the left
   return unindentCode(trimmedCode);
 }
@@ -144,11 +144,11 @@ export function loadCodeExamples(): Record<string, CodeExample> {
  */
 function ensureExamplesLoaded(): void {
   const isDevelopment = process.env.NODE_ENV === 'development';
-  
+
   // In development, reload periodically
   if (isDevelopment && Date.now() - lastLoadTime > RELOAD_INTERVAL_MS) {
     loadCodeExamples();
-  } 
+  }
   // In production or if not loaded yet, load once
   else if (Object.keys(CODE_EXAMPLES).length === 0) {
     loadCodeExamples();
@@ -164,7 +164,9 @@ export function getCodeExample(id: string): CodeExample {
   ensureExamplesLoaded();
   const example = CODE_EXAMPLES[id];
   if (!example) {
-    throw new Error(`Code example not found: "${id}". Make sure this example exists in the examples directory.`);
+    throw new Error(
+      `Code example not found: "${id}". Make sure this example exists in the examples directory.`,
+    );
   }
   return example;
 }

site/lib/log-generation/log-generator.ts

@@ -34,7 +34,7 @@ export class LogGenerator extends RandomDataGenerator {
    */
   transformLog(log: Partial<Log>): Record<string, any> {
     const transformedLog: Record<string, any> = {};
-    
+
     // Process each field in the log
     Object.entries(log).forEach(([propertyName, value]) => {
       const jsonKey = (logKeysMap as Record<string, string>)[propertyName];
@@ -46,7 +46,7 @@ export class LogGenerator extends RandomDataGenerator {
         transformedLog[propertyName] = value;
       }
     });
-    
+
     return transformedLog;
   }
 
@@ -62,7 +62,7 @@ export class LogGenerator extends RandomDataGenerator {
       // Security logs are often warnings or errors
       level = Math.random() > 0.3 ? LogLevel.WARN : LogLevel.ERROR;
     }
-    
+
     // Create a log with common fields
     const log: Partial<Log> = {
       timestamp: new Date().toISOString(),
@@ -105,7 +105,7 @@ export class LogGenerator extends RandomDataGenerator {
   generateLog(logType: LogType): Record<string, any> {
     // Generate a typed log then transform it
     const typedLog = this.generateTypedLog(logType);
-    
+
     // Transform property names to JSON keys
     return this.transformLog(typedLog);
   }

tools/log_types_exporter.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+# cspell:ignore _tnilable
+
 # Load LogStruct type definitions
 require_relative "../lib/log_struct"
 
@@ -39,31 +41,31 @@ def export
         File.write(@output_ts_file, content)
 
         puts "Exported log types to #{@output_ts_file}"
-        
+
         # Export LOG_KEYS mapping to JSON
         export_keys_to_json
       end
-      
+
       # Export LOG_KEYS mapping to a JSON file
       sig { params(output_json_file: T.nilable(String)).void }
       def export_keys_to_json(output_json_file = nil)
         # Default to the same directory as the TypeScript file
         output_json_file ||= File.join(File.dirname(@output_ts_file), "log-keys.json")
-        
+
         puts "Exporting LogStruct key mappings to JSON..."
         puts "Output file: #{output_json_file}"
-        
+
         # Create output directory if needed
         FileUtils.mkdir_p(File.dirname(output_json_file))
-        
+
         # Convert LOG_KEYS to a format suitable for JSON
         # - Convert keys from symbols to strings
         # - Convert values from symbols to strings
         json_keys = LogStruct::LOG_KEYS.transform_keys(&:to_s).transform_values(&:to_s)
-        
+
         # Write to file with pretty formatting
         File.write(output_json_file, JSON.pretty_generate(json_keys))
-        
+
         puts "Exported key mappings to #{output_json_file}"
       end
 
@@ -208,9 +210,9 @@ def extract_type_info(prop_info)
         # puts "Extracting type info for: #{type_str}"
         # puts "Array key present? #{prop_info.key?(:array)}" if prop_info.key?(:array)
         # puts "Array value: #{prop_info[:array]}" if prop_info.key?(:array)
-        
+
         # Check for TypedHash specifically (handles metadata field correctly)
-        if type_obj.is_a?(T::Types::TypedHash) || type_obj.class.name == "T::Types::TypedHash"
+        if type_obj.is_a?(T::Types::TypedHash) || type_obj.instance_of?(::T::Types::TypedHash)
           return {optional: prop_info[:_tnilable] || false, type: "object"}
         end