@widget-js/cli 24.1.1-beta.15 → 24.1.1-beta.17

package/src/index.ts

@@ -1,65 +0,0 @@
-import fs from 'node:fs'
-import path from 'node:path'
-import * as process from 'node:process'
-import { Option, program } from 'commander'
-
-import figlet from 'figlet'
-import gradient from 'gradient-string'
-import { dirname } from 'dirname-filename-esm'
-
-//
-const packageJsonPath = path.join(dirname(import.meta), '../package.json')
-const cliPackage = JSON.parse(fs.readFileSync(packageJsonPath).toString())
-// eslint-disable-next-line no-console
-console.log(gradient.pastel.multiline(figlet.textSync('widget-cli', { horizontalLayout: 'full' })))
-program.version(`@widget-js/cli ${cliPackage.version}`).usage('<command> [options]')
-program
-  .command('create')
-  .description('Create new widget')
-  .action(async () => {
-    const createWidget = await import('./createWidget')
-    await createWidget.default()
-  })
-
-const dependenciesOption = new Option('-t, --type <type>').choices(['remote', 'local'])
-
-program
-  .command('dependencies')
-  .description('Set @widget-js dependencies to local(workspace:*) or remote(^1.0.0 etc)')
-  .addOption(dependenciesOption)
-  .action(async (options) => {
-    const dependencies = await import('./dependencies/index')
-    await dependencies.default(options)
-  })
-
-program
-  .command('init')
-  .description('Initialize widget-js project')
-  .action(async () => {
-    const init = await import('./init/init')
-    await init.init()
-  })
-
-const keyOption = new Option('-k, --key <key>')
-program
-  .command('publish')
-  .description('Publish widget package with developer key')
-  .addOption(keyOption)
-  .action(async (options) => {
-    const publishImport = await import('./publish/index')
-    await publishImport.publish(options)
-  })
-
-const typeOption = new Option('-t, --type <type>').choices(['ftp', 'oss'])
-const fileOption = new Option('-f, --file <file>')
-program
-  .command('release')
-  .description('通过FTP/OSS发布文件，仅内部使用')
-  .addOption(typeOption)
-  .addOption(fileOption)
-  .action(async (options) => {
-    const release = await import('./release/release')
-    await release.default(options)
-  })
-
-program.parse(process.argv)

package/src/init/init.ts

