sys-shim 0.0.1-18 → 0.0.1-20

package/package.json

@@ -2,7 +2,7 @@
   "name": "sys-shim",
   "private": false,
   "type": "module",
-  "version": "0.0.1-18",
+  "version": "0.0.1-20",
   "main": "./script/npm-pkg/node/main.min.cjs",
   "module": "./script/npm-pkg/node/main.min.mjs",
   "browser": {
@@ -55,23 +55,6 @@
       "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
     }
   },
-  "scripts": {
-    "release": "release-it prerelease -V --ci",
-    "sys-shim": "node ./script/npm-pkg/bin/index.mjs",
-    "lint": "eslint ./ --format unix",
-    "lint-fix": "eslint ./ --fix --format unix",
-    "dev": "run-p vite run.shim",
-    "main:build": "npx download-cli https://github.com/wll8/sys-shim/releases/download/example/main.exe -o win-api/",
-    "vite": "vite",
-    "test": "vitest",
-    "test:basic": "vitest --reporter=basic",
-    "preview": "vite preview",
-    "gen.npm": "node script/gen.npm.mjs",
-    "gen.npm.push": "cross-env push=yes node script/gen.npm.mjs",
-    "gen.res": "node script/gen.res.mjs",
-    "run.shim": "node script/run.shim.mjs",
-    "prepare": "husky"
-  },
   "devDependencies": {
     "@guolao/vue-monaco-editor": "^1.5.1",
     "@release-it/conventional-changelog": "^8.0.1",
@@ -92,7 +75,6 @@
     "release-it": "^17.2.1",
     "rollup": "^4.17.2",
     "rpc-websockets": "^7.6.0",
-    "sys-shim": "link:",
     "vite": "^5.0.0",
     "vitest": "^1.6.0",
     "vue": "^3.3.8"
@@ -101,8 +83,26 @@
     "dayjs": "^1.11.11",
     "download": "^8.0.0",
     "filenamify": "^6.0.0",
+    "iconv-lite": "^0.6.3",
     "minimist": "^1.2.8",
     "shelljs": "^0.8.5",
-    "shx": "^0.3.4"
+    "shx": "^0.3.4",
+    "sys-shim-bin": "0.0.2-2"
+  },
+  "scripts": {
+    "release": "release-it prerelease -V --ci",
+    "sys-shim": "node ./script/npm-pkg/bin/index.mjs",
+    "lint": "eslint ./ --format unix",
+    "lint-fix": "eslint ./ --fix --format unix",
+    "dev": "run-p vite run.shim",
+    "main:build": "npx download-cli https://github.com/wll8/sys-shim/releases/download/example/main.exe -o win-api/",
+    "vite": "vite",
+    "test": "vitest",
+    "test:basic": "vitest --reporter=basic",
+    "preview": "vite preview",
+    "gen.npm": "node script/gen.npm.mjs",
+    "gen.npm.pack": "cross-env pack=yes node script/gen.npm.mjs",
+    "gen.res": "node script/gen.res.mjs",
+    "run.shim": "node script/run.shim.mjs"
   }
-}
+}

package/readme.md

@@ -1,110 +1,38 @@
-<div align="center">
-    <a href="https://github.com/wll8/sys-shim/blob/pre/doc.md">
-        文档
-    </a>
-  &nbsp;|&nbsp;
-    <a href="https://github.com/wll8/sys-shim/releases/tag/example">
-        示例
-    </a>
-</div>
+# sys-shim-sdk
 
-<br />
+## 开发
 
-简单的使用前端语言即可快速开发桌面程序，程序体积小于 1M。
+```bat
+:: 启动服务端
+npm run sys-shim
 
-## 为什么
+:: 启动前端
+npx vite
 
-想开发一个简单的桌面程序，只使用前端语言开发，暂只考虑在 windows 上运行，希望开发体验像在浏览器中一样，然后程序的样子像是本地应用一样，调用本地文件、系统命令、后台运行、托盘菜单这些都没有问题。
-
-[调研了一些常见的方案](#方案对比)，发现他们都不适合，所以就开发了此项目 。
-
-## 如何使用
-
-### 方式一：直接开发
-
-这个方式适用于体验，无需任何开发环境。
-
-- 第一步：下载 [main](https://github.com/wll8/sys-shim/releases/download/example/main.exe) 文件打开；
-- 第二步：当前目录生成了名为 page.html 的文件，你可以在这个文件里写界面或调用系统 API 。
-
-### 方式二：单独引用
+:: debug sdk
+npm run sys-shim pack -- --input https://example.com/
+```
 
