create-widget 0.0.2 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-widget",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "lib/index.js",
   "author": "Neo Fu",
   "license": "MIT",
@@ -8,6 +8,10 @@
   "bin": {
     "create-widget": "lib/index.js"
   },
+  "files": [
+    "lib/index.js",
+    "template"
+  ],
   "type": "module",
   "publishConfig": {
     "access": "public"

package/.editorconfig

@@ -1,13 +0,0 @@
-# editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

package/.idea/create-widget.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/jpa-buddy.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JpaBuddyIdeaProjectConfig">
-    <option name="renamerInitialized" value="true" />
-  </component>
-</project>

package/.idea/misc.xml

@@ -1,8 +0,0 @@
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-  <component name="ProjectType">
-    <option name="id" value="jpab" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/create-widget.iml" filepath="$PROJECT_DIR$/.idea/create-widget.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/prettier.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/../../.." vcs="Git" />
-  </component>
-</project>

package/src/index.ts

@@ -1,144 +0,0 @@
-import fs from 'fs'
-import * as process from 'process'
-import gradient from 'gradient-string'
-import prompts from 'prompts'
-import minimist from 'minimist'
-import chalk from 'chalk'
-import path from 'path'
-import {postOrderDirectoryTraverse} from './utils/directoryTraverse'
-import getCommand from './utils/getCommand'
-import {fileURLToPath} from 'url'
-import {FileUtils} from "./utils/FileUtils";
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-function canSkipEmptying(dir: string) {
-  if (!fs.existsSync(dir)) {
-    return true
-  }
-
-  const files = fs.readdirSync(dir)
-  if (files.length === 0) {
-    return true
-  }
-  if (files.length === 1 && files[0] === '.git') {
-    return true
-  }
-
-  return false
-}
-
-function emptyDir(dir) {
-  if (!fs.existsSync(dir)) {
-    return
-  }
-
-  postOrderDirectoryTraverse(
-    dir,
-    dir => fs.rmdirSync(dir),
-    file => fs.unlinkSync(file),
-  )
-}
-
-async function init() {
-  console.log()
-  let defaultBanner = 'Widget.js - The Desktop Widget Framework'
-  const gradientBanner = gradient([
-    {color: '#42d392', pos: 0},
-    {color: '#42d392', pos: 0.1},
-    {color: '#647eff', pos: 1},
-  ])(defaultBanner)
-  console.log(process.stdout.isTTY && process.stdout.getColorDepth() > 8 ? gradientBanner : defaultBanner)
-  console.log()
-  const argv = minimist(process.argv.slice(2), {
-    alias: {
-      typescript: ['ts'],
-      'with-tests': ['tests'],
-      router: ['vue-router'],
-    },
-    string: ['_'],
-    // all arguments are treated as booleans
-    boolean: true,
-  })
-  let targetDir = argv._[0]
-  const defaultProjectName = !targetDir ? 'widget-project' : targetDir
-  const forceOverwrite = argv.force
-
-  const cwd = process.cwd()
-  let result: {
-    projectName?: string
-    shouldOverwrite?: boolean
-  } = {}
-  result = await prompts(
-    [
-      {
-        name: 'projectName',
-        type: targetDir ? null : 'text',
-        message: 'Project name:',
-        initial: defaultProjectName,
-        onState: state => (targetDir = String(state.value).trim() || defaultProjectName),
-      },
-      {
-        name: 'shouldOverwrite',
-        type: () => (canSkipEmptying(targetDir) || forceOverwrite ? null : 'confirm'),
-        message: () => {
-          const dirForPrompt = targetDir === '.' ? 'Current directory' : `Target directory "${targetDir}"`
-          return `${dirForPrompt} is not empty. Remove existing files and continue?`
-        },
-      },
-    ],
-    {
-      onCancel: () => {
-        throw new Error(chalk.red('✖') + ' Operation cancelled')
-      },
-    },
-  )
-
-  // `initial` won't take effect if the prompt type is null
-  // so we still have to assign the default values here
-  const {projectName, shouldOverwrite = argv.force} = result
-
-  const root = path.join(cwd, targetDir)
-
-  if (fs.existsSync(root) && shouldOverwrite) {
-    emptyDir(root)
-  } else if (!fs.existsSync(root)) {
-    fs.mkdirSync(root)
-  }
-
-  console.log(`\nScaffolding project in ${root}...`)
-
-  const templateRoot = path.join(__dirname, '../template')
-
-  //复制templateRoot下的文件到root目录下
-  await FileUtils.copyFolderRecursive(templateRoot, root)
-
-  // const callbacks = []
-  //
-  // const render = function render(templateName) {
-  //   const templateDir = path.resolve(templateRoot, templateName)
-  //   renderTemplate(templateDir, root, callbacks)
-  // }
-  // // 将template里的文件都复制到 root目录下
-  // const templateFiles = fs.readdirSync(templateRoot)
-  // for (const file of templateFiles) {
-  //   render(file)
-  // }
-
-  // Instructions:
-  // Supported package managers: pnpm > yarn > npm
-  const userAgent = process.env.npm_config_user_agent ?? ''
-  const packageManager = /pnpm/.test(userAgent) ? 'pnpm' : /yarn/.test(userAgent) ? 'yarn' : 'npm'
-
-  console.log(`\nDone. Now run:\n`)
-  if (root !== cwd) {
-    const cdProjectName = path.relative(cwd, root)
-    console.log(`  ${chalk.bold(chalk.green(`cd ${cdProjectName.includes(' ') ? `"${cdProjectName}"` : cdProjectName}`))}`)
-  }
-  console.log(`  ${chalk.bold(chalk.green(getCommand(packageManager, 'install')))}`)
-}
-
-init().catch(e => {
-  console.error(e)
-})

package/src/utils/FileUtils.ts

@@ -1,33 +0,0 @@
-import * as fs from 'fs'
-import {copy,ensureDir} from "fs-extra";
-
-export class FileUtils {
-  static async copyFolderRecursive(src: string, dest: string): Promise<void> {
-    try {
-      // 创建目标文件夹
-      await ensureDir(dest)
-
-      // 获取源文件夹中的所有文件和子文件夹
-      const items = await fs.promises.readdir(src)
-
-      // 遍历每一个文件或子文件夹
-      for (const item of items) {
-        const srcPath = `${src}/${item}`
-        const destPath = `${dest}/${item}`
-
-        // 检查当前项目是文件还是文件夹
-        const stats = await fs.promises.stat(srcPath)
-
-        if (stats.isDirectory()) {
-          // 如果是文件夹，递归复制
-          await this.copyFolderRecursive(srcPath, destPath)
-        } else {
-          // 如果是文件，直接复制
-          await copy(srcPath, destPath)
-        }
-      }
-    } catch (error) {
-      console.error(`Error copying folder: ${error.message}`)
-    }
-  }
-}

package/src/utils/deepMerge.ts

@@ -1,26 +0,0 @@
-const isObject = (val) => val && typeof val === 'object'
-const mergeArrayWithDedupe = (a, b) => Array.from(new Set([...a, ...b]))
-
-/**
- * Recursively merge the content of the new object to the existing one
- * @param {Object} target the existing object
- * @param {Object} obj the new object
- */
-function deepMerge(target, obj) {
-  for (const key of Object.keys(obj)) {
-    const oldVal = target[key]
-    const newVal = obj[key]
-
-    if (Array.isArray(oldVal) && Array.isArray(newVal)) {
-      target[key] = mergeArrayWithDedupe(oldVal, newVal)
-    } else if (isObject(oldVal) && isObject(newVal)) {
-      target[key] = deepMerge(oldVal, newVal)
-    } else {
-      target[key] = newVal
-    }
-  }
-
-  return target
-}
-
-export default deepMerge

package/src/utils/directoryTraverse.ts

@@ -1,35 +0,0 @@
-import * as fs from 'node:fs'
-import * as path from 'node:path'
-
-export function preOrderDirectoryTraverse(dir, dirCallback, fileCallback) {
-  for (const filename of fs.readdirSync(dir)) {
-    if (filename === '.git') {
-      continue
-    }
-    const fullpath = path.resolve(dir, filename)
-    if (fs.lstatSync(fullpath).isDirectory()) {
-      dirCallback(fullpath)
-      // in case the dirCallback removes the directory entirely
-      if (fs.existsSync(fullpath)) {
-        preOrderDirectoryTraverse(fullpath, dirCallback, fileCallback)
-      }
-      continue
-    }
-    fileCallback(fullpath)
-  }
-}
-
-export function postOrderDirectoryTraverse(dir, dirCallback, fileCallback) {
-  for (const filename of fs.readdirSync(dir)) {
-    if (filename === '.git') {
-      continue
-    }
-    const fullpath = path.resolve(dir, filename)
-    if (fs.lstatSync(fullpath).isDirectory()) {
-      postOrderDirectoryTraverse(fullpath, dirCallback, fileCallback)
-      dirCallback(fullpath)
-      continue
-    }
-    fileCallback(fullpath)
-  }
-}

package/src/utils/getCommand.ts

@@ -1,13 +0,0 @@
-export default function getCommand(packageManager: string, scriptName: string, args?: string) {
-  if (scriptName === 'install') {
-    return packageManager === 'yarn' ? 'yarn' : `${packageManager} install`
-  }
-
-  if (args) {
-    return packageManager === 'npm'
-      ? `npm run ${scriptName} -- ${args}`
-      : `${packageManager} ${scriptName} ${args}`
-  } else {
-    return packageManager === 'npm' ? `npm run ${scriptName}` : `${packageManager} ${scriptName}`
-  }
-}

package/src/utils/renderTemplate.ts

@@ -1,88 +0,0 @@
-import * as fs from 'node:fs'
-import * as path from 'node:path'
-import { pathToFileURL } from 'node:url'
-
-import deepMerge from './deepMerge'
-import sortDependencies from './sortDependencies'
-
-/**
- * Renders a template folder/file to the file system,
- * by recursively copying all files under the `src` directory,
- * with the following exception:
- *   - `_filename` should be renamed to `.filename`
- *   - Fields in `package.json` should be recursively merged
- * @param {string} src source filename to copy
- * @param {string} dest destination filename of the copy operation
- */
-function renderTemplate(src, dest, callbacks) {
-  const stats = fs.statSync(src)
-
-  if (stats.isDirectory()) {
-    // skip node_module
-    if (path.basename(src) === 'node_modules') {
-      return
-    }
-
-    // if it's a directory, render its subdirectories and files recursively
-    fs.mkdirSync(dest, { recursive: true })
-    for (const file of fs.readdirSync(src)) {
-      renderTemplate(path.resolve(src, file), path.resolve(dest, file), callbacks)
-    }
-    return
-  }
-
-  const filename = path.basename(src)
-
-  if (filename === 'package.json' && fs.existsSync(dest)) {
-    // merge instead of overwriting
-    const existing = JSON.parse(fs.readFileSync(dest, 'utf8'))
-    const newPackage = JSON.parse(fs.readFileSync(src, 'utf8'))
-    const pkg = sortDependencies(deepMerge(existing, newPackage))
-    fs.writeFileSync(dest, JSON.stringify(pkg, null, 2) + '\n')
-    return
-  }
-
-  if (filename === 'extensions.json' && fs.existsSync(dest)) {
-    // merge instead of overwriting
-    const existing = JSON.parse(fs.readFileSync(dest, 'utf8'))
-    const newExtensions = JSON.parse(fs.readFileSync(src, 'utf8'))
-    const extensions = deepMerge(existing, newExtensions)
-    fs.writeFileSync(dest, JSON.stringify(extensions, null, 2) + '\n')
-    return
-  }
-
-  if (filename.startsWith('_')) {
-    // rename `_file` to `.file`
-    dest = path.resolve(path.dirname(dest), filename.replace(/^_/, '.'))
-  }
-
-  if (filename === '_gitignore' && fs.existsSync(dest)) {
-    // append to existing .gitignore
-    const existing = fs.readFileSync(dest, 'utf8')
-    const newGitignore = fs.readFileSync(src, 'utf8')
-    fs.writeFileSync(dest, existing + '\n' + newGitignore)
-    return
-  }
-
-  // data file for EJS templates
-  if (filename.endsWith('.data.mjs')) {
-    // use dest path as key for the data store
-    dest = dest.replace(/\.data\.mjs$/, '')
-
-    // Add a callback to the array for late usage when template files are being processed
-    callbacks.push(async (dataStore) => {
-      const getData = (await import(pathToFileURL(src).toString())).default
-
-      // Though current `getData` are all sync, we still retain the possibility of async
-      dataStore[dest] = await getData({
-        oldData: dataStore[dest] || {}
-      })
-    })
-
-    return // skip copying the data file
-  }
-
-  fs.copyFileSync(src, dest)
-}
-
-export default renderTemplate

package/src/utils/sortDependencies.ts

@@ -1,22 +0,0 @@
-export default function sortDependencies(packageJson) {
-  const sorted = {}
-
-  const depTypes = ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies']
-
-  for (const depType of depTypes) {
-    if (packageJson[depType]) {
-      sorted[depType] = {}
-
-      Object.keys(packageJson[depType])
-        .sort()
-        .forEach((name) => {
-          sorted[depType][name] = packageJson[depType][name]
-        })
-    }
-  }
-
-  return {
-    ...packageJson,
-    ...sorted
-  }
-}

package/test/index.test.ts

@@ -1,24 +0,0 @@
-import {expect, test} from "vitest";
-import {minimatch} from "minimatch";
-import path from "path";
-import gradient  from "gradient-string"
-
-test('minimatch',()=>{
-  let fileName = path.basename('C:\\Users\\rtuge\\Desktop\\github\\widgetjs\\packages\\@widget-js\\cli\\template\\Widget.ejs');
-  expect(minimatch(fileName,'*.ejs')).toBeTruthy()
-  expect(minimatch(fileName,'*.ts')).toBeFalsy()
-})
-
-
-test('gradient brand',()=>{
-  console.log(gradient([
-    { color: '#42d392', pos: 0 },
-    { color: '#42d392', pos: 0.1 },
-    { color: '#647eff', pos: 1 }
-  ])('Widget.js - The Desktop Widget Framework'))
-  console.log(gradient([
-    {color: '#42d392', pos: 0},
-    {color: '#42d392', pos: 0.1},
-    {color: '#647eff', pos: 1}
-  ])('Widget.js - The Desktop Widget Framework'));
-})

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "@tsconfig/node18/tsconfig.json",
-  "include": [
-    "index.ts",
-    "utils/**/*"
-  ],
-  "compilerOptions": {
-    "strict": false,
-    "resolveJsonModule": true,
-    "moduleResolution": "Node16"
-  }
-}