@@ -1,121 +0,0 @@
-import path from 'node:path'
-import process from 'node:process'
-import fs from 'node:fs'
-import { fileURLToPath } from 'node:url'
-import consola from 'consola'
-import chalk from 'chalk'
-import ora from 'ora'
-import { scanWidgetPackage } from '@widget-js/utils'
-import { Utils } from '../utils'
-import promptChecker from '../promts/promptChecker'
-import { EJSUtils } from '../utils/EJSUtils'
-import { PrettierUtils } from '../utils/PrettierUtils'
-import { WidgetPackageUtils } from '../utils/WidgetPackageUtils'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-const spinner = ora('Loading')
-
-export async function init() {
-  await addDependencies()
-  await addWidgetTs()
-}
-
-async function addWidgetTs() {
-  const name = await promptChecker(
-    {
-      type: 'input',
-      name: 'name',
-      message: chalk.blue('组件包 包名 （示例 cn.widget.countdown）：'),
-    },
-    (answer) => {
-      const name = answer.name
-      if (name == null || name === '') {
-        consola.log(chalk.red(`包名不能为空`))
-        return false
-      }
-      return true
-    },
-  )
-
-  const widgetPackageTs = path.join(process.cwd(), 'widget.package.ts')
-  if (fs.existsSync(widgetPackageTs)) {
-    spinner.info('widget.package.ts已存在，跳过')
-  }
-  else {
-    spinner.info('创建 widget.package.ts')
-    await EJSUtils.renderToFile('WidgetPackage.ejs', widgetPackageTs, 'typescript', { name })
-  }
-
-  await addVitePlugin()
-  await createRouter()
-
-  spinner.succeed('初始化完成，请运行 npm install')
-}
-
-/**
- * 增加widget-js依赖
- */
-async function addDependencies() {
-  const packageJson = Utils.getPackageJson()
-  let dependencies = packageJson.dependencies
-  const devDependencies = packageJson.devDependencies
-  if (!dependencies) {
-    dependencies = {}
-  }
-  if (!devDependencies) {
-    packageJson.devDependencies = {}
-  }
-
-  await addDependency('@widget-js/core', dependencies)
-  await addDependency('@widget-js/vue3', dependencies)
-  await addDependency('@widget-js/vite-plugin-widget', devDependencies)
-
-  packageJson.dependencies = dependencies
-  packageJson.devDependencies = devDependencies
-
-  fs.writeFileSync(Utils.getPackagePath(), JSON.stringify(packageJson, null, 2))
-}
-
-async function addVitePlugin() {
-  spinner.info('添加 vite-plugin-widget 到 vite plugin')
-  const viteConfigPath = path.join(process.cwd(), 'vite.config.ts')
-  if (!fs.existsSync(viteConfigPath)) {
-    spinner.warn('vite.config.ts not exists')
-    return
-  }
-  let viteConfig = fs.readFileSync(viteConfigPath).toString()
-  viteConfig = `import widget from '@widget-js/vite-plugin-widget'\n${viteConfig}`
-  viteConfig = viteConfig.replace('vue()', `vue(),widget()`)
-  fs.writeFileSync(viteConfigPath, await PrettierUtils.format(viteConfig, 'typescript'))
-}
-
-async function createRouter() {
-  const widgetPackage = await scanWidgetPackage()
-  if (widgetPackage) {
-    spinner.info('创建 widget-router.ts')
-    const rootDir = WidgetPackageUtils.getRootDir(widgetPackage)
-    const widgetRouterPath = path.join(rootDir, 'widget-router.ts')
-    const routerContent = fs.readFileSync(path.join(__dirname, '../template/widget-router.ts'), 'utf8')
-    fs.writeFileSync(widgetRouterPath, routerContent)
-
-    const vueRouterPath = path.join(process.cwd(), './src/router/index.ts')
-    spinner.info('修改VueRouter配置')
-    if (fs.existsSync(vueRouterPath)) {
-      let vueRouterContent = fs.readFileSync(vueRouterPath, 'utf8')
-      const importStr = `import WidgetRouter from "../widgets/widget-router";`
-      vueRouterContent = `${importStr}\n${vueRouterContent}`
-      vueRouterContent = vueRouterContent.replace('routes: [', `routes: [\n...WidgetRouter,`)
-      fs.writeFileSync(vueRouterPath, await PrettierUtils.format(vueRouterContent, 'typescript'))
-    }
-  }
-}
-
-async function addDependency(packageName: string, dependencies: any) {
-  spinner.info(`Adding dependencies ${packageName}`)
-  if (dependencies[packageName]) {
-    return
-  }
-  const remoteVersion = await Utils.getRemoteVersion(packageName)
-  dependencies[packageName] = `^${remoteVersion}`
-}

package/src/promts/promptChecker.ts

@@ -1,17 +0,0 @@
-import type { Answers, Question } from 'inquirer'
-import inquirer from 'inquirer'
-
-async function promptChecker<T extends Question>(prompt: T, checker?: (answer: any) => boolean): Promise<any> {
-  const answer: Answers = await inquirer.prompt([prompt])
-  if (checker) {
-    if (checker(answer)) {
-      return answer[prompt.name!]
-    }
-    else {
-      return promptChecker(prompt, checker)
-    }
-  }
-  return answer[prompt.name!]
-}
-
-export default promptChecker

package/src/publish/index.ts

