@tomjs/create-app 1.0.0-alpha.1 → 1.0.1

package/templates/base/electron/electron/main/index.ts

@@ -0,0 +1,111 @@
+import '../polyfills';
+
+import { release } from 'node:os';
+import { join } from 'node:path';
+import { app, BrowserWindow, ipcMain, shell } from 'electron';
+
+// Disable GPU Acceleration for Windows 7
+if (release().startsWith('6.1')) app.disableHardwareAcceleration();
+
+// Set application name for Windows 10+ notifications
+if (process.platform === 'win32') app.setAppUserModelId(app.getName());
+
+if (!app.requestSingleInstanceLock()) {
+  app.quit();
+  process.exit(0);
+}
+
+// Remove electron security warnings
+// This warning only shows in development mode
+// Read more on https://www.electronjs.org/docs/latest/tutorial/security
+process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = 'true';
+
+const isDev = process.env.NODE_ENV === 'development';
+
+let win: BrowserWindow | null = null;
+// package.json "type":"module", must use mjs extension
+const preload = join(__dirname, '../preload/index.mjs');
+const serverUrl = process.env.VITE_DEV_SERVER_URL as string;
+const rendererDist = join(__dirname, '../renderer');
+const indexHtml = join(rendererDist, 'index.html');
+const publicPath = serverUrl ? join(__dirname, '../../public') : rendererDist;
+
+function createWindow() {
+  win = new BrowserWindow({
+    title: 'Main window',
+    width: 800,
+    height: 700,
+    icon: join(publicPath, 'img/icon.png'),
+    webPreferences: {
+      preload,
+      // Warning: Enable nodeIntegration and disable contextIsolation is not secure in production
+      // Consider using contextBridge.exposeInMainWorld
+      // Read more on https://www.electronjs.org/docs/latest/tutorial/context-isolation
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  if (isDev) {
+    win.loadURL(serverUrl);
+    // Open devTool if the app is not packaged
+    win.webContents.openDevTools();
+  } else {
+    win.loadFile(indexHtml);
+  }
+
+  // Test actively push message to the Electron-Renderer
+  win.webContents.on('did-finish-load', () => {
+    win?.webContents.send('main-process-message', new Date().toLocaleString());
+  });
+
+  // Make all links open with the browser, not with the application
+  win.webContents.setWindowOpenHandler(({ url }) => {
+    if (url.startsWith('https:')) shell.openExternal(url);
+    return { action: 'deny' };
+  });
+  // win.webContents.on('will-navigate', (event, url) => { }) #344
+}
+
+app.whenReady().then(async () => {
+  createWindow();
+});
+
+app.on('window-all-closed', () => {
+  win = null;
+  if (process.platform !== 'darwin') app.quit();
+});
+
+app.on('second-instance', () => {
+  if (win) {
+    // Focus on the main window if the user tried to open another
+    if (win.isMinimized()) win.restore();
+    win.focus();
+  }
+});
+
+app.on('activate', () => {
+  const allWindows = BrowserWindow.getAllWindows();
+  if (allWindows.length) {
+    allWindows[0].focus();
+  } else {
+    createWindow();
+  }
+});
+
+// New window example arg: new windows url
+ipcMain.handle('open-win', (_, arg) => {
+  const childWindow = new BrowserWindow({
+    webPreferences: {
+      preload,
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  if (serverUrl) {
+    childWindow.loadURL(`${serverUrl}#${arg}`);
+  } else {
+    childWindow.loadFile(indexHtml, { hash: arg });
+  }
+});

package/templates/base/electron/electron/polyfills.ts

@@ -0,0 +1,4 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+global.__dirname = dirname(fileURLToPath(import.meta.url));

package/templates/base/electron/electron/preload/index.ts

@@ -0,0 +1 @@
+console.log('Electron Preload Process!');

package/templates/base/electron/package.json

@@ -0,0 +1,25 @@
+{
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "dist/main/index.mjs",
+  "scripts": {
+    "dev": "vite",
+    "debug": "cross-env VITE_ELECTRON_DEBUG=1 npm run dev",
+    "build": "npm run clean && vite build",
+    "release": "cross-env VITE_ELECTRON_BUILDER=1 npm run build",
+    "clean": "rimraf ./dist",
+    "lint:eslint": "eslint \"{src,electron}/**/*.{ts,tsx}\" *.{js,cjs,mjs,ts} --fix --cache"
+  },
+  "dependencies": {
+    "@tomjs/electron-devtools-installer": "^2.2.1"
+  },
+  "devDependencies": {
+    "@tomjs/vite-plugin-electron": "^1.9.0",
+    "electron": "^30.0.9",
+    "electron-builder": "^24.13.3",
+    "vite": "^5.2.12",
+    "vite-plugin-electron-renderer": "^0.14.5"
+  }
+}

package/templates/base/electron/tsconfig.node.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@tomjs/tsconfig/node.json",
+  "compilerOptions": {
+    "composite": true
+  },
+  "include": ["electron", "package.json", "vite.config.ts"]
+}

package/templates/base/node/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{dateYear}}-PRESENT {{gitUserName}}<{{gitUserEmail}}>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/base/node/README.md

@@ -0,0 +1,13 @@
+# {{pkgName}}
+
+[![npm](https://img.shields.io/npm/v/{{pkgName}})](https://www.npmjs.com/package/{{pkgName}}) ![node-current (scoped)](https://img.shields.io/node/v/{{pkgName}}) ![NPM](https://img.shields.io/npm/l/{{pkgName}}) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/{{pkgName}})
+
+**English** | [中文](./README.zh_CN.md)
+
+> Basic template
+
+## Install
+
+```bash
+{{pkgInstall}}
+```

package/templates/base/node/README.zh_CN.md

@@ -0,0 +1,13 @@
+# {{pkgName}}
+
+[![npm](https://img.shields.io/npm/v/{{pkgName}})](https://www.npmjs.com/package/{{pkgName}}) ![node-current (scoped)](https://img.shields.io/node/v/{{pkgName}}) ![NPM](https://img.shields.io/npm/l/{{pkgName}}) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/{{pkgName}})
+
+[English](./README.md) | **中文**
+
+> 基础模板
+
+## 安装
+
+```bash
+{{pkgInstall}}
+```

package/templates/base/node/package.json

@@ -0,0 +1,46 @@
+{
+  "keywords": [],
+  "author": {
+    "name": "{{gitUserName}}",
+    "email": "{{gitUserEmail}}"
+  },
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "default": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      },
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.mts"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+{{gitUrl}}.git"
+  },
+  "scripts": {
+    "lint:eslint": "eslint \"{src,test}/**/*.ts\" *.{js,cjs,mjs,ts} --fix --cache",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@tomjs/node": "^2.1.0"
+  },
+  "devDependencies": {
+    "tsx": "^4.11.2",
+    "type-fest": "^4.19.0",
+    "vitest": "^1.6.0"
+  }
+}

package/templates/base/node/test/index.test.ts

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest';
+
+describe('some test', () => {
+  it('1 + 1 = 2', () => {
+    expect(1 + 1).toBe(2);
+  });
+});

package/templates/base/react/_eslintrc.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  env: {
+    node: true,
+    es6: true,
+  },
+  extends: [require.resolve('@tomjs/eslint/react')],
+};

package/templates/base/react/_lintstagedrc.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  '*.{js,cjs,mjs,ts,tsx}': ['eslint --fix', 'prettier --write'],
+  '*.{json,md}': ['prettier --write'],
+  '*.vue': ['eslint --fix', 'stylelint --fix', 'prettier --write'],
+  '*.{css,scss,less,html}': ['stylelint --fix', 'prettier --write'],
+};

package/templates/base/react/package.json

@@ -0,0 +1,19 @@
+{
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "lint": "run-s lint:eslint lint:stylelint lint:prettier",
+    "lint:eslint": "eslint \"src/**/*.{ts,tsx}\" *.{js,cjs,mjs,ts} --fix --cache"
+  },
+  "dependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react-swc": "^3.7.0",
+    "vite": "^5.2.12"
+  }
+}

package/templates/base/react/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@tomjs/tsconfig/react.json",
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

package/templates/base/react/tsconfig.node.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@tomjs/tsconfig/node.json",
+  "compilerOptions": {
+    "composite": true
+  },
+  "include": ["vite.config.ts"]
+}

package/templates/base/style/.stylelintignore

@@ -0,0 +1,16 @@
+# IDE
+.vscode
+.idea
+.history
+.git
+
+# temp
+.cache
+.temp
+.tmp
+
+# project
+node_modules
+public
+dist
+build

package/templates/base/style/.stylelintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: [require.resolve('@tomjs/stylelint')],
+};

