feat: Rename AI Context Convention to Codebase Context Specification

Author: killerapp

CODEBASE-CONTEXT.md

@@ -464,8 +464,8 @@ documentation:
 
 ## 9. Conclusion
 
-The AI Context Convention provides a flexible, standardized approach to enriching codebases with contextual information for AI models. By adopting this convention and including role-specific information, development teams can enhance AI-assisted workflows, improving code quality and development efficiency across projects of any scale or complexity. The addition of role-specific guidelines and consistent naming conventions ensures that AI models have access to comprehensive, relevant, and well-structured information tailored to different aspects of the software development lifecycle.
+The Codebase Context Specification provides a flexible, standardized approach to enriching codebases with contextual information for AI models. By adopting this convention and including role-specific information, development teams can enhance AI-assisted workflows, improving code quality and development efficiency across projects of any scale or complexity. The addition of role-specific guidelines and consistent naming conventions ensures that AI models have access to comprehensive, relevant, and well-structured information tailored to different aspects of the software development lifecycle.
 
 ## 10. TypeScript Linter Implementation
 
-For details on the TypeScript implementation of the linter for validating AI Context Convention files, please refer to the [TypeScript Linter README](linters/typescript/README.md).
+For details on the TypeScript implementation of the linter for validating Codebase Context Specification files, please refer to the [TypeScript Linter README](linters/typescript/README.md).

linters/.context.md

@@ -1,16 +1,16 @@
 ---
-module-name: AI Context Convention Linters
+module-name: Codebase Context Specification Linters
 related-modules:
   - ../examples
 version: 1.0.0
-description: Contains linting tools for validating AI Context Convention files
+description: Contains linting tools for validating Codebase Context Specification files
 diagrams: []
 technologies:
   - Python
   - TypeScript
 conventions:
   - Follow language-specific best practices
-  - Adhere to AI Context Convention Specification
+  - Adhere to Codebase Context Specification
 directives:
   - Ensure consistency between different language implementations
   - Write clear, well-documented code
@@ -32,7 +32,7 @@ business-requirements:
     - Validate structure of context files
     - Ensure required fields are present
     - Check for proper YAML frontmatter in Markdown files
-  target-audience: Developers using the AI Context Convention
+  target-audience: Developers using the Codebase Context Specification
   success-metrics:
     - Consistency of linting results across languages
     - Adoption rate among project contributors
@@ -51,7 +51,7 @@ deployment:
 
 # Linters Directory
 
-This directory contains linting tools for validating AI Context Convention files in different programming languages. The linters ensure that context files adhere to the specification and provide consistent, high-quality contextual information for AI-assisted development.
+This directory contains linting tools for validating Codebase Context Specification files in different programming languages. The linters ensure that context files adhere to the specification and provide consistent, high-quality contextual information for AI-assisted development.
 
 ## Contents
 
@@ -67,9 +67,9 @@ Each language-specific subdirectory contains its own linter implementation. Refe
 When contributing to or modifying the linters:
 
 1. Ensure consistency between different language implementations
-2. Follow the AI Context Convention Specification strictly
+2. Follow the Codebase Context Specification strictly
 3. Write clear, well-documented code
 4. Include appropriate error messages and logging for easier debugging
 5. Add unit tests for any new functionality or bug fixes
 
-Please refer to the main README.md file in the project root for more detailed contribution guidelines and the full specification of the AI Context Convention.
+Please refer to the main README.md file in the project root for more detailed contribution guidelines and the full specification of the Codebase Context Specification.

linters/python/.context.md

@@ -1,9 +1,9 @@
 ---
-module-name: Python Linter for AI Context Convention
+module-name: Python Linter for Codebase Context Specification
 related-modules:
   - ../typescript
 version: 0.0.1
-description: Python implementation of the AI Context Convention linter (placeholder)
+description: Python implementation of the Codebase Context Specification linter (placeholder)
 project-type: Linter
 diagrams: []
 technologies:
@@ -35,8 +35,8 @@ business-requirements:
     - Validate structure of context files
     - Ensure required fields are present
     - Check for proper YAML frontmatter in Markdown files