@@ -1,60 +0,0 @@
-import fs from 'node:fs'
-import fastGlob from 'fast-glob'
-import axios from 'axios'
-import consola from 'consola'
-import ora from 'ora'
-/**
- * 用fast-glob扫描运行目录下第一个 widget.json 文件
- * 然后用axios发送post请求到 https://widgetjs.cn/api/widget/package，把key加到请求头中，把 widget.json 文件内容作为请求体
- */
-export async function publish(options: { key: string }): Promise<void> {
-  if (!options.key) {
-    consola.error('Please provide a developer key with -k or --key option.')
-    return
-  }
-  const spinner = ora('Search widget.json').start()
-  try {
-    // Scan the current directory for the first widget.json file, ignore node_modules
-    const files = await fastGlob('**/widget.json', { onlyFiles: true, ignore: ['node_modules/**'], absolute: true })
-    if (files.length === 0) {
-      spinner.fail('No widget.json file found.')
-      return
-    }
-
-    spinner.succeed(`Widget.json found: ${files[0]}`)
-
-    const widgetPath = files[0]
-    const widgetContent = fs.readFileSync(widgetPath, 'utf-8')
-
-    const json = JSON.parse(widgetContent)
-    consola.info(`Package name:${json.name}`)
-    const widgets = json.widgets
-    consola.info(`Widget size:${widgets?.length ?? 0}`)
-
-    spinner.start('Publishing widget package...')
-    // Send a POST request to the specified URL with the widget content
-    const response = await axios.post('https://widgetjs.cn/api/v1/widget/package', json, {
-      headers: {
-        'Content-Type': 'application/json',
-        'Key': options.key,
-      },
-    })
-
-    if (response.data) {
-      if (response.data.code == 200) {
-        spinner.succeed('Widget published successfully.')
-      }
-      else {
-        spinner.fail('Failed to publish widget.')
-        consola.error(response.data.msg)
-      }
-    }
-    else {
-      spinner.fail('Empty Response')
-    }
-  }
-  catch (error) {
-    spinner.fail('Failed to publish widget.')
-    consola.error(error)
-  }
-}

package/src/release/ftp.ts

@@ -1,144 +0,0 @@
-import path from 'node:path'
-import fs from 'node:fs'
-import os from 'node:os'
-import * as process from 'node:process'
-import SSHConfig from '@widget-js/ssh-config'
-import Client from 'ssh2-sftp-client'
-import consola from 'consola'
-import inquirer from 'inquirer'
-import ora from 'ora'
-import { minimatch } from 'minimatch'
-import { Utils } from '../utils'
-
-interface PasswordAnswer {
-  password: string
-}
-
-async function checkParentDir(ftpClient: Client, file: string, onMkdir: (dir: string) => void) {
-  const dir = path.dirname(file)
-  const dirExists = await ftpClient.exists(dir)
-  if (!dirExists) {
-    onMkdir(dir)
-    await ftpClient.mkdir(dir, true)
-  }
-}
-
-async function runSSH(sshConfig: Record<string, string | string[]>, releaseConfig: ReleaseConfig) {
-  consola.info('run ssh:', sshConfig)
-  const answer = await inquirer.prompt<PasswordAnswer>([
-    { type: 'password', name: 'password', mask: '*', message: 'Enter key pair password' },
-  ])
-
-  const ftpClient = new Client()
-  const port = sshConfig.Port
-  const key = fs.readFileSync(path.resolve(os.homedir(), '.ssh/id_rsa'))
-  const spinner = ora('Connecting')
-  try {
-    spinner.start()
-    await ftpClient.connect({
-      host: sshConfig.HostName as string,
-      port: port ? Number.parseInt(port as string) : 22,
-      username: sshConfig.User as string,
-      passphrase: answer.password,
-      privateKey: key,
-    })
-    releaseConfig.fileMap.sort((it1, it2) => (it1.order ?? 0) - (it2.order ?? 0))
-    // upload files
-    for (const item of releaseConfig.fileMap) {
-      if (typeof item.src == 'string') {
-        if (item.remoteCopy) {
-          await checkParentDir(ftpClient, item.dest, (dir) => {
-            spinner.warn(`Create Dir: ${dir}`)
-          })
-          const destExists = await ftpClient.exists(item.dest)
-          if (destExists) {
-            spinner.warn(`Delete exists file:${item.dest}`)
-            await ftpClient.delete(item.dest)
-          }
-          spinner.info(`Copying File: ${item.src} -> ${item.dest}`)
-          await ftpClient.rcopy(item.src, item.dest)
-        }
-        else {
-          const localFile = path.resolve(process.cwd(), item.src as string)
-          if (!item.remoteCopy && !fs.existsSync(localFile)) {
-            spinner.warn(`Skip not exists file:${localFile}`)
-            continue
-          }
-          if (fs.lstatSync(localFile).isDirectory()) {
-            spinner.info(`Uploading Dir: ${localFile} -> ${item.dest}`)
-            await ftpClient.uploadDir(localFile, item.dest, {
-              filter: (filePath: string, isDirectory: boolean): boolean => {
-                if (item.ignorePattern && !isDirectory) {
-                  const fileName = path.basename(filePath)
-                  if (minimatch(fileName, item.ignorePattern)) {
-                    spinner.warn(`Skip file:${filePath}`)
-                    return false
-                  }
-                }
-                return true
-              },
-            })
-          }
-          else {
-            await checkParentDir(ftpClient, item.dest, (dir) => {
-              spinner.succeed(`Create Dir: ${dir}`)
-            })
-
-            spinner.info(`Uploading File: ${localFile} -> ${item.dest}`)
-            await ftpClient.put(localFile, item.dest)
-          }
-        }
-      }
-      else {
-        await ftpClient.put(Buffer.from(JSON.stringify(item.src), 'utf-8'), item.dest)
-      }
-    }
-    spinner.succeed('Files uploaded!')
-    await ftpClient.end()
-  }
-  catch (e) {
-    spinner.fail(`Connection error:${e}`)
-    await ftpClient.end()
-  }
-}
-
-export async function ftpUpload(releaseFile: string = 'release.json') {
-  // 读取
-  const releaseJsonFilePath = path.join(process.cwd(), releaseFile)
-  const packageVersion = Utils.getPackageVersion()
-  consola.info('Package Version:', packageVersion)
-
-  const releaseJson = fs.readFileSync(releaseJsonFilePath).toString().replaceAll('${version}', packageVersion)
-  const releaseConfig = JSON.parse(releaseJson) as ReleaseConfig
-  const sshConfigFile = path.resolve(os.homedir(), '.ssh/config')
-  consola.info('SSH Config File Path:', sshConfigFile)
-  const sshConfigs = SSHConfig.parse(fs.readFileSync(sshConfigFile).toString())
-  for (const host of releaseConfig.ftpConfig.host) {
-    const sshConfig = sshConfigs.compute(host)
-    if (!sshConfig) {
-      consola.error(`SSH config ${releaseConfig.ftpConfig.host} not found`)
-      return
-    }
-    await runSSH(sshConfig, releaseConfig)
-  }
-}
-
-export interface FileMapConfig {
-  src: string | object
-  dest: string
-  remoteCopy: boolean
-  order: number
-  /**
-   * 支持glob、正则表达式
-   */
-  ignorePattern?: string
-}
-
-export interface ReleaseConfig {
-  fileMap: FileMapConfig[]
-  ftpConfig: FTPConfig
-}
-
-export interface FTPConfig {
-  host: string[]
-}

