Files

251 lines
7.9 KiB
Plaintext

================================================================================
PRISM NOTES - STANDARDS AUDIT CHECKLIST
Formal verification of Monica's enforced standards
Run at project start and before every commit
================================================================================
INSTRUCTIONS:
- Check each item systematically
- Mark result: ✓ (PASS), ✗ (FAIL), or ⚠ (WARNING)
- If FAIL: Is it documented in DEVIATIONS.txt?
- Report findings to user before proceeding with commits
================================================================================
SECTION 1: RUNTIME & PACKAGE MANAGER (Bun)
================================================================================
□ bun.lock file exists in project root
Location: /home/admin/Prism-Notes/bun.lock
Status: ?
□ No package-lock.json in project root
Location: /home/admin/Prism-Notes/package-lock.json
Status: ?
Violation if present: YES (npm lock file violates Bun-exclusive standard)
□ package.json scripts use "bun run" (not "npm run")
File: /home/admin/Prism-Notes/package.json
Scripts to check: dev, start, test, build
Status: ?
□ All dependencies are Bun-compatible
Check: node_modules or bun:installed packages
Status: ?
□ No npm-related files in .gitignore exceptions
File: /home/admin/Prism-Notes/.gitignore
Should exclude: npm-debug.log*, package-lock.json
Status: ?
================================================================================
SECTION 2: LANGUAGE (TypeScript - Frontend & Backend)
================================================================================
□ Backend: server.ts is TypeScript (not .js)
File: /home/admin/Prism-Notes/server.ts
Status: ?
□ tsconfig.json is present and valid
File: /home/admin/Prism-Notes/tsconfig.json
Check: compilerOptions, module type, target
Status: ?
□ All backend files use .ts extension
Pattern: src/**, backend/**, server/** should be .ts not .js
Status: ?
□ Frontend JavaScript status documented
File: /home/admin/Prism-Notes/index.html
Check: Contains inline <script> blocks
Documented in DEVIATIONS.txt? ?
Status: ?
□ No hardcoded secrets in TypeScript files
Search: process.env references in all .ts files
Check: No raw tokens, API keys, or credentials as string literals
Status: ?
================================================================================
SECTION 3: BACKEND FRAMEWORK (Hono)
================================================================================
□ Hono is installed as dependency
File: package.json
Check: "hono" in dependencies
Status: ?
□ server.ts uses Hono patterns
File: server.ts
Check: new Hono(), app.get(), app.post(), middleware patterns
Status: ?
□ Routes organized by feature/domain
File: server.ts
Check: Logical grouping of endpoints
Status: ?
□ Middleware is documented and composable
File: server.ts
Check: CORS, auth, error handling setup
Status: ?
================================================================================
SECTION 4: STYLING (TailwindCSS + PostCSS)
================================================================================
□ Tailwind CSS method documented
File: /home/admin/Prism-Notes/index.html or build config
Check: CDN vs build pipeline
Status: ?
Documented in DEVIATIONS.txt if not standard? ?
□ No inline <style> tags with raw CSS
File: index.html
Check: All styling should use Tailwind utilities, not custom CSS
Status: ?
□ TailwindCSS config present (if using build)
File: tailwind.config.js or tailwind.config.ts
Status: ?
□ PostCSS configured (if using build)
File: postcss.config.js
Status: ?
================================================================================
SECTION 5: ENVIRONMENT VARIABLES & SECRETS
================================================================================
□ No secrets in git (assumed in .gitignore)
File: .gitignore
Check: secrets/, .env, .env.local excluded
Status: ?
□ secrets/.env exists and is not tracked
Location: /home/admin/secrets/.env
Status: ?
□ All env vars documented
File: README.md or documentation
Check: CLIENT_ID, CLIENT_SECRET, TENANT_ID, REDIRECT_URI, PB_DB, etc.
Status: ?
□ Code references only process.env (not hardcoded values)
Files: server.ts, any config files
Status: ?
================================================================================
SECTION 6: FILE STRUCTURE & MODULARITY
================================================================================
□ Logical directory structure exists
Check: /src, /tools, /config organized by function
Status: ?
□ Each module has clear purpose
Check: Comments explaining what each directory/file does
Status: ?
□ Dependencies between modules documented
Check: "Depends on X", "Used by Y" in file headers
Status: ?
□ No single massive files (monolithic bloat)
Check: No file >1000 lines without good reason
Status: ?
================================================================================
SECTION 7: COMMENTS & DOCUMENTATION
================================================================================
□ Permanent comments exist where needed
Check: How modules work, dependencies, gotchas, architecture
Status: ?
□ Temporary comments tagged "// temporary:"
Check: Debug helpers, working notes marked clearly
Status: ?
□ No commented-out code blocks left behind
Files: All .ts, .js files
Status: ?
□ README.md is current and complete
File: /home/admin/Prism-Notes/README.md
Check: Setup, env vars, how to run, architecture notes
Status: ?
================================================================================
SECTION 8: LOGGING & TRACKING
================================================================================
□ logs/SESSION_LOG.txt exists
File: /home/admin/Prism-Notes/logs/SESSION_LOG.txt
Status: ?
□ logs/DEVIATIONS.txt exists
File: /home/admin/Prism-Notes/logs/DEVIATIONS.txt
Status: ?
□ All documented deviations are in DEVIATIONS.txt
Check: Every non-standard solution has entry with reasoning
Status: ?
================================================================================
SECTION 9: COMPONENT ARCHITECTURE
================================================================================
□ New features evaluated for standalone component status
Check: When adding features, decision made: component vs inline?
Status: ?
□ Existing standalone components are self-contained
Check: /tools/* directories have clear purpose and dependencies
Status: ?
□ Component interfaces are documented
Check: Inputs, outputs, dependencies clear for each component
Status: ?
□ Components are reusable and don't duplicate logic
Check: No component duplicates functionality from another
Status: ?
================================================================================
SECTION 10: GIT & VERSION CONTROL
================================================================================
□ .gitignore is comprehensive
File: .gitignore
Check: node_modules, .env, build artifacts, IDE files, OS files
Status: ?
□ git.instructions (Monica persona) is present and current
File: git.instructions
Status: ?
================================================================================
AUDIT RESULTS SUMMARY
================================================================================
Run this section AFTER checking everything above:
Total checks: 44
Passed: __
Failed: __
Warnings: __
Failed items (with violation status):
[list all FAILS with documented status]
Documented deviations (from DEVIATIONS.txt):
[list all accepted non-standard solutions]
Ready to commit: YES / NO
Reason: ___________________________________________________________
Audited by: Monica
Timestamp: [user fills in or automated]
================================================================================