@widget-js/cli 24.1.1-beta.5 → 24.1.1-beta.62

package/src/createWidget.ts

@@ -1,232 +0,0 @@
-import path from 'node:path'
-import fs from 'node:fs'
-import { fileURLToPath } from 'node:url'
-import consola from 'consola'
-import { paramCase, snakeCase } from 'change-case'
-import inquirer from 'inquirer'
-import shell from 'shelljs'
-import chalk from 'chalk'
-import { scanWidgetPackage } from '@widget-js/utils'
-import exit from './utils.js'
-import promptChecker from './promts/promptChecker'
-import { EJSUtils } from './utils/EJSUtils'
-import { WidgetPackageUtils } from './utils/WidgetPackageUtils'
-
-// import vm from "vm";
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-interface RenderOptions {
-  name: string
-  snakeCaseName: string
-  paramCaseName: string
-  packageName: string
-  widgetName: string
-  title: string
-  configurable: string
-  width: number
-  height: number
-  maxWidth: number
-  minHeight: number
-  maxHeight: number
-  minWidth: number
-}
-
-export default async function createWidget() {
-  const widgetPackage = await scanWidgetPackage()
-  if (!widgetPackage) {
-    consola.error('widget.ts or widget.json not found')
-    return
-  }
-  const widgetRootDir = WidgetPackageUtils.getRootDir(widgetPackage)
-  if (widgetPackage.devOptions && widgetPackage.devOptions.folder) {
-    consola.info(`组件路径：${widgetRootDir}`)
-  }
-  else {
-    consola.info(`没有配置devOptions.folder，使用默认路径${widgetRootDir}`)
-  }
-
-  const getMiddleValue = (arr: number[]) => {
-    if (arr.length === 1) {
-      return arr[0]
-    }
-    else if (arr.length === 2) {
-      return Math.max(...arr)
-    }
-    else {
-      const max = Math.max(...arr)
-      const min = Math.min(...arr)
-      const sum = arr[0] + arr[1] + arr[2]
-      return sum - max - min
-    }
-  }
-
-  const name = await promptChecker(
-    {
-      type: 'input',
-      name: 'name',
-      message: chalk.blue('请输入组件名(大驼峰式)，如：CountdownClock'),
-    },
-    (answer) => {
-      const name = answer.name
-      if (name == null || name === '') {
-        consola.log(chalk.red('组件名不能为空'))
-        return false
-      }
-      return true
-    },
-  )
-
-  consola.log(chalk.green(name))
-
-  const title = await promptChecker({
-    type: 'input',
-    name: 'title',
-    message: chalk.blue('请输入组件标题，如：倒计时'),
-  })
-  consola.log(chalk.green(title))
-  const answerW = await promptChecker(
-    {
-      type: 'checkbox',
-      name: 'w',
-      message: chalk.blue(
-        '请选择组件宽度，最多选3个，例如选中2,4,6，代表组件最小宽为2，默认宽为4，最大宽为6，单选代表不可拉伸',
-      ),
-      choices: [1, 2, 3, 4, 5, 6],
-    },
-    (answer) => {
-      if (answer.w.length === 0) {
-        consola.log(chalk.red('宽度必须选择'))
-        return false
-      }
-
-      if (answer.w.length > 3) {
-        consola.log(chalk.red('宽度最多选择3个'))
-        return false
-      }
-      return true
-    },
-  )
-  consola.log(chalk.green(answerW))
-
-  const answerH = await promptChecker(
-    {
-      type: 'checkbox',
-      name: 'h',
-      message: chalk.blue(
-        '请选择组件高度，最多选3个，例如选中1,2，代表组件最小高为1，默认高为2，最大高为2，单选代表不可拉伸',
-      ),
-      choices: [1, 2, 3, 4, 5, 6],
-    },
-    (answer) => {
-      if (answer.h.length === 0) {
-        consola.log(chalk.red('高度必须选择'))
-        return false
-      }
-
-      if (answer.h.length > 3) {
-        consola.log(chalk.red('高度最多选择3个'))
-        return false
-      }
-      return true
-    },
-  )
-
-  consola.log(chalk.green(answerH))
-
-  const configurable = await promptChecker({
-    type: 'confirm',
-    name: 'configurable',
-    message: chalk.blue('组件是否可配置，例如修改背景颜色，字体大小等'),
-  })
-
-  consola.log(chalk.green(configurable))
-
-  const width = getMiddleValue(answerW)
-  const height = getMiddleValue(answerH)
-  const minWidth = Math.min(...answerW)
-  const maxWidth = Math.max(...answerW)
-  const minHeight = Math.min(...answerH)
-  const maxHeight = Math.max(...answerH)
-  const snakeCaseName = snakeCase(name)
-  const paramCaseName = paramCase(name)
-
-  const widgetName = `${widgetPackage.name}.${snakeCaseName}`
-
-  const widgetDir = path.join(widgetRootDir, paramCaseName)
-  if (!fs.existsSync(widgetDir)) {
-    fs.mkdirSync(widgetDir)
-  }
-  else {
-    const answer = await inquirer.prompt([
-      {
-        type: 'confirm',
-        name: 'override',
-        message: chalk.red('组件名已存在，是否继续?'),
-      },
-    ])
-    if (!answer.override) {
-      exit()
-    }
-  }
-
-  const renderOptions: RenderOptions = {
-    name,
-    snakeCaseName,
-    paramCaseName,
-    packageName: widgetPackage.name,
-    widgetName,
-    title,
-    configurable,
-    width,
-    height,
-    maxWidth,
-    minHeight,
-    maxHeight,
-    minWidth,
-  }
-
-  const widgetDefineFile = path.resolve(widgetDir, `${name}.widget.ts`)
-  const widgetFile = path.resolve(widgetDir, `${name}Widget.vue`)
-  const widgetViewFile = path.resolve(widgetDir, `${name}WidgetView.vue`)
-  const widgetRoutesFile = path.resolve(widgetDir, `${name}WidgetRoutes.ts`)
-
-  await EJSUtils.renderToFile('WidgetDefine.ejs', widgetDefineFile, 'typescript', renderOptions)
-  // EJSUtils.renderToFile('Widget.ejs', widgetFile, 'vue', renderOptions)
-  await EJSUtils.renderToFile('WidgetView.ejs', widgetViewFile, 'vue', renderOptions)
-  await EJSUtils.renderToFile('WidgetRoutes.ejs', widgetRoutesFile, 'typescript', renderOptions)
-  if (configurable) {
-    const configFile = path.resolve(widgetDir, `${name}ConfigView.vue`)
-    await EJSUtils.renderToFile('WidgetConfig.ejs', configFile, 'vue', renderOptions)
-  }
-  // 注册路由
-  const routeFile = path.join(widgetRootDir, 'widget-router.ts')
-  let routeContent
-  if (fs.existsSync(routeFile)) {
-    routeContent = fs.readFileSync(routeFile, 'utf8')
-  }
-  else {
-    routeContent = fs.readFileSync(path.join(__dirname, '../template/widget-router.ts'), 'utf8')
-  }
-  const importRouteStr = `import ${name}WidgetRoutes from "./${paramCaseName}/${name}WidgetRoutes";`
-  const routeStr = `...${name}WidgetRoutes,`
-  if (!routeContent.includes(importRouteStr)) {
-    routeContent = routeContent.replaceAll(
-      '//FBI WANING! IMPORT PLACE',
-      `${importRouteStr}\n//FBI WANING! IMPORT PLACE`,
-    )
-  }
-  if (!routeContent.includes(routeStr)) {
-    routeContent = routeContent.replaceAll('//FBI WANING! ROUTE PLACE', `${routeStr}\n    //FBI WANING! ROUTE PLACE`)
-  }
-
-  fs.writeFileSync(routeFile, routeContent)
-
-  // 添加到版本控制
-  const gitAdd = `git add ${widgetDir}`
-  consola.info(chalk.grey(gitAdd))
-  shell.exec(gitAdd)
-  consola.log('=================')
-  consola.info(`已创建组件：${widgetDir}`)
-  consola.success('Happy coding!')
-}

