如何在 VSCode 中借助 Node 环境编写自定义脚手架工具

雨强姑娘_7500

雨强姑娘_7500

2026-07-11

369人浏览

原创

根本原因是bin字段未配对或脚手架文件缺少#!/usr/bin/env node声明;需确保package.json中bin值指向真实JS文件且首行正确,npm link后验证,Windows用户还需解除PowerShell执行策略限制。

如何在 vscode 中借助 node 环境编写自定义脚手架工具

脚手架命令为何在终端里执行不了

根本原因通常是 bin 字段没配对,或文件缺少可执行声明。VSCode 终端本身不干预命令执行,问题出在 Node 包注册环节。

必须确保 package.json 中的 bin 字段值指向一个真实存在的 JS 文件,且该文件首行是:#!/usr/bin/env node。漏掉这行,Windows 会尝试用记事本打开,macOS/Linux 则直接报 Permission denied 或 command not found。

  • bin 的 key 是将来敲的命令名(如 my-scaffold),value 是相对于 package.json 的路径(如 bin/index.js)
  • 如果用 npm link 本地调试,需先在脚手架项目根目录运行一次 npm link,再在任意目录执行命令
  • Windows 用户注意:PowerShell 默认禁用未签名脚本,若报 cnpm.ps1 cannot be loaded 类错误,不是脚手架问题,而是执行策略限制,需运行 set-ExecutionPolicy RemoteSigned -Scope CurrentUser

交互式提问用 inquirer 还是 prompts

inquirer 功能全但体积大、有依赖冲突风险;prompts 更轻量、ESM 友好,适合现代 Node 脚手架。VSCode 中开发时推荐后者——尤其当你已在 package.json 里设了 "type": "module"。

例如初始化模板选择:

import prompts from 'prompts';

const response = await prompts({
  type: 'select',
  name: 'template',
  message: 'Choose a template',
  choices: [
    { title: 'Vue 3 + TS', value: 'vue3-ts' },
    { title: 'React + Vite', value: 'react-vite' }
  ]
});
  • inquirer 的 prompt() 返回 Promise,但默认不支持 ESM 的顶层 await,容易卡住
  • prompts 对 TypeScript 支持更干净,无需额外安装类型包
  • 避免混用:同一脚手架里不要同时 require inquirer 和 import prompts,Node 模块系统会报 ERR_REQUIRE_ESM

模板下载该用 download-git-repo 还是 git clone

用 download-git-repo 更稳妥。它直接拉 zip 包解压,不依赖本地装 Git,也不触发 SSH 配置、凭证弹窗等 VSCode 终端里难处理的交互。

VSCode节点工具(专业版)
VSCode节点工具(专业版)

面向团队的企业级IDE远程操作平台,含调试、测试、终端、Agent委托与团队协作能力。

下载

常见坑:

  • 仓库地址写错格式:github:username/repo 或 gitlab:org/project,不能带 .git 后缀
  • 分支名不加前缀会默认拉 master,要拉 main 得写成 github:foo/bar#main
  • 下载完成回调里才应执行 git init,否则用户选“不初始化 Git”时,文件夹已建好但空跑了一次 git clone 流程
  • 路径参数必须是绝对路径,download-git-repo 不接受相对路径,建议用 path.resolve(process.cwd(), name)

为什么 tsconfig.json 要加 "types": ["node"]

VSCode 里写脚手架用 TypeScript,但默认类型库不含 Node.js 全局对象(如 __dirname、process.argv、fs.promises)。不加这行,编辑器会标红,tsc 编译失败,但 node bin/index.js 却能跑——因为 JS 运行时不校验类型。

这不是 VSCode 特有问题,而是 TypeScript 编译配置缺失。正确做法是在生成的 tsconfig.json 的 compilerOptions 下补上:

"types": ["node"]
  • 别只加 @types/node 包却不配 types,那样 VSCode 仍识别不到
  • 如果用了 ESM("type": "module"),还要确认 @types/node 版本 ≥ 18.11.9,老版本不兼容 import fs from 'fs'
  • VSCode 的 TypeScript 服务器有时缓存旧配置,改完 tsconfig.json 后可右键编辑器 → “Restart TS server”

真正卡住人的往往不是逻辑,而是 bin 路径拼错、#!/usr/bin/env node 忘删 BOM、或者 Windows 上 PowerShell 策略拦住了第一行执行——这些点不试一次根本想不到。

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1675

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3672

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2209

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1787

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2667

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1878

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1302

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1176

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

594

5

热门下载

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

精品课程

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