package/templates/base/style/_lintstagedrc.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+  '*.{js,cjs,mjs,ts,tsx}': ['eslint --fix', 'prettier --write'],
+  '*.{json,md}': ['prettier --write'],
+  '*.{css,scss,less,html}': ['stylelint --fix', 'prettier --write'],
+};

package/templates/base/style/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+    "lint": "run-s lint:eslint lint:stylelint lint:prettier",
+    "lint:stylelint": "stylelint \"src/**/*.{css,less,scss,html}\" *.html --fix --cache"
+  },
+  "devDependencies": {
+    "@tomjs/stylelint": "^2.5.0",
+    "stylelint": "^16.6.1"
+  }
+}

package/templates/base/vscode/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "lokalise.i18n-ally"
+  ]
+}

package/templates/base/vscode/.vscode/launch.json

@@ -0,0 +1,21 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/dist/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    }
+  ]
+}

package/templates/base/vscode/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "i18n-ally.localesPaths": ["locales"]
+}

package/templates/base/vscode/.vscode/tasks.json

@@ -0,0 +1,36 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "dev",
+      "problemMatcher": {
+        "owner": "typescript",
+        "fileLocation": "relative",
+        "pattern": {
+          "regexp": "^([a-zA-Z]\\:\/?([\\w\\-]\/?)+\\.\\w+):(\\d+):(\\d+): (ERROR|WARNING)\\: (.*)$",
+          "file": 1,
+          "line": 3,
+          "column": 4,
+          "code": 5,
+          "message": 6
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^.*extension build start*$",
+          "endsPattern": "^.*extension (build|rebuild) success.*$"
+        }
+      },
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