package/src/dependencies/index.ts

@@ -1,13 +0,0 @@
-import { RemoteDependencies } from './remoteDependencies'
-import { LocalDependencies } from './localDependencies'
-
-export type DependenciesOptions = 'remote' | 'local'
-export default async function (options: any) {
-  const type = options.type as DependenciesOptions
-  if (type == 'remote') {
-    await RemoteDependencies.start()
-  }
-  else {
-    await LocalDependencies.start()
-  }
-}

package/src/dependencies/localDependencies.ts

@@ -1,29 +0,0 @@
-import fs from 'node:fs'
-import ora from 'ora'
-import { Utils, getPackagePath, widgetPackages } from '../utils'
-
-const spinner = ora('Connecting')
-
-export namespace LocalDependencies {
-  export async function start() {
-    spinner.start()
-    const json = Utils.getPackageJson()
-    const packageNames = Object.keys(widgetPackages)
-    const dependencies = json.dependencies
-    const devDependencies = json.devDependencies
-    await setWorkspaceVersion(dependencies, packageNames)
-    await setWorkspaceVersion(devDependencies, packageNames)
-    fs.writeFileSync(getPackagePath(), JSON.stringify(json, null, 2))
-    spinner.succeed('Using local versions(workspace:*)!')
-  }
-
-  async function setWorkspaceVersion(dependencies: { [key: string]: string }, packageNames: string[]) {
-    const localPackages = Object.keys(dependencies)
-    for (const localPackage of localPackages) {
-      if (packageNames.includes(localPackage)) {
-        dependencies[localPackage] = `workspace:*`
-      }
-    }
-  }
-
-}

package/src/dependencies/remoteDependencies.ts

@@ -1,37 +0,0 @@
-import fs from 'node:fs'
-import ora from 'ora'
-import { Utils, getPackagePath, widgetPackages } from '../utils'
-
-const spinner = ora('Connecting')
-
-export namespace RemoteDependencies {
-
-  export async function start() {
-    spinner.start()
-    const json = Utils.getPackageJson()
-    const packageNames = Object.keys(widgetPackages)
-    const dependencies = json.dependencies
-    const devDependencies = json.devDependencies
-    await upgradePackage(dependencies, packageNames)
-    await upgradePackage(devDependencies, packageNames)
-    fs.writeFileSync(getPackagePath(), JSON.stringify(json, null, 2))
-    spinner.succeed('Using remote versions!')
-  }
-
-  async function upgradePackage(dependencies: { [key: string]: string }, packageNames: string[]) {
-    const localPackages = Object.keys(dependencies)
-    for (const localPackage of localPackages) {
-      if (packageNames.includes(localPackage)) {
-        let packageVersion = widgetPackages[localPackage]
-        if (!packageVersion) {
-          spinner.info(`Fetching package version:${localPackage}`)
-          packageVersion = await Utils.getRemoteVersion(localPackage)
-          widgetPackages[localPackage] = packageVersion
-          spinner.info(`version:${packageVersion}`)
-        }
-        dependencies[localPackage] = `^${packageVersion}`
-      }
-    }
-  }
-
-}

package/src/index.ts

@@ -1,56 +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())
-
-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 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, command) => {
-    // @ts-expect-error
-    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/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[]
-}