框架
工作流
新建扩展

创建一个新的扩展

要运行交互式初始化向导,请使用以下命令:

pnpm create plasmo
# 或者
yarn create plasmo
# 或者
npm create plasmo

要跳过命名提示,可以将名称作为位置参数提供:

pnpm create plasmo "我的精彩扩展"
# 或者
yarn create plasmo "我的精彩扩展"
# 或者
npm create plasmo "我的精彩扩展"

注意: 您可以使用 pnpm i -g plasmo 安装 plasmo CLI 作为全局命令(将 pnpm 替换为您喜欢的包管理器)。

使用 src 目录

默认情况下,Plasmo 期望所有源代码都在根目录中。但是,您可以按照此指南使用 src 目录作为源代码的存放位置。

使用特定的入口文件

默认项目仅包含一个 弹出窗口 入口文件。但是,您可以通过使用 entry 标志和逗号分隔的入口文件列表来自定义此行为,以在初始项目中包含所需的入口文件。

要使用此标志,请选择您希望在项目中看到的入口文件,省略其文件扩展名,并将其提供给 --entry 标志:

有许多入口文件可供选择。请查看此目录 (opens in a new tab),了解所有可用的入口文件。

pnpm create plasmo --entry=options,newtab,contents/inline
# 或者
npm create plasmo -- --entry=options,newtab,contents/inline

上述命令将创建一个包含 选项页面新标签页内联内容脚本UI 的项目。

⚠️

注意: npm 不会将参数传递给其子命令。因此,在指定 plasmo 的参数和标志之前,必须提供 -- 来转义 npm

使用示例模板

更强大的功能是,Plasmo 可以基于我们提供的示例 (opens in a new tab)之一创建新项目。选择一个示例,并在运行 create plasmo 命令时使用其名称作为标志:

pnpm create plasmo --with-env
# 或者
npm create plasmo -- --with-env

上述命令将生成一个使用 with-env (opens in a new tab) 示例的项目。