@ai-coders/context 0.1.0 → 0.3.0

package/dist/generators/documentation/templates/securityTemplate.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderSecurity = renderSecurity;
+const frontMatter_1 = require("./frontMatter");
+function renderSecurity() {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'security',
+        goal: 'Document authentication, authorization, data protection, and compliance expectations.',
+        requiredInputs: [
+            'AuthN/AuthZ implementation details',
+            'Secrets storage and rotation policies',
+            'Compliance frameworks or audit requirements'
+        ],
+        successCriteria: [
+            'Explains how users and services authenticate',
+            'Lists sensitive data classifications and storage locations',
+            'Provides clear escalation paths for security incidents'
+        ],
+        relatedAgents: ['security-auditor', 'code-reviewer']
+    });
+    return `${frontMatter}
+<!-- ai-task:security -->
+# Security & Compliance Notes
+
+Capture the policies and guardrails that keep this project secure and compliant.
+
+## Authentication & Authorization
+- Describe identity providers, token formats, session strategies, and role/permission models.
+
+## Secrets & Sensitive Data
+- Storage locations (vaults, parameter stores), rotation cadence, encryption practices, and data classifications.
+
+## Compliance & Policies
+- Applicable standards (GDPR, SOC2, HIPAA, internal policies) and evidence requirements.
+
+## Incident Response
+- On-call contacts, escalation steps, and tooling for detection, triage, and post-incident analysis.
+
+## AI Update Checklist
+1. Confirm security libraries and infrastructure match current deployments.
+2. Update secrets management details when storage or naming changes.
+3. Reflect new compliance obligations or audit findings.
+4. Ensure incident response procedures include current contacts and tooling.
+
+## Acceptable Sources
+- Security architecture docs, runbooks, policy handbooks.
+- IAM/authorization configuration (code or infrastructure).
+- Compliance updates from security or legal teams.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=securityTemplate.js.map

package/dist/generators/documentation/templates/securityTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"securityTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":";;AAEA,wCAgDC;AAlDD,+CAAkD;AAElD,SAAgB,cAAc;IAC5B,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,UAAU;QACd,IAAI,EAAE,uFAAuF;QAC7F,cAAc,EAAE;YACd,oCAAoC;YACpC,uCAAuC;YACvC,6CAA6C;SAC9C;QACD,eAAe,EAAE;YACf,8CAA8C;YAC9C,4DAA4D;YAC5D,wDAAwD;SACzD;QACD,aAAa,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;KACrD,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BtB,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/testingTemplate.d.ts

@@ -0,0 +1,2 @@
+export declare function renderTestingStrategy(): string;
+//# sourceMappingURL=testingTemplate.d.ts.map

package/dist/generators/documentation/templates/testingTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,IAAI,MAAM,CAsD9C"}

package/dist/generators/documentation/templates/testingTemplate.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTestingStrategy = renderTestingStrategy;
+const frontMatter_1 = require("./frontMatter");
+function renderTestingStrategy() {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'testing-strategy',
+        goal: 'Explain how the project maintains quality, from unit coverage to release gates.',
+        requiredInputs: [
+            'Testing framework configuration (jest.config.js, etc.)',
+            'CI requirements for merges/releases',
+            'Known flaky suites or troubleshooting notes'
+        ],
+        successCriteria: [
+            'Test types list frameworks and ownership at a glance',
+            'Commands match package scripts and CI usage',
+            'Quality gates describe pass/fail expectations with numbers when possible'
+        ],
+        relatedAgents: ['test-writer', 'code-reviewer']
+    });
+    return `${frontMatter}
+<!-- ai-task:testing-strategy -->
+# Testing Strategy
+
+Document how quality is maintained across the codebase.
+
+## Test Types
+- Unit: List frameworks (e.g., Jest) and file naming conventions.
+- Integration: Describe scenarios and required tooling.
+- End-to-end: Note harnesses or environments if applicable.
+
+## Running Tests
+- Execute all tests with \`npm run test\`.
+- Use watch mode locally: \`npm run test -- --watch\`.
+- Add coverage runs before releases: \`npm run test -- --coverage\`.
+
+## Quality Gates
+- Define minimum coverage expectations.
+- Capture linting or formatting requirements before merging.
+
+## Troubleshooting
+- Document flaky suites, long-running tests, or environment quirks.
+
+## AI Update Checklist
+1. Review test scripts and CI workflows to confirm command accuracy.
+2. Update Quality Gates with current thresholds (coverage %, lint rules, required checks).
+3. Document new test categories or suites introduced since the last update.
+4. Record known flaky areas and link to open issues for visibility.
+5. Confirm troubleshooting steps remain valid with current tooling.
+
+## Acceptable Sources
+- \`package.json\` scripts and testing configuration files.
+- CI job definitions (GitHub Actions, CircleCI, etc.).
+- Issue tracker items labelled “testing” or “flaky” with maintainer confirmation.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=testingTemplate.js.map

package/dist/generators/documentation/templates/testingTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/testingTemplate.ts"],"names":[],"mappings":";;AAEA,sDAsDC;AAxDD,+CAAkD;AAElD,SAAgB,qBAAqB;IACnC,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,iFAAiF;QACvF,cAAc,EAAE;YACd,wDAAwD;YACxD,qCAAqC;YACrC,6CAA6C;SAC9C;QACD,eAAe,EAAE;YACf,sDAAsD;YACtD,6CAA6C;YAC7C,0EAA0E;SAC3E;QACD,aAAa,EAAE,CAAC,aAAa,EAAE,eAAe,CAAC;KAChD,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCtB,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/toolingTemplate.d.ts

@@ -0,0 +1,2 @@
+export declare function renderToolingGuide(): string;
+//# sourceMappingURL=toolingTemplate.d.ts.map

package/dist/generators/documentation/templates/toolingTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolingTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,kBAAkB,IAAI,MAAM,CAmD3C"}

package/dist/generators/documentation/templates/toolingTemplate.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderToolingGuide = renderToolingGuide;
+const frontMatter_1 = require("./frontMatter");
+function renderToolingGuide() {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'tooling-guide',
+        goal: 'Help contributors set up local environments, automation, and productivity tooling quickly.',
+        requiredInputs: [
+            'Project-specific CLI commands or scripts',
+            'Preferred IDE/editor configurations',
+            'Automation hooks (pre-commit, CI helpers, generators)'
+        ],
+        successCriteria: [
+            'Includes copy/paste-ready commands for installation and diagnostics',
+            'Highlights required extensions or plugins',
+            'Links to automation or productivity aids maintained by the team'
+        ],
+        relatedAgents: ['feature-developer', 'documentation-writer']
+    });
+    return `${frontMatter}
+<!-- ai-task:tooling -->
+# Tooling & Productivity Guide
+
+Collect the scripts, automation, and editor settings that keep contributors efficient.
+
+## Required Tooling
+- <!-- ai-slot:tool-required -->Tool name — How to install, version requirements, what it powers.<!-- /ai-slot -->
+
+## Recommended Automation
+- Pre-commit hooks, linting/formatting commands, code generators, or scaffolding scripts.
+- Shortcuts or watch modes for local development loops.
+
+## IDE / Editor Setup
+- Extensions or plugins that catch issues early.
+- Snippets, templates, or workspace settings worth sharing.
+
+## Productivity Tips
+- Terminal aliases, container workflows, or local emulators mirroring production.
+- Links to shared scripts or dotfiles used across the team.
+
+## AI Update Checklist
+1. Verify commands align with the latest scripts and build tooling.
+2. Remove instructions for deprecated tools and add replacements.
+3. Highlight automation that saves time during reviews or releases.
+4. Cross-link to runbooks or README sections that provide deeper context.
+
+## Acceptable Sources
+- Onboarding docs, internal wikis, and team retrospectives.
+- Script directories, package manifests, CI configuration.
+- Maintainer recommendations gathered during pairing or code reviews.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=toolingTemplate.js.map