package/src/release/oss.ts

@@ -1,50 +0,0 @@
-import fs from 'node:fs'
-import OSS from 'ali-oss'
-import chalk from 'chalk'
-import consola from 'consola'
-
-const packageData = JSON.parse(fs.readFileSync('./package.json').toString())
-export const AccessKeyID = packageData.oss?.id ?? 'default'
-export const AccessKeySecret = packageData.oss?.secret ?? 'default'
-
-const headers = {
-  // 指定Object的存储类型。
-  'x-oss-storage-class': 'Standard',
-  // 指定Object的访问权限。
-  'x-oss-object-acl': 'public-read',
-  'x-oss-forbid-overwrite': 'false',
-  'Cache-Control': 'no-cache',
-}
-
-const clinet = new OSS({
-  // yourRegion填写Bucket所在地域。以华东1（杭州）为例，Region填写为oss-cn-hangzhou。
-  region: 'oss-cn-hangzhou',
-  // 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
-  accessKeyId: AccessKeyID,
-  accessKeySecret: AccessKeySecret,
-  bucket: 'widget-fun',
-})
-
-export async function put(ossPath: string, file: any) {
-  try {
-    // 填写OSS文件完整路径和本地文件的完整路径。OSS文件完整路径中不能包含Bucket名称。
-    // 如果本地文件的完整路径中未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件。
-    await clinet.put(ossPath, file, { headers })
-    consola.log(chalk.green(`上传成功：${file}->${ossPath}`))
-  }
-  catch (e) {
-    consola.log(e)
-  }
-}
-
-export async function copy(dist: string, src: string) {
-  try {
-    // 填写OSS文件完整路径和本地文件的完整路径。OSS文件完整路径中不能包含Bucket名称。
-    // 如果本地文件的完整路径中未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件。
-    await clinet.copy(dist, src, { headers })
-    consola.log(chalk.green(`复制成功：${src}->${dist}`))
-  }
-  catch (e) {
-    console.error(e)
-  }
-}