-    - Verify content adheres to AI Context Convention Specification
-  target-audience: Developers using the AI Context Convention
+    - Verify content adheres to Codebase Context Specification
+  target-audience: Developers using the Codebase Context Specification
   success-metrics:
     - Consistency with TypeScript linter results
     - Performance on large codebases
@@ -54,13 +54,13 @@ deployment:
 
 ---
 
-# Python Linter for AI Context Convention (Placeholder)
+# Python Linter for Codebase Context Specification (Placeholder)
 
-This directory is currently a placeholder for the future Python implementation of the linter for validating AI Context Convention files.
+This directory is currently a placeholder for the future Python implementation of the linter for validating Codebase Context Specification files.
 
 ## Current Status
 
-The Python linter is not yet implemented. This module serves as a placeholder to indicate the planned development of a Python-based linter for the AI Context Convention.
+The Python linter is not yet implemented. This module serves as a placeholder to indicate the planned development of a Python-based linter for the Codebase Context Specification.
 
 ## Planned Functionality
 
@@ -69,7 +69,7 @@ Once implemented, the Python linter is expected to perform the following checks:
 1. Validate the structure of context files (.context.md, .context.yaml, and .context.json)
 2. Ensure required fields are present
 3. Check for proper YAML frontmatter in Markdown files
-4. Verify that content adheres to the AI Context Convention Specification
+4. Verify that content adheres to the Codebase Context Specification
 
 ## Future Development Guidelines
 
@@ -88,4 +88,4 @@ When the Python linter is developed, it should:
 3. Create a detailed implementation plan
 4. Begin development following the project's coding standards and best practices
 
-Refer to the main README.md in the project root for the full AI Context Convention Specification and contribution guidelines.
+Refer to the main README.md in the project root for the full Codebase Context Specification and contribution guidelines.

linters/typescript/.context.md

@@ -1,9 +1,9 @@
 ---
-module-name: TypeScript Linter for AI Context Convention
+module-name: TypeScript Linter for Codebase Context Specification
 related-modules:
   - ../python
 version: 1.0.0
-description: TypeScript implementation of the AI Context Convention linter
+description: TypeScript implementation of the Codebase Context Specification linter
 project-type: Linter
 diagrams: []
 technologies:
@@ -38,8 +38,8 @@ business-requirements:
     - Validate structure of context files
     - Ensure required fields are present
     - Check for proper YAML frontmatter in Markdown files
-    - Verify content adheres to AI Context Convention Specification
-  target-audience: Developers using the AI Context Convention
+    - Verify content adheres to Codebase Context Specification
+  target-audience: Developers using the Codebase Context Specification
   success-metrics:
     - Accuracy of linting results
     - Performance on large codebases
@@ -56,9 +56,9 @@ deployment:
   production-environment: npm public registry
 ---
 
-# TypeScript Linter for AI Context Convention
+# TypeScript Linter for Codebase Context Specification
 
-This directory contains the TypeScript implementation of the linter for validating AI Context Convention files.
+This directory contains the TypeScript implementation of the linter for validating Codebase Context Specification files.
 
 ## Main Components
 
@@ -71,7 +71,7 @@ The TypeScript linter performs the following checks:
 1. Validates the structure of context files
 2. Ensures required fields are present
 3. Checks for proper YAML frontmatter in Markdown files
-4. Verifies the content adheres to the AI Context Convention Specification
+4. Verifies the content adheres to the Codebase Context Specification
 
 ## Usage
 
@@ -92,4 +92,4 @@ When working on the TypeScript linter:
 4. Keep the linter consistent with the Python implementation
 5. Update comments and documentation as necessary
 
-Refer to the main README.md in the project root for the full AI Context Convention Specification and contribution guidelines.
+Refer to the main README.md in the project root for the full Codebase Context Specification and contribution guidelines.

linters/typescript/CHANGELOG.md

@@ -18,18 +18,18 @@
 
 ### Features
 
