create-prisma-php-app 5.0.0-alpha.30 → 5.0.0-alpha.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,12 +2,15 @@
2
2
 
3
3
  ## Source Of Truth
4
4
 
5
+ - Use `./prisma-php.json` as the single source of truth for which optional Prisma PHP features are enabled in the current app and which framework-managed scaffolds should exist.
5
6
  - For Prisma PHP applications, treat `node_modules/prisma-php/dist/docs/index.md` as the entry point for the installed framework version.
7
+ - Treat `node_modules/prisma-php/dist/docs` as framework reference docs that teach AI how Prisma PHP works. The presence of a page in that docs folder does not mean the current workspace has that feature enabled.
6
8
  - Read the matching doc in `node_modules/prisma-php/dist/docs` before generating or editing framework-specific Prisma PHP code.
7
9
  - Expect `AGENTS.md` in the project root and keep it aligned with the installed Prisma PHP docs contract.
8
10
  - In the Prisma PHP package source repo, keep `AGENTS.md`, `.github/copilot-instructions.md`, and `dist/docs` aligned so the published docs remain correct after install.
9
11
  - Do not assume installed consumer apps also ship a root `.github/copilot-instructions.md` unless the generator explicitly creates one.
10
12
  - Keep every `dist/docs/*.md` page AI-discoverable on its own: the frontmatter description and opening section should clearly say when agents should read that file and which adjacent docs to consult next.
13
+ - When a task maps to an optional feature such as `backendOnly`, `swaggerDocs`, `typescript`, `websocket`, or `mcp`, inspect `./prisma-php.json` first, then read the matching docs page to learn the implementation contract.
11
14
 
12
15
  ## Project Structure Recommendations
13
16
 
package/dist/AGENTS.md CHANGED
@@ -6,6 +6,8 @@ This AGENTS.md belongs in the root of a Prisma PHP application.
6
6
 
7
7
  Treat `./node_modules/prisma-php/dist/docs/index.md` as the entry point for Prisma PHP guidance, then read the matching document in `./node_modules/prisma-php/dist/docs` before generating, editing, reviewing, or documenting framework-specific behavior.
8
8
 
9
+ Treat the installed docs as framework knowledge. They explain what Prisma PHP can do and how to do it. Do not treat the presence of a page in `./node_modules/prisma-php/dist/docs` as proof that the current app has that feature enabled.
10
+
9
11
  Do not guess framework behavior from Laravel, Next.js, React, Vue, Livewire, Alpine, Symfony, Socket.IO, or generic PHP habits. Prisma PHP's installed docs in `./node_modules/prisma-php/dist/docs` and the current project files are the source of truth.
10
12
 
11
13
  ## Documentation source of truth
@@ -22,7 +24,9 @@ For Prisma PHP projects, use this order first:
22
24
 
23
25
  Important rules:
24
26
 
27
+ - use `./prisma-php.json` as the single source of truth for current-project feature flags and framework-managed scaffolds
25
28
  - treat `./node_modules/prisma-php/dist/docs` as the single documentation source of truth for the installed Prisma PHP version
29
+ - treat the docs inventory as a framework reference set for AI routing, not as a statement that every optional Prisma PHP feature is enabled in the current app
26
30
  - expect `./AGENTS.md` at the project root
27
31
  - when the installed docs and a habit from another framework conflict, follow Prisma PHP
28
32
  - when updating Prisma PHP package/docs sources, keep `AGENTS.md` and `dist/docs` aligned for consumer apps; if the Prisma PHP package source repo also maintains `.github/copilot-instructions.md`, keep that source-repo file aligned there too
@@ -51,6 +55,8 @@ AGENTS.md
51
55
 
52
56
  Before generating code, examples, instructions, or reviews, choose the documentation file based on the task.
53
57
 
58
+ Use the docs router to learn how Prisma PHP implements a task. Use `./prisma-php.json` to decide whether the current app enables the relevant optional feature.
59
+
54
60
  ### Read these docs first for these tasks
55
61
 
56
62
  - **Framework orientation, repo-wide guidance, or the high-level AI quick start**
@@ -131,7 +137,7 @@ Before generating code, examples, instructions, or reviews, choose the documenta
131
137
  - **First-time project installation or app creation flow**
132
138
  Read `installation.md`
133
139
 
134
- ## Docs inventory in this repo
140
+ ## Framework docs inventory in this repo
135
141
 
136
142
  The current Prisma PHP docs shipped here include:
137
143
 
@@ -162,6 +168,10 @@ The current Prisma PHP docs shipped here include:
162
168
  - `validator.md`
163
169
  - `websocket.md`
164
170
 
171
+ This inventory exists to help AI find the right Prisma PHP guidance quickly. It is not a feature inventory for the current app.
172
+
173
+ When a task depends on optional capabilities such as `backendOnly`, `swaggerDocs`, `typescript`, `websocket`, or `mcp`, inspect `./prisma-php.json` before assuming the generated scaffold exists.
174
+
165
175
  When adding or reviewing AI guidance, do not stop at older docs only. Make sure the guidance also covers `backend-only.md`, `email.md`, `env.md`, `get-started-ia.md`, `mcp.md`, `swagger-docs.md`, `typescript.md`, and `websocket.md`, plus newer behavior documented in `fetching-data.md` and `metadata-and-og-images.md`.
166
176
 
167
177
  ## Framework-generated files
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-prisma-php-app",
3
- "version": "5.0.0-alpha.30",
3
+ "version": "5.0.0-alpha.31",
4
4
  "description": "Prisma-PHP: A Revolutionary Library Bridging PHP with Prisma ORM",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",