package/src/release/release.ts

@@ -1,70 +0,0 @@
-import fs from 'node:fs'
-import path from 'node:path'
-import { Buffer } from 'node:buffer'
-import chalk from 'chalk'
-import consola from 'consola'
-import promptChecker from '../promts/promptChecker.js'
-import zipDirectory from './update-zip.js'
-import { copy, put } from './oss.js'
-import { ftpUpload } from './ftp'
-
-async function release(options: any) {
-  if (options.type == 'ftp') {
-    await ftpUpload(options.file)
-    return
-  }
-  const packageJSON = JSON.parse(fs.readFileSync('package.json', 'utf-8'))
-  const changelogJSON = JSON.parse(fs.readFileSync('changelog.json', 'utf-8'))
-  const version = packageJSON.version
-  const changelog = changelogJSON[version]
-
-  const needUpdateElectron = await promptChecker({
-    type: 'confirm',
-    name: 'electron',
-    message: chalk.blue('用户是否需要更新Electron?'),
-  })
-  //
-  // let needUpdateNodeModule = await promptChecker({
-  //     type: "confirm",
-  //     name: 'electron',
-  //     message: chalk.blue("用户是否需要更新node_module?")
-  // });
-
-  const versionInfo = {
-    version,
-    releaseNote: changelog,
-    updateElectron: needUpdateElectron,
-    updateNodeModule: false,
-    updateWindowsApi: false,
-    downloadLink: '',
-  }
-
-  let installerPath = path.join(`./dist/widgets-${version}-setup-win-x64.exe`)
-  if (!fs.existsSync(installerPath)) {
-    installerPath = path.join(`./dist/electron-${version}-setup-win-x64.exe`)
-  }
-  if (!fs.existsSync(installerPath)) {
-    installerPath = path.join(`./dist/app-${version}-setup-win-x64.exe`)
-  }
-  const updateZipPath = path.join(`./dist/update.zip`)
-
-  consola.log(chalk.blue('压缩更新文件中'))
-  await zipDirectory('./release', updateZipPath)
-
-  consola.log(chalk.blue('上传installer.exe到OSS'))
-  await put('version/installer.exe', installerPath)
-
-  consola.log(chalk.blue('上传update.zip到OSS'))
-  await put('version/update.zip', updateZipPath)
-
-  consola.log(chalk.blue('更新版本信息'))
-  versionInfo.downloadLink = 'https://widget-fun.oss-cn-hangzhou.aliyuncs.com/version/update.zip'
-  const versionJSON = JSON.stringify(versionInfo, null, 2)
-  await put('version/version.json', Buffer.from(versionJSON))
-
-  await Promise.all([copy(`version/history/${version}.exe`, 'version/installer.exe'), copy(`version/history/update-${version}.zip`, 'version/update.zip')])
-
-  consola.log(chalk.yellow(versionJSON))
-}
-
-export default release

package/src/release/update-zip.ts

@@ -1,23 +0,0 @@
-import fs from 'node:fs'
-import archiver from 'archiver'
-
-function zipDirectory(sourceDir: string, outPath: string, ignoreDir?: string[]) {
-  const archive = archiver('zip', { zlib: { level: 9 } })
-  const stream = fs.createWriteStream(outPath)
-
-  return new Promise<void>((resolve, reject) => {
-    const ignore: string[] = ['node_modules/**']
-    if (ignoreDir) {
-      ignore.push(...ignoreDir)
-    }
-    archive
-      .glob('**/*', { cwd: sourceDir, ignore })
-      .on('error', err => reject(err))
-      .pipe(stream)
-
-    stream.on('close', () => resolve())
-    archive.finalize()
-  })
-}
-
-export default zipDirectory

package/src/utils/EJSUtils.ts

