怎么用VSCode开发Keystone CMS_VSCode Keystone Schema与GraphQL调试

星宇君_9553

星宇君_9553

2026-06-03

173人浏览

原创

keystone cms 项目中 keystone dev 报“command not found”,根本原因是未本地安装 keystone cli(非全局),需在项目根目录执行 npm install 确保 node_modules/.bin/keystone 存在,并重启 vscode 终端;调试时可用 npx keystone dev 绕过 path 问题。

怎么用vscode开发keystone cms_vscode keystone schema与graphql调试

Keystone CMS 项目在 VSCode 中无法识别 keystone 命令?先确认 CLI 安装方式

VSCode 终端里执行 keystone dev 报错 “command not found”,大概率是因为你没在项目本地安装 CLI。Keystone 6+ 不再全局安装 @keystone-6/core 或 keystone CLI,而是依赖 keystone 包自带的二进制入口(通过 package.json 的 "type": "module" 和 bin 字段支持)。

实操建议:

  • 确保 package.json 中已声明 "keystone": "^6.4.0"(或更高稳定版),然后运行 npm install(不是 npm install -g keystone)
  • 检查 node_modules/.bin/keystone 是否存在;若不存在,删掉 node_modules 和 package-lock.json 重装
  • VSCode 内置终端需重启才能加载新 node_modules/.bin 路径 —— 关闭所有终端页签,再打开一个新终端
  • 用 npx keystone dev 可绕过 PATH 问题,适合调试启动流程

GraphQL Playground 打不开或 schema 没更新?检查 dev 模式是否启用 GraphQL 端点

Keystone 默认只在 dev 模式下暴露 /api/graphql 和 Playground(/admin 是 Admin UI,不是 GraphQL IDE)。如果访问 http://localhost:3000/api/graphql 显示 404 或白屏,不是前端问题,是服务端未启用。

实操建议:

  • 确认启动命令是 keystone dev(不是 keystone start 或 node dist/index.js)
  • 检查 keystone.ts 中 config 对象是否含 graphql: { path: '/api/graphql' }(默认有,但若手动覆盖了 graphql 配置且设为 false 就会禁用)
  • 修改 Schema 后保存,VSCode 应触发热重载;若无反应,看终端日志是否有 ? Reloading Keystone config —— 没有则可能是文件监听失效(见下一条)
  • Windows 用户注意:WSL2 + VSCode Remote 时,需在 keystone.ts 的 dev: { fileChangeDelayMs: 500 } 中加大延迟,避免 chokidar 丢事件

VSCode 断点不生效、console.log 不输出?Node.js 调试配置要匹配 ESM + TypeScript

Keystone 6+ 默认用 ESM(type: "module")+ TypeScript,直接跑 node . 会报错,VSCode 的默认 Node.js 启动配置也不兼容。断点停不住、console.log 在终端刷出来但调试器看不到,基本是运行时环境和调试器没对齐。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

实操建议:

  • 在项目根目录加 .vscode/launch.json,内容必须含 "runtimeArgs": ["--loader", "ts-node/esm"](若用 ts-node)或 "runtimeArgs": ["--import", "tsx"](推荐 tsx,更快更稳)
  • 不要用 program 指向 keystone.ts;应指向生成后的入口,如 "program": "${workspaceFolder}/keystone.ts" + "runtimeExecutable": "npx" + "runtimeArgs": ["tsx", "keystone.ts", "dev"]
  • 确保已安装 tsx:运行 npm install --save-dev tsx,否则调试器找不到 loader
  • 在 keystone.ts 顶部加 debugger;,启动调试后看 VSCode 是否暂停 —— 若不暂停,检查右下角状态栏是否显示 “TypeScript” 而非 “JavaScript”,否则 TS 类型不会被识别

Schema 修改后 GraphQL Playground 里字段没变?别只刷新页面,要确认类型生成与缓存

改完 list 配置,比如给 User 加个 bio 字段,Playground 里查 users 还是没 bio,常见原因不是代码没生效,而是 GraphQL SDL 缓存或类型未重建。

实操建议:

  • 强制清除 Keystone 生成缓存:删掉 .keystone 目录(它存了动态生成的 GraphQL Schema、Prisma client、types 等),再重启 keystone dev
  • 检查终端是否输出 ✅ Generated GraphQL schema 和 ✅ Generated Prisma client —— 缺任一说明构建中断,常见于 schema.prisma 语法错误
  • Playground 页面按 Ctrl+R(Win/Linux)或 Cmd+R(macOS)硬刷新,不要点右上角 “Reload Schema”,那个只拉一次 introspection,不触发服务端重建
  • 如果用了 extendGraphqlSchema 手动扩展类型,记得返回的 extendGraphqlSchema 函数必须同步执行,异步逻辑(如 await)会导致 schema 初始化失败且无报错

最易被忽略的是 .keystone 目录的隐式持久化 —— 它不像 dist 那样显眼,但一旦残留旧版本生成物,就会让整个 GraphQL 层“卡”在旧 schema 上,连重启都无效。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode cms

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3209

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2178

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3500

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15995

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程