-- 安装:  `npm i sys-shim`
-- 导入: 
-  - esm 方式 `import Sys from 'sys-shim'`
-  - cjs 方式 `const Sys = require('sys-shim')`
-  - umd 方式 `<script src="./node_modules/sys-shim/browser/main.umd.min.js"></script>`
-- 使用:
+## 使用
 
 ``` js
-new Sys('ws://127.0.0.1:10005?token=tokentokentoken').then(main => {
-  main.native.win.msgbox(`hello`, `title`)
+// npm i sys-shim
+
+import Sys from 'sys-shim'
+new Sys({
+  log: true,
+  wsUrl: 'ws://127.0.0.1:10005?token=tokentokentoken',
+}).then(shim => {
+  shim.native.process(`notepad`) // 调用系统记事本
 })
 ```
 
-### 方式三：使用脚手架模板开发
-
-- [命令行](https://wll8.github.io/sys-shim-doc/docs/cli/sys-shim.html)
-- 服务
-- 界面
-
-
-## 贡献
-
-如果你想参与这个项目的开发。
-
-node v18.19.0
+## 发布
 
 ``` bat
-rem 安装依赖
-pnpm i
-
-rem 生成库文件 sys.js
-pnpm gen.res
-
-rem 获取 main.exe, 可以通过编译或下载得到
-pnpm main:build
-
-rem 启动项目
-pnpm dev
-
-rem 发布 npm
-pnpm gen.npm.push
+:: 生成 sdk 到 /store/bin/res
+npm run gen.res
 
+:: 生成 npm 包
+npm run gen.npm.pack
 ```
-
-## todo
-
-- [ ] fix: 当端口变更后，localstorage 等信息可能丢失
-  - https://github.com/tauri-apps/tauri/issues/896
-  - https://github.com/tauri-apps/tauri/commit/0d63732b962e71b98430f8d7b34ea5b59a2e8bb4?diff=split&w=0
-  - https://github.com/tauri-apps/tauri/blob/9f75d06228fcb7036cf7a4e215abc7bc8d1a0a56/tooling/api/src/webview.ts#L613
-  - https://github.com/maemon4095/tauri-custom-protocol
-  - https://github.com/tauri-apps/tauri/issues/6330
-  - https://docs.rs/tauri/latest/tauri/struct.Builder.html#method.register_uri_scheme_protocol
-  - https://github.com/tauri-apps/tauri/issues/323
-  - https://github.com/tauri-apps/wry/pull/65/files#diff-72a48c45fe590fb0a06f7e3635f417381ea5199505b3e8f706a54ec39211d5e1R99
-  - https://www.electronjs.org/docs/latest/api/protocol#protocolregisterschemesasprivilegedcustomschemes
-  - https://github.com/MicrosoftEdge/WebView2Feedback/issues/73
-- [ ] feat: buffer 自动转换
-- [ ] fix: 应正确接收稀疏返回值
-  - 例如： `return {1, null, 3}` 
-- [ ] feat: 流式传输数据
-  - 例如： 实时向 native 保存下载的数据
-- [ ] refactor: 整理代码
-  - [ ] 统一文档和代码中 sys-shim 的全局名称为 Sys, 实例化名称为 shim
-  - [ ] 移除代码中的全局名称引用, 登录 window.msg, window.sys 使用当前 this 实现获取引用
-  - [ ] 替换 doc.md 的内容为文档站点地址
-  - [ ] 移除 App.js 中的用例
-- [ ] feat: 自动从终端输出中读取 url 入口
-- [ ] doc: 更新文档
-  - [ ] 安装
-    - [ ] 通过 main
-    - [ ] 通过 nodejs
-  - [ ] 使用本地前端代码
-  - [ ] 使用线上 url 链接
-  - [ ] 集成到正在开发的前端项目
-  - [ ] 打包
-  - [ ] 使用
-    - [ ] 发布给用户
-      - [ ] 报毒：因为软件的性质问题，会被误报，等到达 v1.0.0 版本之后，会向各安全平台提交核验申请，在此之前可以要求用户关闭杀毒软件或配置白名单，或自己向安全平台提审。

package/script/npm-pkg/bin/index.mjs

@@ -7,21 +7,41 @@ import { fileURLToPath } from 'node:url'
 import process from 'node:process'
 import minimist from 'minimist'
 import {fn as pack} from './pack.mjs'
+import { getPath } from 'sys-shim-bin'
 
+const binPath = getPath()
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
+const pkgPath = `${__dirname}/../../../`
 
-const cwd = `${__dirname}/../shim/win`
+const cwd = `${pkgPath}/script/npm-pkg/shim/win`
+const pkg = JSON.parse(fs.readFileSync(`${pkgPath}/package.json`, `utf8`))
 const argv = minimist(process.argv.slice(2))
 const argv0 = argv._[0]
 
 new Promise(async () => {
+  printLogo()
   if(argv0 === `pack`) {
     await pack(argv)
   } else {
-    cp.execSync(`${cwd}/main.exe`, {
+    cp.execSync(binPath, {
       cwd,
       stdio: `inherit`,
     })
   }
 })
+
+
+function printLogo() {
+  const vTag = `version: `
+  const logText = fs.readFileSync(`${__dirname}/logo.txt`, `utf8`)
+  const versionLogo = logText.replace(new RegExp(`(${vTag})(.*)`), (match, $1, $2) => {
+    const vStr = pkg.version
+    const vLength = vStr.length
+    const vLine = vLength > $2.length // 如果版本号替换到版本标志后面
+      ? `${$1}${vStr}`
+      : match.replace(new RegExp(`(${vTag})(.{${vLength}})`), `$1${vStr}`)
+    return vLine
+  })
+  console.log(versionLogo)
+}

package/script/npm-pkg/bin/logo.txt

@@ -0,0 +1,9 @@
+                           _     _           
+version: 0.0.0            | |   (_)          
+  ___ _   _ ___ ______ ___| |__  _ _ __ ___  
+ / __| | | / __|______/ __| '_ \| | '_ ` _ \ 
+ \__ \ |_| \__ \      \__ \ | | | | | | | | |
+ |___/\__, |___/      |___/_| |_|_|_| |_| |_|
+       __/ |                                 
+      |___/     
+                                             

package/script/npm-pkg/bin/pack.mjs

@@ -7,10 +7,14 @@ import os from 'node:os'
 import filenamify from 'filenamify'
 import download from 'download'
 import shelljs from 'shelljs'
+import iconv from 'iconv-lite'
 import {
   simpleTemplate,
 } from '../../../src/util.js'
 import process from 'node:process'
+import { getPath } from 'sys-shim-bin'
+
+const binPath = getPath()
 
 const __filename = url.fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -90,7 +94,7 @@ function zip(cfg) {
   const icon = cfg.icon
   const out = cfg.out
   const input = cfg.input
-  const unzip = cfg.unzip
+  const unzip = (cfg.unzip || ``).replace(/\//g, `\\`)
   const nameSuffix = cfg.nameSuffix
 
   /**
@@ -106,14 +110,15 @@ function zip(cfg) {
   const comment = (() => {
     const file = `${os.tmpdir()}/comment.txt`
     const text = `
-      Path=${path.normalize(unzip)}
+      Path=${unzip}
       Setup=main
       Silent=1
       Overwrite=1
       Update=U
       Shortcut=D, main, , "sys-shim app", "${cfg.out}", favicon.ico
     `.split(`\n`).map(item => item.trim()).join(`\n`).trim()
-    fs.writeFileSync(file, text)
+    const gbkText = iconv.encode(text, `gbk`)
+    fs.writeFileSync(file, gbkText)
     return file
   })()
 
@@ -136,6 +141,7 @@ function zip(cfg) {
   const outName = nameSuffix ? `${out}-${dayjs(Date.now()).format(`YYYY-MM-DD-HH-mm-ss`)}` : out
   const cmd = `"${zipBin}" a -r -ep1 -y -ibck -sfx -iicon"${icon}" -z"${comment}" "${outName}" "${input}/*"`
   cp.execSync(cmd, {stdio: `inherit`})
+  return outName
 }
 
 function getIndex(cfg) {
@@ -155,16 +161,21 @@ function genFile(cfg) {
   shelljs.rm(`-fr`, newCfg.input)
   shelljs.mkdir(`-p`, newCfg.input)
   shelljs.cp(`-fr`, `${pkgDir}/template/pack/*`, newCfg.input)
-  shelljs.cp(`-f`, `${pkgDir}/script/npm-pkg/shim/win/main.exe`, newCfg.input)
+  shelljs.cp(`-f`, binPath, newCfg.input)
   shelljs.cp(`-f`, `${pkgDir}/script/npm-pkg/shim/win/favicon.ico`, newCfg.input)
   shelljs.cp(`-f`, cfg.icon, `${newCfg.input}/favicon.ico`)
   determinePathType(cfg.input) !== `url` && fs.statSync(cfg.input).isDirectory() && shelljs.cp(`-fr`, `${cfg.input}/*`, newCfg.input)
+  let runConfig = {}
   if(fs.existsSync(`${cfg.input}/package.json`) === false) {
     const newStr = simpleTemplate(fs.readFileSync(`${newCfg.input}/package.json`, `utf8`), {
       page: getIndex(cfg),
     })
     fs.writeFileSync(`${newCfg.input}/package.json`, newStr)
+    runConfig = JSON.parse(newStr)
+  } else {
+    runConfig = require(`${cfg.input}/package.json`)
   }
+  console.log(`Runtime configuration:`, runConfig)
   return newCfg
 }
 
@@ -174,7 +185,7 @@ export async function fn(argv) {
   const {input, icon} = genFile(cfg)
   cfg.input = input
   cfg.icon = icon
-  console.log(cfg)
-  await zip(cfg)
-
+  console.log(`Program build parameters:`, cfg)
+  const name = await zip(cfg)
+  console.log(`Build results:`, [`${name}.exe`])
 }