pake-cli 0.0.1-beta.4 → 0.0.1-beta.5

package/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: ['tw93']
+custom: ['https://miaoyan.app/cats.html']

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+	"cSpell.words": [
+		"Pake",
+		"tauri"
+	],
+	"typescript.preferences.importModuleSpecifierEnding": "js"
+}

package/bin/builders/BuilderFactory.ts

@@ -0,0 +1,12 @@
+import { IS_MAC } from '@/utils/platform.js';
+import { IBuilder } from './base.js';
+import MacBuilder from './MacBuilder.js';
+
+export default class BuilderFactory {
+  static create(): IBuilder {
+    if (IS_MAC) {
+      return new MacBuilder();
+    }
+    throw new Error('The current system does not support');
+  }
+}

package/bin/builders/MacBuilder.ts

@@ -0,0 +1,69 @@
+import fs from 'fs/promises';
+import path from 'path';
+import prompts from 'prompts';
+import { checkRustInstalled, installRust } from '@/helpers/rust.js';
+import { PakeAppOptions } from '@/types.js';
+import { IBuilder } from './base.js';
+import appRootPath from 'app-root-path';
+import { shellExec } from '@/utils/shell.js';
+
+export default class MacBuilder implements IBuilder {
+  async prepare() {
+    if (checkRustInstalled()) {
+      console.log('Rust has been installed');
+      return;
+    }
+
+    console.warn('Rust is not installed, show prompt');
+    const res = await prompts({
+      type: 'confirm',
+      message: 'Detect you have not installed Rust, install it now?',
+      name: 'value',
+    });
+
+    if (res.value) {
+      // TODO 国内有可能会超时
+      await installRust();
+    } else {
+      console.error('Error: Pake need Rust to package your webapp!!!');
+      process.exit(2);
+    }
+  }
+
+  async build(url: string, options: PakeAppOptions) {
+    console.log('PakeAppOptions', options);
+    const tauriConfPath = path.join(appRootPath.path, 'src-tauri/tauri.conf.json');
+    const tauriConfString = await fs.readFile(tauriConfPath, 'utf-8');
+    try {
+      const tauriConf = JSON.parse(tauriConfString);
+
+      const { width, height, fullscreen, transparent, title, resizable, identifier, name } = options;
+
+      const tauriConfWindowOptions = {
+        width,
+        height,
+        fullscreen,
+        transparent,
+        title,
+        resizable,
+      };
+
+      Object.assign(tauriConf.tauri.windows[0], { url, ...tauriConfWindowOptions });
+      tauriConf.package.productName = name;
+      tauriConf.tauri.bundle.identifier = identifier;
+      tauriConf.tauri.bundle.icon = [options.icon];
+
+      await fs.writeFile(tauriConfPath, JSON.stringify(tauriConf, null, 2));
+      const code = await shellExec(`${path.join(appRootPath.path, '/node_modules/.bin/tauri')} build --config ${tauriConfPath} --target universal-apple-darwin`);
+      const dmgName = `${name}_${'0.2.0'}_universal.dmg`;
+      await fs.copyFile(this.getBuildedAppPath(dmgName), path.resolve(dmgName));
+    } catch (error) {
+      console.error('handle tauri.conf.json error', error);
+      return;
+    }
+  }
+
+  getBuildedAppPath(dmgName: string) {
+    return path.join(appRootPath.path, 'src-tauri/target/universal-apple-darwin/release/bundle/dmg', dmgName);
+  }
+}

package/bin/builders/base.ts

@@ -0,0 +1,7 @@
+import { PakeAppOptions } from '@/types.js';
+
+export interface IBuilder {
+  prepare(): Promise<void>;
+  build(url: string, options: PakeAppOptions): Promise<void>;
+  // getIcon(icon?: string): Promise<string>;
+}

package/bin/builders/common.ts

