industrial-splash-cli
v0.1.1
Published
CLI for generating splash images for fixed-resolution industrial landscape displays.
Downloads
229
Maintainers
Readme
industrial-splash-cli
用于固定分辨率工控横屏设备的启动图生成 CLI。
当前版本只面向这两套横屏分辨率:
1280x8001920x1080
它的定位很明确:
- 输入一张透明底 logo
- 生成预览图
- 按需导出 Android
res资源
不做通用手机竖屏自适配,也不默认绑定某个具体 Android 工程目录。
安装
npm install industrial-splash-cli或:
pnpm add industrial-splash-cli如果只是临时执行,也可以直接用:
npx industrial-splash --help初始化配置
在你的项目目录执行:
npx industrial-splash --init会生成:
industrial-splash.config.jsonbranding/README.txt
如果需要覆盖已有文件:
npx industrial-splash --init --force生成启动图
交互式选择分辨率:
npx industrial-splash跳过交互,直接指定目标分辨率:
npx industrial-splash --target 1280x800导出到 Android res
默认只写入当前项目的 output 目录。
如果你还想额外导出到 Android 原生工程的 res 目录:
npx industrial-splash --target 1920x1080 --android-res-dir ./app/src/main/res会额外生成:
drawable-nodpi/splash.pngdrawable-land-nodpi/splash.png
输出结构
默认输出目录为 output/<target>/:
preview/splash.pngandroid-res/drawable-nodpi/splash.pngandroid-res/drawable-land-nodpi/splash.png
配置说明
industrial-splash.config.json 字段说明:
logoPath:logo 图片路径backgroundColor:背景色outputDir:输出目录androidQualifier:Android 方向限定符,默认landrenderDefaults.logoMaxWidthRatio:logo 最大宽度占比renderDefaults.logoMaxHeightRatio:logo 最大高度占比renderDefaults.offsetX:水平方向偏移renderDefaults.offsetY:垂直方向偏移targets:固定分辨率列表
本地开发
在包目录执行:
npm install
npm run pack:check
npm run release:check说明:
pack:check用于检查最终打包内容release:check用于模拟npm publish前的发布校验
发布到 npm
发布前检查
先进入包目录:
cd scripts/industrial-splash-cli确认包名是否可用:
npm view industrial-splash-cli name version如果返回 E404 Not Found,通常表示这个包名当前不存在,可以继续发布。
确认你已经登录 npm:
npm whoami如果还没登录:
npm login执行发布前检查:
npm install
npm run pack:check
npm run release:check首次发布
如果继续使用当前非 scoped 包名:
npm publish如果你后面改成 scoped 包名,例如:
{
"name": "@your-npm-username/industrial-splash-cli"
}那就发布为公开包:
npm publish --access public当前包已经带了:
publishConfig.access = publicnpm run publish:public
所以 scoped 包也可以直接执行:
npm run publish:public后续发新版本
修改代码后,先升级版本号:
npm version patch也可以按需要使用:
npm version minor
npm version major然后重新发布:
npm publish或:
npm run publish:public发布成功后验证
发布完成后,可以在 npm 网站查看:
https://www.npmjs.com/package/industrial-splash-cli或执行:
npm view industrial-splash-cli version