@@ -1,18 +0,0 @@
-import path from 'node:path'
-import fs from 'node:fs'
-import type { Data } from 'ejs'
-import ejs from 'ejs'
-import type { BuiltInParserName } from 'prettier'
-import { dirname } from 'dirname-filename-esm'
-import { PrettierUtils } from './PrettierUtils'
-
-export class EJSUtils {
-  static async renderToFile(templateFile: string, outputFile: string, parser: BuiltInParserName, renderOptions: Data) {
-    const defineTemplatePath = path.join(dirname(import.meta), '../template', templateFile)
-    const defineTemplate = fs.readFileSync(defineTemplatePath, 'utf8')
-    // Format the EJS code using Prettier
-    const code = ejs.render(defineTemplate, renderOptions)
-    const formattedEJSCode = await PrettierUtils.format(code, parser)
-    fs.writeFileSync(outputFile, formattedEJSCode)
-  }
-}

package/src/utils/PrettierUtils.ts

@@ -1,12 +0,0 @@
-import type { BuiltInParserName } from 'prettier'
-import { format } from 'prettier'
-
-export class PrettierUtils {
-  static async format(code: string, parser: BuiltInParserName) {
-    return format(code, {
-      parser,
-      tabWidth: 2,
-      singleQuote: true,
-    })
-  }
-}

package/src/utils/WidgetPackageUtils.ts

@@ -1,13 +0,0 @@
-import path from 'node:path'
-import fs from 'node:fs'
-import type { WidgetPackage } from '@widget-js/core'
-
-export class WidgetPackageUtils {
-  static getRootDir(widgetPackage: WidgetPackage) {
-    const widgetRootDir = path.join(process.cwd(), widgetPackage.devOptions?.folder ?? './src/widgets')
-    if (!fs.existsSync(widgetRootDir)) {
-      fs.mkdirSync(widgetRootDir, { recursive: true })
-    }
-    return widgetRootDir
-  }
-}

package/src/utils.ts

@@ -1,84 +0,0 @@
-import path from 'node:path'
-import process from 'node:process'
-import fs from 'node:fs'
-import packageJson from 'package-json'
-
-export const widgetPackages: { [key: string]: string } = {
-  '@widget-js/core': '',
-  '@widget-js/vue3': '',
-  '@widget-js/cli': '',
-  '@widget-js/utils': '',
-  '@widget-js/vite-plugin-widget': '',
-}
-export default function exit(code: number = 0) {
-  if (exports.exitProcess) {
-    process.exit(code)
-  }
-  else if (code > 0) {
-    throw new Error(`Process exited with code ${code}`)
-  }
-}
-
-export function getPackagePath() {
-  return path.join(process.cwd(), 'package.json')
-}
-
-export class Utils {
-  static async getRemoteVersion(packageName: string): Promise<string> {
-    const metadata = await packageJson(packageName)
-    const version = metadata.version
-    return version as string
-  }
-
-  static getPackagePath() {
-    return path.join(process.cwd(), 'package.json')
-  }
-
-  static getPackageJson() {
-    return JSON.parse(fs.readFileSync(this.getPackagePath()).toString())
-  }
-
-  static getPackageVersion() {
-    return this.getPackageJson().version
-  }
-
-  /**
-   * 检查包名是否合法，包名格式一般为 倒置域名与java包类似
-   * 1.只能包含小写字母、数字、下划线、小数点。
-   * 2.不能以小数点结尾
-   * 3.不能包含连续的小数点
-   * @param name
-   */
-  static checkPackageName(name: string): boolean {
-    // 检查包名是否以小数点结尾
-    if (name.endsWith('.')) {
-      return false
-    }
-
-    // 检查包名是否包含无效字符
-    const invalidCharacters = /[\\/:*?\"<>| ]/g
-    if (name.match(invalidCharacters)) {
-      return false
-    }
-
-    // 检查包名是否至少包含一个子段
-    const segments = name.split('.')
-    if (segments.length < 2) {
-      return false
-    }
-
-    // 检查每个子段是否以字母开头
-    for (const segment of segments) {
-      if (!segment.match(/^[a-z]/)) {
-        return false
-      }
-
-      // 检查子段是否包含连续的小数点
-      if (segment.includes('.' + '.')) {
-        return false
-      }
-    }
-
-    return true
-  }
-}