@@ -0,0 +1,29 @@
+import path from 'path';
+import { checkRustInstalled, installRust } from '@/helpers/rust.js';
+import appRootPath from 'app-root-path';
+import prompts from 'prompts';
+
+export async function prepareCheck() {
+  if (checkRustInstalled()) {
+    console.log('Rust has been installed');
+    return;
+  }
+
+  console.warn('Rust is not installed, show prompt');
+  const res = await prompts({
+    type: 'confirm',
+    message: 'Detect you have not installed Rust, install it now?',
+    name: 'value',
+  });
+
+  if (res.value) {
+    await installRust();
+  } else {
+    console.error('Error: Pake need Rust to package your webapp!!!');
+    process.exit(2);
+  }
+}
+
+export function getBuildedAppPath(name: string, version: string) {
+  return path.join(appRootPath.path, 'src-tauri/target/universal-apple-darwin/release/bundle/dmg', `${name}_${version}_universal.dmg`);
+}

package/bin/cli.ts

@@ -0,0 +1,29 @@
+import { program } from 'commander';
+import { DEFAULT_PAKE_OPTIONS } from './defaults.js';
+import { PakeCliOptions } from './types.js';
+import { validateNumberInput, validateUrlInput } from './utils/validate.js';
+import handleInputOptions from './options/index.js';
+import BuilderFactory from './builders/BuilderFactory.js';
+
+program.version('0.0.1').description('A cli application can build website to app, driven by tauri');
+
+program
+  .argument('<url>', 'the web url you want to package', validateUrlInput)
+  .option('--name <string>', 'application name')
+  .option('--title <string>', 'application window title')
+  .option('--icon <string>', 'application icon', DEFAULT_PAKE_OPTIONS.icon)
+  .option('--height <number>', 'application window height', validateNumberInput, DEFAULT_PAKE_OPTIONS.height)
+  .option('--width <number>', 'application window width', validateNumberInput, DEFAULT_PAKE_OPTIONS.width)
+  .option('--no-resizable', 'whether the application window can be resizable', DEFAULT_PAKE_OPTIONS.resizable)
+  .option('--fullscreen', 'makes the packaged app start in full screen', DEFAULT_PAKE_OPTIONS.fullscreen)
+  .option('--transparent', 'transparent title bar', DEFAULT_PAKE_OPTIONS.transparent)
+  .action(async (url: string, options: PakeCliOptions) => {
+    const builder = BuilderFactory.create();
+    await builder.prepare();
+
+    const appOptions = await handleInputOptions(options, url);
+
+    builder.build(url, appOptions);
+  });
+
+program.parse();

package/bin/defaults.ts

@@ -0,0 +1,12 @@
+import { PakeCliOptions } from './types.js';
+
+export const DEFAULT_PAKE_OPTIONS: PakeCliOptions = {
+  icon: '',
+  height: 800,
+  width: 1280,
+  fullscreen: false,
+  resizable: true,
+  transparent: false,
+};
+
+export const DEFAULT_APP_NAME = 'Pake';

package/bin/helpers/rust.ts

@@ -0,0 +1,21 @@
+import ora from 'ora';
+import shelljs from 'shelljs';
+import { shellExec } from '../utils/shell.js';
+
+const InstallRustScript = "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y";
+export async function installRust() {
+  const spinner = ora('Downloading Rust').start();
+  try {
+    await shellExec(InstallRustScript);
+    spinner.succeed();
+  } catch (error) {
+    console.error('install rust return code', error.message);
+    spinner.fail();
+
+    process.exit(1);
+  }
+}
+
+export function checkRustInstalled() {
+  return shelljs.exec('rustc --version', { silent: true }).code === 0;
+}

package/bin/helpers/tauriConfig.ts

@@ -0,0 +1,8 @@
+import crypto from 'crypto';
+
+export function getIdentifier(name: string, url: string) {
+  const hash = crypto.createHash('md5');
+  hash.update(url);
+  const postFixHash = hash.digest('hex').substring(0, 6);
+  return `pake-${postFixHash}`;
+}

package/bin/options/icon.ts