package/tsup.config.ts

@@ -1,6 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-    outDir: 'lib',
-    format: 'js'
-});

package/widget-test/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
-}

package/widget-test/README.md

@@ -1,40 +0,0 @@
-# hello widget
-
-This template should help get you started developing with Vue 3 in Vite.
-
-## Recommended IDE Setup
-
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
-
-## Type Support for `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
-
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
-
-1. Disable the built-in TypeScript Extension
-    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
-
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```

package/widget-test/env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/widget-test/index.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <link rel="icon" href="/favicon.ico">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Vite App</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/widget-test/package.json

@@ -1,30 +0,0 @@
-{
-  "name": "hello-widget",
-  "version": "0.0.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "run-p type-check \"build-only {@}\" --",
-    "preview": "vite preview",
-    "build-only": "vite build",
-    "type-check": "vue-tsc --build --force"
-  },
-  "dependencies": {
-    "vue": "^3.3.11",
-    "vue-router": "^4.2.5",
-    "@widget-js/core": "0.11.20",
-    "@widget-js/vue3": "0.11.21-rc.2"
-  },
-  "devDependencies": {
-    "@tsconfig/node18": "^18.2.2",
-    "@types/node": "^18.19.3",
-    "@vitejs/plugin-vue": "^4.5.2",
-    "@vue/tsconfig": "^0.5.0",
-    "npm-run-all2": "^6.1.1",
-    "typescript": "~5.3.0",
-    "vite": "^5.0.10",
-    "vue-tsc": "^1.8.25",
-    "@widget-js/vite-plugin-widget": "^1.2.8"
-  }
-}

package/widget-test/public/widget.json

@@ -1,50 +0,0 @@
-{
-  "name": "cn.example.widget",
-  "version": "1.0.0",
-  "author": "修改成你的信息",
-  "homepage": "",
-  "title": {
-    "zh-CN": "修改成你的组件标题"
-  },
-  "description": {
-    "zh-CN": "修改成你的组件描述"
-  },
-  "entry": "/",
-  "hash": true,
-  "url": "",
-  "widgets": [
-    {
-      "name": "cn.test.widget.clock",
-      "title": {
-        "zh-CN": "时钟"
-      },
-      "description": {
-        "zh-CN": "Hello world!"
-      },
-      "keywords": [
-        "recommend"
-      ],
-      "security": false,
-      "permissions": [],
-      "lang": "zh-CN",
-      "width": 2,
-      "height": 2,
-      "maxWidth": 6,
-      "webviewTag": false,
-      "maxHeight": 6,
-      "minWidth": 2,
-      "minHeight": 2,
-      "movable": true,
-      "singleton": false,
-      "resizable": true,
-      "path": "/widget/clock",
-      "meta": {},
-      "backgroundThrottling": true,
-      "previewImage": "/preview_clock.png",
-      "supportDeployMode": 17,
-      "configPagePath": "/widget/config/clock",
-      "routes": []
-    }
-  ],
-  "pages": []
-}

package/widget-test/src/App.vue

@@ -1,9 +0,0 @@
-<script setup lang="ts">
-import {RouterView } from 'vue-router'
-</script>
-
-<template>
-  <RouterView />
-</template>
-
-<style scoped></style>