Draft
Bump flat and mocha; reorganize docs and add AGENTS.md and SKILLS.md#6
Conversation
- Split 1831-line README into focused docs/ files - README.md now serves as a clean 138-line entry point - docs/EXAMPLES.md: annotated code examples - docs/USAGE.md: installation and usage guide - docs/ENGINES.md: engine system reference - docs/TEMPLATE_FORMAT.md: template source syntax - docs/API.md: complete API reference - docs/ADVANCED.md: hooks, mutations, CTEs, SQL alternatives - docs/ABOUT.md: project background and roadmap - AGENTS.md: guide for AI coding agents working on the repo - SKILLS.md: using SQLTT as a GitHub Copilot Skill
Copilot
AI
changed the title
[WIP] Update flat to version 5.0.2 and mocha dependency
Bump flat and mocha; reorganize docs and add AGENTS.md and SKILLS.md
Jul 29, 2026
bitifet
approved these changes
Jul 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bumps flat to 5.0.2 and updates ancestor dependency mocha. These dependencies need to be updated together.
Updates
flatfrom 4.1.1 to 5.0.2Updates
mochafrom 6.2.3 to 10.2.0In addition, this PR includes a full documentation reorganisation and new AI-agent support files:
Documentation Reorganisation
The 1831-line
README.mdhas been split into focused documents under a newdocs/directory, making it easier to navigate and maintain:README.md— Concise overview (138 lines) with quick-start guide and navigation table linking to all docs.docs/EXAMPLES.md— Annotated code examples covering CLI usage, Node.js integration, multi-engine output, and non-JS language support.docs/USAGE.md— Installation, template writing patterns, and usage guide.docs/ENGINES.md— Engine system reference: supported engines, flavours,SQL_ENGINEenvironment variable, and--engineCLI flag.docs/TEMPLATE_FORMAT.md— Complete template source syntax reference (all properties).docs/API.md— Full API reference: Template API, Tag API, and Static Methods.docs/ADVANCED.md— Advanced features: hooks, SQL alternatives (altsql), mutable queries (mutations), and CTEs.docs/ABOUT.md— Project background, prerelease context, and roadmap.AI Agent Support Files
AGENTS.md— A guide for AI coding agents working on this repository, covering the repo layout, how to run tests, how to add new engines, coding conventions, and useful search patterns.SKILLS.md— Describes how to use SQLTT as a GitHub Copilot Skill. Includes two activation methods (via.github/copilot-instructions.mdor a Copilot Chat prompt), example prompts for common tasks (template generation, multi-engine support, CTE refactoring), and a quick-reference API cheatsheet. Instructions for using the skill are also included in the documentation.