@@ -0,0 +1,99 @@
+import axios from 'axios';
+import { fileTypeFromBuffer } from 'file-type';
+import url from 'url';
+import { PakeAppOptions } from '../types.js';
+import { dir, file } from 'tmp-promise';
+import path from 'path';
+import pageIcon from 'page-icon';
+import png2icons from 'png2icons';
+import ICO from 'icojs';
+import fs from 'fs/promises';
+
+export async function handleIcon(options: PakeAppOptions, url: string) {
+  console.log(options.icon);
+  if (options.icon) {
+    if (options.icon.startsWith('http')) {
+      return downloadIcon(options.icon);
+    } else {
+      return path.resolve(options.icon);
+    }
+  }
+  if (!options.icon) {
+    return inferIcon(options.name, url);
+  }
+}
+
+export async function inferIcon(name: string, url: string) {
+  let icon = await getIconFromMacosIcons(name);
+  if (!icon) {
+    icon = await getIconFromPageUrl(url);
+  }
+  if (!icon) {
+    // TODO default icon
+  }
+  return icon;
+}
+
+export async function getIconFromPageUrl(url: string) {
+  const icon = await pageIcon(url);
+  console.log(icon);
+  if (icon.ext === '.ico') {
+    const a = await ICO.parse(icon.data);
+    icon.data = Buffer.from(a[0].buffer);
+  }
+
+  const iconDir = (await dir()).path;
+  const iconPath = path.join(iconDir, `/icon.icns`);
+
+  const out = png2icons.createICNS(icon.data, png2icons.BILINEAR, 0);
+
+  await fs.writeFile(iconPath, out);
+  return iconPath;
+}
+
+export async function getIconFromMacosIcons(name: string) {
+  const data = {
+    query: name,
+    filters: 'approved:true',
+    hitsPerPage: 10,
+    page: 1,
+  };
+  const res = await axios.post('https://p1txh7zfb3-2.algolianet.com/1/indexes/macOSicons/query?x-algolia-agent=Algolia%20for%20JavaScript%20(4.13.1)%3B%20Browser', data, {
+    headers: {
+      'x-algolia-api-key': '0ba04276e457028f3e11e38696eab32c',
+      'x-algolia-application-id': 'P1TXH7ZFB3',
+    },
+  });
+  if (!res.data.hits.length) {
+    return '';
+  } else {
+    return downloadIcon(res.data.hits[0].icnsUrl);
+  }
+}
+
+export async function downloadIcon(iconUrl: string) {
+  let iconResponse;
+  try {
+    iconResponse = await axios.get(iconUrl, {
+      responseType: 'arraybuffer',
+    });
+  } catch (error) {
+    if (error.response && error.response.status === 404) {
+      return null;
+    }
+    throw error;
+  }
+
+  const iconData = await iconResponse.data;
+  if (!iconData) {
+    return null;
+  }
+  const fileDetails = await fileTypeFromBuffer(iconData);
+  if (!fileDetails) {
+    return null;
+  }
+  const { path } = await dir();
+  const iconPath = `${path}/icon.${fileDetails.ext}`;
+  await fs.writeFile(iconPath, iconData);
+  return iconPath;
+}

package/bin/options/index.ts

@@ -0,0 +1,24 @@
+import { getIdentifier } from '../helpers/tauriConfig.js';
+import { PakeAppOptions, PakeCliOptions } from '../types.js';
+import { handleIcon } from './icon.js';
+import { getTitleByURL } from './title.js';
+
+export default async function handleOptions(options: PakeCliOptions, url: string): Promise<PakeAppOptions> {
+  const appOptions: PakeAppOptions = {
+    ...options,
+    identifier: '',
+  };
+  if (!appOptions.title) {
+    appOptions.title = await getTitleByURL(url);
+  }
+
+  if (!appOptions.name) {
+    appOptions.name = appOptions.title;
+  }
+
+  appOptions.identifier = getIdentifier(appOptions.name, url);
+
+  appOptions.icon = await handleIcon(appOptions, url);
+
+  return appOptions;
+}

package/bin/options/title.ts

@@ -0,0 +1,14 @@
+import axios from 'axios';
+
+const USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36';
+
+export async function getTitleByURL(url: string): Promise<string> {
+  const { data } = await axios.get<string>(url, {
+    headers: {
+      // Fake user agent for pages like http://messenger.com
+      'User-Agent': USER_AGENT,
+    },
+  });
+  const title = /<\s*title.*?>(?<title>.+?)<\s*\/title\s*?>/i.exec(data)?.groups?.title ?? 'Webapp';
+  return title;
+}

