You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add project name to the heading
- Wrap long lines in the project overview paragraph
- Add `composer run wp-run` to the commands list
- Split the component overview into three separate diagrams
Copy file name to clipboardExpand all lines: AGENTS.md
+35-16Lines changed: 35 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,7 @@ MAINTENANCE: Update this file when:
6
6
- Adding new architectural patterns or conventions
7
7
-->
8
8
9
-
# AGENTS.md
10
-
This file provides guidance to AI coding agents when working with code in this repository.
9
+
# AGENTS.md - SQLite Database Integration
11
10
12
11
## Project overview
13
12
This project implements SQLite database support for MySQL-based projects.
@@ -20,7 +19,9 @@ It is a monorepo that includes the following components:
20
19
-**WordPress plugin** — A plugin that adds SQLite support to WordPress.
21
20
-**Test suites** — A set of extensive test suites to cover MySQL syntax and functionality.
22
21
23
-
The codebase is pure PHP with zero dependencies. It supports PHP 7.2 through 8.5, MySQL syntax from version 5.7 onward, and requires SQLite 3.37.0 or newer (with legacy mode down to 3.27.0).
22
+
The codebase is pure PHP with zero dependencies. It supports PHP 7.2 through 8.5,
23
+
MySQL syntax from version 5.7 onward, and requires SQLite 3.37.0 or newer
24
+
(with legacy mode down to 3.27.0).
24
25
25
26
### New and old driver
26
27
At the moment, the project includes two MySQL-on-SQLite driver implementations:
@@ -48,6 +49,7 @@ composer run test-e2e # Run E2E tests (Playwright via WP env)
48
49
49
50
# WordPress tests
50
51
composer run wp-setup # Set up WordPress with SQLite for tests
52
+
composer run wp-run # Run a WordPress repository command
51
53
composer run wp-test-start # Start WordPress environment (Docker)
52
54
composer run wp-test-php # Run WordPress PHPUnit tests
53
55
composer run wp-test-e2e # Run WordPress E2E tests (Playwright)
@@ -60,21 +62,38 @@ into the SQLite driver to support diverse use cases both inside and outside the
60
62
PHP ecosystem.
61
63
62
64
### Component overview
63
-
The following diagram shows how different types of applications can be supported
64
-
using components from this project:
65
+
The following diagrams show how different types of applications can be supported
66
+
using components from this project.
65
67
68
+
**PHP applications** are supported through a PDO\MySQL-compatible API:
0 commit comments