package/templates/base/vscode/.vscodeignore

@@ -0,0 +1,73 @@
+# logs
+*.log
+lerna-debug.log*
+logs
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# runtime data
+*.pid
+*.pid.lock
+*.seed
+pids
+
+# dependency directory
+node_modules
+
+# cache
+.cache
+.npm
+.tmp
+.temp
+.eslintcache
+.stylelintcache
+tsconfig.tsbuildinfo
+
+# environment
+*.local
+
+# macOS
+.DS_Store
+
+# package files
+*.7z
+*.gz
+*.gzip
+*.rar
+*.tar
+*.tar.*
+*.tgz
+*.zip
+*.vsix
+
+# IDEA
+.idea
+
+# vscode
+.vscode
+.history
+
+# project
+src
+extensions
+locales
+
+.husky
+.commitlintrc*
+.editorconfig
+.eslintrc*
+.eslintignore
+.gitattributes
+.gitignore
+.lintstagedrc*
+.prettierrc*
+.prettierignore
+pnpm-lock.yaml
+tsconfig.json
+tsconfig.*.json
+*.config.ts

package/templates/base/vscode/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{dateYear}}-PRESENT {{gitUserName}}<{{gitUserEmail}}>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/base/vscode/_gitignore

@@ -0,0 +1,63 @@
+# logs
+*.log
+lerna-debug.log*
+logs
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# runtime data
+*.pid
+*.pid.lock
+*.seed
+pids
+
+# dependency directory
+bower_components
+jspm_packages
+node_modules
+web_modules
+
+# cache
+.cache
+.npm
+.tmp
+.temp
+.eslintcache
+.stylelintcache
+tsconfig.tsbuildinfo
+
+# environment
+*.local
+
+# macOS
+.DS_Store
+
+# package files
+*.7z
+*.gz
+*.gzip
+*.rar
+*.tar
+*.tar.*
+*.tgz
+*.zip
+*.vsix
+
+# IDEA
+.idea
+
+# vscode
+.history
+
+# build output
+build
+dist
+release
+
+package.nls.json
+package.nls.*.json

package/templates/base/vscode/extension/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="@tomjs/vite-plugin-vscode/env" />

package/templates/base/vscode/extension/index.ts

@@ -0,0 +1,21 @@
+import { i18n, initExtension } from '@tomjs/vscode';
+import type { ExtensionContext } from 'vscode';
+import { commands, window } from 'vscode';
+import { MainPanel } from './views/panel';
+
+export function activate(context: ExtensionContext) {
+  initExtension(context);
+
+  context.subscriptions.push(
+    commands.registerCommand('tomjs.xxx.showHello', async () => {
+      window.showInformationMessage(i18n.t('tomjs.commands.hello'));
+    }),
+  );
+  context.subscriptions.push(
+    commands.registerCommand('tomjs.xxx.showPanel', async () => {
+      MainPanel.render(context);
+    }),
+  );
+}
+
+export function deactivate() {}

package/templates/base/vscode/extension/views/helper.ts

@@ -0,0 +1,27 @@
+import type { Disposable, ExtensionContext, Webview } from 'vscode';
+import { window } from 'vscode';
+
+export class WebviewHelper {
+  public static setupHtml(webview: Webview, context: ExtensionContext) {
+    return process.env.VITE_DEV_SERVER_URL
+      ? __getWebviewHtml__(process.env.VITE_DEV_SERVER_URL)
+      : __getWebviewHtml__(webview, context);
+  }
+
+  public static setupWebviewHooks(webview: Webview, disposables: Disposable[]) {
+    webview.onDidReceiveMessage(
+      (message: any) => {
+        const command = message.command;
+        const text = message.text;
+        console.log(`command: ${command}`);
+        switch (command) {
+          case 'hello':
+            window.showInformationMessage(text);
+            return;
+        }
+      },
+      undefined,
+      disposables,
+    );
+  }
+}