-* Add AI Context Convention specification and linter implementation ([a760aac](https://github.com/Agentic-Insights/codebase-context-spec/commit/a760aac075231a30fbc9e100a6305397840657f7))
+* Add Codebase Context Specification and linter implementation ([a760aac](https://github.com/Agentic-Insights/codebase-context-spec/commit/a760aac075231a30fbc9e100a6305397840657f7))
 * Add Codebase Context Specification (CCS) convention ([781eb1d](https://github.com/Agentic-Insights/codebase-context-spec/commit/781eb1d36ad1eaf48612f6b552f1aac8c2a45d57))
 * Add LICENSE.md file ([88a5b07](https://github.com/Agentic-Insights/codebase-context-spec/commit/88a5b074e4322fe9ed37a54d42d4f74df39b20af))
 * Add linting for .contextdocs.md and .contextignore files ([7c49a7f](https://github.com/Agentic-Insights/codebase-context-spec/commit/7c49a7f8ff366be6d16ab85a1511a4b9c9ff5d83))
-* Add PUBLISH.md for publishing the AI Context Convention Linter to npm ([8ea8513](https://github.com/Agentic-Insights/codebase-context-spec/commit/8ea85136f3f2c2b8ad0b8429af00c33cc0f8c8c0))
+* Add PUBLISH.md for publishing the Codebase Context Specification Linter to npm ([8ea8513](https://github.com/Agentic-Insights/codebase-context-spec/commit/8ea85136f3f2c2b8ad0b8429af00c33cc0f8c8c0))
 * Add release workflow and configuration ([903543c](https://github.com/Agentic-Insights/codebase-context-spec/commit/903543ca329ef5b18c28f738d8f34953250bbeb2))
 * Add tooling recommendations and future directions sections ([1dd204d](https://github.com/Agentic-Insights/codebase-context-spec/commit/1dd204df0dc5f00efb773d37fc45d31d94495263))
-* Add TypeScript linter for AI Context Convention files ([3d8d081](https://github.com/Agentic-Insights/codebase-context-spec/commit/3d8d0817907de1ac63359ca762b61d687299e71e))
+* Add TypeScript linter for Codebase Context Specification files ([3d8d081](https://github.com/Agentic-Insights/codebase-context-spec/commit/3d8d0817907de1ac63359ca762b61d687299e71e))
 * Bump version to 0.0.3 ([a056c13](https://github.com/Agentic-Insights/codebase-context-spec/commit/a056c13177a0f0162abf2a78f5c149b0ebc99c4b))
 * Bump version to 0.0.4 ([a223d1e](https://github.com/Agentic-Insights/codebase-context-spec/commit/a223d1ea4c0ae878293d38bad33e156ab2339c9c))
 * Bump version to 0.0.6 ([98a2d30](https://github.com/Agentic-Insights/codebase-context-spec/commit/98a2d305f24cd7b6558a9b4c4b167e765d9d2b96))
-* Expand AI Context Convention with role-specific sections ([b5a9197](https://github.com/Agentic-Insights/codebase-context-spec/commit/b5a9197d096101c425968008919dba45bc3a5f0f))
+* Expand Codebase Context Specification with role-specific sections ([b5a9197](https://github.com/Agentic-Insights/codebase-context-spec/commit/b5a9197d096101c425968008919dba45bc3a5f0f))
 * Implement markdown, YAML, and JSON file linting ([ba514f8](https://github.com/Agentic-Insights/codebase-context-spec/commit/ba514f8a651445c33c988f7d2d08365256a02f2b))
 * Improve README formatting and add icons ([f2a96d2](https://github.com/Agentic-Insights/codebase-context-spec/commit/f2a96d29bb28da224f7dc87524fe21c99c991ca4))
 * new specification for codebase context ([af17b2b](https://github.com/Agentic-Insights/codebase-context-spec/commit/af17b2be8ddfe045587ed4c1951437eceb79c119))

linters/typescript/PUBLISH.md

@@ -1,4 +1,4 @@
-# Publishing AI Context Convention Linter to npm
+# Publishing Codebase Context Specification Linter to npm
 
 ## Publish via semantic-release
 

linters/typescript/src/context_linter.ts

@@ -59,43 +59,56 @@ export class ContextLinter {
 
   private async lintContextFile(filePath: string): Promise<void> {
     console.log(`\nLinting file: ${filePath}`);
-    await lintFileIfExists(filePath, (fileContent) => {
+    await lintFileIfExists(filePath, async (fileContent) => {
+      let isValid = false;
       if (filePath.endsWith('.context.md')) {
-        this.lintMarkdownFile(fileContent);
+        isValid = await this.lintMarkdownFile(fileContent);
       } else if (filePath.endsWith('.context.yaml')) {
-        this.lintYamlFile(fileContent);
+        isValid = await this.lintYamlFile(fileContent);
       } else if (filePath.endsWith('.context.json')) {
-        this.lintJsonFile(fileContent);
+        isValid = await this.lintJsonFile(fileContent);
       }
+      this.printValidationResult(isValid, filePath);
     });
   }
 
-  private lintMarkdownFile(content: string): void {
+  private printValidationResult(isValid: boolean, filePath: string): void {
+    const fileName = path.basename(filePath);
+    if (isValid) {
+      console.log(`  ✅ ${fileName} passed validation`);
+    } else {
+      console.error(`  ❌ ${fileName} failed validation`);
+    }
+  }
+
+  private async lintMarkdownFile(content: string): Promise<boolean> {
     console.log('  - Validating Markdown structure');
     console.log('  - Checking YAML frontmatter');
 
     const parts = content.split('---\n');
     if (parts.length < 3) {
       console.error('  Error: Invalid markdown structure. YAML frontmatter is missing or incomplete.');
-      return;
+      return false;
     }
 
     const frontmatter = parts[1];
     const markdownContent = parts.slice(2).join('---\n').trim();
 
     try {
       const frontmatterData = yaml.load(frontmatter) as Record<string, unknown>;
-      this.contextValidator.validateContextData(frontmatterData, 'markdown');
+      await this.contextValidator.validateContextData(frontmatterData, 'markdown');
     } catch (error) {
       console.error(`  Error parsing YAML frontmatter: ${error}`);
+      return false;
     }
 
-    this.validateMarkdownContent(markdownContent);
+    return this.validateMarkdownContent(markdownContent);
   }
 
-  private validateMarkdownContent(content: string): void {
+  private validateMarkdownContent(content: string): boolean {
     const tokens = this.md.parse(content, {});
     let hasTitle = false;
+    let isValid = true;
 
     for (const token of tokens) {
       if (token.type === 'heading_open' && token.tag === 'h1' && !hasTitle) {
@@ -106,38 +119,47 @@ export class ContextLinter {
         const hrefToken = tokens[tokens.indexOf(token) + 1];
         if (hrefToken.type !== 'text' || !hrefToken.content.startsWith('http')) {
           console.error('  Warning: Link may be improperly formatted or using relative path.');
+          isValid = false;
         }
       }
 
       if (token.type === 'fence' && !token.info) {
         console.error('  Warning: Code block is missing language specification.');
+        isValid = false;
       }
     }
 
     if (!hasTitle) {
       console.error('  Error: Markdown content should start with a title (H1 heading).');
+      isValid = false;
     }
+
+    return isValid;
   }
 
-  private lintYamlFile(content: string): void {
+  private async lintYamlFile(content: string): Promise<boolean> {
     console.log('  - Validating YAML structure');
 
     try {
       const yamlData = yaml.load(content) as Record<string, unknown>;
-      this.contextValidator.validateContextData(yamlData, 'yaml');
+      await this.contextValidator.validateContextData(yamlData, 'yaml');
+      return true;
     } catch (error) {
       console.error(`  Error parsing YAML file: ${error}`);
+      return false;
     }
   }
 
-  private lintJsonFile(content: string): void {
+  private async lintJsonFile(content: string): Promise<boolean> {
     console.log('  - Validating JSON structure');
 
     try {
       const jsonData = JSON.parse(content) as Record<string, unknown>;
-      this.contextValidator.validateContextData(jsonData, 'json');
+      await this.contextValidator.validateContextData(jsonData, 'json');
+      return true;
     } catch (error) {
       console.error(`  Error parsing JSON file: ${error}`);
+      return false;
     }
   }
 }

linters/typescript/src/utils/file_utils.ts

@@ -33,7 +33,7 @@ export async function fileExists(filePath: string): Promise<boolean> {
 export function printHeader(packageVersion: string, directoryPath: string): void {
   console.log(`
 ========================================================
-AI Context Convention Linter (v${packageVersion})
+Codebase Context Specification (CCS) Linter (v${packageVersion})
 ========================================================
 `);
   console.log(`Linting directory: ${directoryPath}\n`);