package/bin/types.ts

@@ -0,0 +1,29 @@
+export interface PakeCliOptions {
+  /** 应用名称 */
+  name?: string;
+
+  /** 不填会取 url 的 title，取不到默认 webapp */
+  title?: string;
+
+  /** 应用icon */
+  icon: string;
+
+  /** 应用窗口宽度，默认 1280px */
+  width: number;
+
+  /** 应用窗口高度，默认 800px */
+  height: number;
+
+  /** 是否可以拖动，默认true */
+  resizable: boolean;
+
+  /** 是否可以全屏，默认 false */
+  fullscreen: boolean;
+
+  /** 是否开启沉浸式头部，默认为 false 不开启 ƒ*/
+  transparent: boolean;
+}
+
+export interface PakeAppOptions extends PakeCliOptions {
+  identifier: string;
+}

package/bin/utils/platform.ts

@@ -0,0 +1,5 @@
+export const IS_MAC = process.platform === 'darwin';
+
+export const IS_WIN = process.platform === 'win32';
+
+export const IS_LINUX = process.platform === 'linux';

package/bin/utils/shell.ts

@@ -0,0 +1,12 @@
+import shelljs from 'shelljs';
+export function shellExec(command: string) {
+  return new Promise<number>((resolve, reject) => {
+    shelljs.exec(command, { async: true, silent: false}, (code) => {
+			if (code === 0) {
+				resolve(0);
+			} else {
+				reject(new Error(`${code}`));
+			}
+		});
+  });
+}

package/bin/utils/url.ts

@@ -0,0 +1,21 @@
+import url from 'url';
+import isurl from 'is-url';
+
+function appendProtocol(inputUrl: string): string {
+  const parsed = url.parse(inputUrl);
+  if (!parsed.protocol) {
+    const urlWithProtocol = `https://${inputUrl}`;
+    return urlWithProtocol;
+  }
+  return inputUrl;
+}
+
+export function normalizeUrl(urlToNormalize: string): string {
+  const urlWithProtocol = appendProtocol(urlToNormalize);
+
+  if (isurl(urlWithProtocol)) {
+    return urlWithProtocol;
+  } else {
+    throw new Error(`Your url "${urlWithProtocol}" is invalid`);
+  }
+}

package/bin/utils/validate.ts

@@ -0,0 +1,18 @@
+import * as Commander from 'commander';
+import { normalizeUrl } from './url.js';
+
+export function validateNumberInput(value: string) {
+  const parsedValue = Number(value);
+  if (isNaN(parsedValue)) {
+    throw new Commander.InvalidArgumentError('Not a number.');
+  }
+  return parsedValue;
+}
+
+export function validateUrlInput(url: string) {
+  try {
+    return normalizeUrl(url);
+  } catch (error) {
+    throw new Commander.InvalidArgumentError(error.message);
+  }
+}

package/cli.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('./dist/cli');
+import './dist/cli.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pake-cli",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.5",
   "description": "用 Rust 来打包你的 App，底层使用 Tauri，当前支持微信读书、Flomo、Vercel",
   "bin": {
     "pake": "./cli.js"
@@ -13,13 +13,6 @@
     "name": "Tw93",
     "email": "tw93@qq.com"
   },
-  "files": [
-    "dist",
-    "src-tauri",
-    "README_EN.md",
-    "README.md",
-    "tsconfig.json"
-  ],
   "scripts": {
     "start": "npm run dev",
     "dev": "npm run tauri dev",

package/rollup.config.js

@@ -0,0 +1,25 @@
+import path from 'path';
+import appRootPath from 'app-root-path';
+import typescript from '@rollup/plugin-typescript';
+import alias from '@rollup/plugin-alias';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+export default {
+  input: 'bin/cli.ts',
+  output: {
+    file: 'dist/cli.js',
+    format: 'es'
+  },
+  plugins: [
+    typescript({
+      sourceMap: false,
+    }),
+    json(),
+    commonjs(),
+    nodeResolve(),
+    alias({
+      entries: [{ find: '@', replacement: path.join(appRootPath.path, 'bin') }],
+    }),
+  ],
+};