俄、西、西、俄
E 国家一.O.N
德克萨斯州
法、俄、西、西、西
@ bedframe/ cli (英语)
Bedframe 命令行接口(CLI)允许您从终端直接制作和管理您的 BED .
安装
节点版本要求
Bedframe CLI 要求 节点.js 18+. 20+ 的版本. 您可以管理同一机上的多版节点 无, (中文(简体) ), 数字 或者说 nvm 窗口。 。 。 .
# with bun
bun add @bedframe/cli -g
# with pnpm
pnpm add @bedframe/cli -g
# with npm
npm install @bedframe/cli -g
# with yarn
yarn add @bedframe/cli -g
安装后,您可以访问 bedframe 在命令行中可执行 。 您可以通过简单的运行验证其安装是否正确 bedframe,它应该给你一个介绍和帮助信息.
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
@bedframe/cli v0.0.78
Usage: @bedframe/cli [options] [command]
Bedframe CLI - your Browser Extension Development framework (dev utility)
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
make [options] [name] make your B E D
version [options] create or update git release of current version (changeset version)
publish [options] publish new or update existing extension(s)
- chrome: Chrome Web Store (C W S)
- firefox: Mozilla/Firefox Add-ons (A M O)
- edge: MS Edge Add-ons (M E A)
dev [browsers] start Vite dev server for one or more browsers concurrently
build [browsers] generate prod builds for 1 or more browsers concurrently
zip [options] [browsers] zip browser dist directories
help [command] display help for command
您可以用此命令检查您的版本是否正确 :
bedframe --version
做你的床单
为了建立一个新的床架项目,运行:
bedframe make
那就跟随提示!
您可以指定 project name 作为第一个论点 make 命令。 使用 . 联 合 国 project name 将在当前目录中脚手架工程.
# scaffold project called `chrome-extension`
bedframe make chrome-extension
# scaffold project in the current directory
bedframe make .
然后您会被提示配置您的 BED, 选择 Framework, (中文(简体) ), Language, (中文(简体) ), Browser 用于目标等。 所有配置在生成项目后都可以被手动编辑.
图标
医生
基准 make 命令将您通过创建 Vite 驱动的、 prod- ready 浏览器扩展环境: 一个代码库 同步部署到版本控制, 并自动发布到所有浏览器商店( 目前为 Chrome, Firefox, and Edge) .
最终你有一个熟悉的维特动力项目 你习惯了.
运行 make 命令以启动工程 gen 提示.
或者: 此命令作为独立命令也可以使用 create-bedframe 软件包.
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
@bedframe/cli v0.0.78
Usage: @bedframe/cli make [options] [name]
make your B E D
Arguments:
name project name
Options:
-b, --browsers <browsers> comma-separated list browsers (chrome, edge, firefox, etc)
-v, --version <version> project version (0.0.1)
-d, --description <description> project description
-a, --author <author> project author (name, email, url)
--license <license> project license (MIT)
-r, --private visibility of project (true)
-t, --type <type> extension type (popup)
--override <override> page to override (newtab)
--options <options> whether to and how render options (embedded)
-p, --packageManager <packageManager> package manager to use (pnpm)
-f, --framework <framework> framework to use (react)
-l, --language <language> language to use (typescript)
-s, --style <style> css framework to use (tailwind)
-o, --lintFormat add linting with formatting (true)
-e, --tests add tests (vitest + testing library) (true)
-g, --git initialize git for source control (true)
-h, --gitHooks use git hooks (true)
-c, --commitLint use commit linting (true)
-x, --changesets use changesets (true)
-i, --installDeps install dependencies (true)
-y, --yes make your BED w/ preconfigured defaults (false)
--help display help for command
参数
名称
国家行动倡议 name 参数集表' name 属性(需要),它是一个简短的文本字符串(最多45个字符),用来识别扩展名。 例如:
{
"name": "My extension name"
}
您可以指定特定区域字符串;参见 国际化 详细情况.
它在下列地点展出:
- 安装对话框
- 扩展页(chrome://extensions)
- Chrome 网页存储器
另见 简称。 。 。 .
标记/ 选项
你可以随意通过提示 如果你用必要的旗帜通过到 make 命令.
例如,要脚手架一个多扩展项目,即针对Chrome、Brave、Opera和Edge浏览器的BED环境,你可以运行:
$ bedframe make multi-extension-project \
--browsers 'chrome, firefox, safari, brave, opera, edge' \
--version '0.0.0' \
--description 'this is my BED! there are many like it, but this one is... MINE!!!' \
--author 'joe, [email protected], https://bedframe.dev' \
--license MIT \
--private \
--type overlay \
--override newtab \
--options embedded \
--packageManager bun \
--framework react \
--language typescript \
--style tailwind \
--lintFormat \
--tests \
--git \
--gitHooks \
--commitLint \
--changesets \
--installDeps
如果所需的配置没有通过 flags cLI会催促你满足缺失的要求.
选项
| 旗帜( 短) | 旗帜( 长) | 类型 | 说明 | 默认 |
|---|---|---|---|---|
| -五岁 | --版本 | 字符串 | 指定项目版本 | 0.0.1 资源 |
| -b - 说 | -- 浏览器 | 浏览器[] | 指定以逗号分隔的目标浏览器列表 | 铬 |
| - p | -- 包装管理器 | 软件包管理器 | 指定要使用的软件包管理器 | 线条 |
| -f - (英语) | --框架 | 框架 | 指定要使用的框架 | 反应 |
| -и琌 | -- 语言 | 语言 | 指定要使用的语言 | 类型标记 |
| -对 | --样式 | 样式 | 指定要使用的 CSS 解决方案 | 尾风 |
| - 欧 | --lint 格式 | 布尔 | 配置有格式的嵌入 | 真实 |
| - g | --git (英语) | 布尔 | 初始化 git 源控件 | 真实 |
| - 嘘 | -- gitHooks (英语) | 布尔 | 添加 git 钩子( Husky + lint 相机) | 真实 |
| - 号 | 测试 | 布尔 | 添加测试( Vitest + 测试库 + jsdom) | 真实 |
| - c , 说 | -- 承诺提示 | 布尔 | 添加内嵌承诺 | 真实 |
| - 轴 | -- 变换集 | 布尔 | 添加更改 | 真实 |
| -и琌 | - 安装终端 | 布尔 | 添加并安装依赖性( S) | 真实 |
| -对 | - 对 | 布尔 | 设置 Bedframe w/ 预配置默认值 | 虚假 |
| -- 帮助 | 显示命令的帮助 |
软件包管理器
从npm,纱线或pnpm中选择版本
这个 version 通过Bedframe CLI制作命令旗(-v, --version)或通过迅速反应确定 version 用于您的项目包。json 和项目扩展的(一个或多个)清单.
说明
`version' in current.json 中的`version' 并非 semverer,而pakge.json 中的`version' 必须是用 节点集成器如果您在项目中发现两者需要不同,您也可以通过版本名称标记(`-versionName'),这是软件包中使用的 semVer-valid `version'。json 和表单中的`version name'.
1到4个点相分离的整数,表示这个扩展的版本. 几条规则适用于整数:
整数必须在 0 财务报告和审定财务报表 65535,包含.
非零整数不能从 0。例如, 032 无效,因为它以零开头.
它们不能全部为零。 譬如说, 0 财务报告和审定财务报表 0.0.0.0 无效时 0.1.0.0 无效.
以下是一些有效版本的例子:
"version": "1""version": "1.0""version": "2.10.2""version": "3.1.2.4567"
如果所发布的扩展比所安装的扩展拥有更新的版本字符串,那么扩展就会被自动更新.
比较从最左边的整数开始. 然后,如果这些整数是相等的,那么对右边的整数进行比较,等等. 譬如说, 1.2.0 是一个比 1.1.9.9999。 。 。 .
缺少整数等于零。 譬如说, 1.1.9.9999 较新 1.1,以及 1.1.9.9999 年龄大于 1.2。 。 。 .
浏览器
框架
语言
样式
文本格式
gi
图形
测试
承诺
变化
安装密码
对
帮助
欧、俄、西、西、北
创建或更新当前版本的 git 发布
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
Usage: @bedframe/cli version [options]
create or update git release of current version (changeset version)
Options:
--ignore <package> skip a package from being published
--snapshot create a snapshot release for testing
-h, --help display help for command
P U B L I S H
发布新的或更新现有的扩展名
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
Usage: @bedframe/cli publish [options]
• publish new or update existing extension(s)
├ • C W S: Chrome Web Store
├ • A M O: Mozilla/Firefox Add-ons
└ • M E A: MS Edge Add-ons
Options:
-b, --browsers <browsers...> specify browsers to publish (chrome,firefox,edge)
-h, --help display help for command
D-E-五级
为 1 个或更多浏览器启动 vite dev 服务器 .
vite dev w/ --mode <浏览器>的别名
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
Usage: @bedframe/cli dev [options] [browsers]
start Vite dev server for one or more browsers concurrently
Options:
-h, --help display help for command
> bedframe dev
6 BEDs starting vite dev server! 🚀
└ dist/
├ brave/
├ chrome/
├ edge/
├ firefox/
├ opera/
└ safari/
B U I L D (英语)
为 1 个或更多浏览器生成 prod 构建
vite 构建w/ --mode < browser > 的别名
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
Usage: @bedframe/cli build [options] [browsers]
generate prod builds for 1 or more browsers concurrently
Options:
-h, --help display help for command
页:1
为 1 个或更多浏览器创建 zip 归档
命令细节
>_
B R O W S E R
E X T E N S I O N
D E V E L O P M E N T
F R A M E W O R K
Usage: @bedframe/cli zip [options] [browsers]
zip browser dist directories
Arguments:
browsers list of browser names
Options:
-d, --distDir <distDir> current dist dir to create archive from (e.g. -d
./dist/<browser>)
-n, --name <name> what to name the zip file (including .zip)
-h, --help display help for command