package/dist/generators/documentation/templates/toolingTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolingTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/toolingTemplate.ts"],"names":[],"mappings":";;AAEA,gDAmDC;AArDD,+CAAkD;AAElD,SAAgB,kBAAkB;IAChC,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,eAAe;QACnB,IAAI,EAAE,4FAA4F;QAClG,cAAc,EAAE;YACd,0CAA0C;YAC1C,qCAAqC;YACrC,uDAAuD;SACxD;QACD,eAAe,EAAE;YACf,qEAAqE;YACrE,2CAA2C;YAC3C,iEAAiE;SAClE;QACD,aAAa,EAAE,CAAC,mBAAmB,EAAE,sBAAsB,CAAC;KAC7D,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCtB,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/types.d.ts

@@ -0,0 +1,23 @@
+import { RepoStructure } from '../../../types';
+export interface GuideMeta {
+    key: string;
+    title: string;
+    file: string;
+    marker: string;
+    primaryInputs: string;
+}
+export interface DirectoryStat {
+    name: string;
+    fileCount: number;
+}
+export interface DocumentationTemplateContext {
+    repoStructure: RepoStructure;
+    topLevelDirectories: string[];
+    primaryLanguages: Array<{
+        extension: string;
+        count: number;
+    }>;
+    directoryStats: DirectoryStat[];
+    guides: GuideMeta[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/generators/documentation/templates/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9D,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB"}

package/dist/generators/documentation/templates/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/generators/documentation/templates/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/types.ts"],"names":[],"mappings":""}

package/dist/generators/documentation/templates.d.ts

@@ -0,0 +1,31 @@
+import { RepoStructure } from '../../types';
+export interface GuideMeta {
+    title: string;
+    file: string;
+    marker: string;
+    primaryInputs: string;
+}
+export interface DirectoryStat {
+    name: string;
+    fileCount: number;
+}
+export interface DocumentationTemplateContext {
+    repoStructure: RepoStructure;
+    topLevelDirectories: string[];
+    primaryLanguages: Array<{
+        extension: string;
+        count: number;
+    }>;
+    directoryStats: DirectoryStat[];
+    guides: GuideMeta[];
+}
+export declare function renderIndex(context: DocumentationTemplateContext): string;
+export declare function renderProjectOverview(context: DocumentationTemplateContext): string;
+export declare function renderArchitectureNotes(context: DocumentationTemplateContext): string;
+export declare function renderDevelopmentWorkflow(): string;
+export declare function renderTestingStrategy(): string;
+export declare function renderGlossary(_context: DocumentationTemplateContext): string;
+export declare function renderDataFlow(context: DocumentationTemplateContext): string;
+export declare function renderSecurity(): string;
+export declare function renderToolingGuide(): string;
+//# sourceMappingURL=templates.d.ts.map

package/dist/generators/documentation/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/generators/documentation/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9D,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAWD,wBAAgB,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAuDzE;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA+DnF;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA8DrF;AAED,wBAAgB,yBAAyB,IAAI,MAAM,CAsDlD;AAED,wBAAgB,qBAAqB,IAAI,MAAM,CAsD9C;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,4BAA4B,GAAG,MAAM,CAkD7E;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAiD5E;AAED,wBAAgB,cAAc,IAAI,MAAM,CAgDvC;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAmD3C"}