@farris/cli 1.0.28 → 2.0.0-beta.7

package/bin/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../lib/index.js';

package/lib/commands/build-components.js

@@ -0,0 +1,36 @@
+import { readdirSync, lstatSync } from "node:fs";
+import { resolve } from "node:path";
+import { buildCommon } from "./build.js";
+import { CWD } from "../common/constant.js";
+import { replace } from "../plugins/replace.js";
+import { genComponentStyle } from "../plugins/gen-component-style.js";
+export async function buildComponents(options) {
+    const components = readdirSync("./components").filter((name) => {
+        const componentDir = resolve(CWD, `./components`, name);
+        const isDir = lstatSync(componentDir).isDirectory();
+        return isDir && readdirSync(componentDir).includes("index.ts");
+    });
+    components.forEach(async (component) => {
+        const entry = resolve(CWD, `./components/${component}/index.ts`);
+        const outDir = resolve(CWD, `./package/${component}`);
+        const config = {
+            publicDir: false,
+            build: {
+                lib: {
+                    entry
+                },
+                outDir
+            },
+            plugins: [genComponentStyle(), replace((format, args) => `..${args[1]}/index.${format}.js`)]
+        };
+        console.log(`build ${component} begin`);
+        await buildCommon({ ...options, config, type: 'lib' });
+        console.log(`build ${component} success`);
+        // const cssEntry = `./components/${component}/src/${component}.scss`;
+        // if(!existsSync(cssEntry)) {
+        //   return;
+        // }
+        // await buildCss({...options,entry: cssEntry, outfile: `./package/${component}/index.css` });
+    });
+}
+;

package/lib/commands/build-css.js

@@ -0,0 +1,11 @@
+import { build } from "esbuild";
+import { sassPlugin } from 'esbuild-sass-plugin';
+export async function buildCss(options) {
+    const { entry, outfile } = options;
+    await build({
+        entryPoints: [entry],
+        outfile,
+        bundle: true,
+        plugins: [sassPlugin()],
+    });
+}

package/lib/commands/build-lib.js

@@ -0,0 +1,16 @@
+import { buildCommon } from "./build.js";
+import { generateTypes } from "../plugins/dts.js";
+export async function buildLib(options) {
+    const { dts = false } = options;
+    const config = {
+        publicDir: false,
+        plugins: [
+            dts && generateTypes("./components", "./package/types")
+        ]
+    };
+    console.log(`build lib begin`);
+    await buildCommon({ ...options, config, type: 'lib' });
+    console.log(`build lib success`);
+    // await buildCss({...options, entry: "./components/index.scss", outfile: "./package/index.css"});
+}
+;

package/lib/commands/build.js

@@ -0,0 +1,10 @@
+import { build, mergeConfig, loadConfigFromFile } from 'vite';
+import { getViteConfig } from '../common/get-vite-config.js';
+export async function buildCommon(options) {
+    const { configFile, config, type } = options;
+    const viteConfig = await loadConfigFromFile({ command: 'build', mode: 'production' }, configFile);
+    const defaultConfig = await getViteConfig(type);
+    const libConfig = mergeConfig(mergeConfig(defaultConfig, viteConfig ? viteConfig.config : {}), config);
+    await build(libConfig);
+}
+;

package/lib/commands/create-app.js

@@ -0,0 +1,54 @@
+import { generateApp } from "../common/generate-app.js";
+import inquirer from "inquirer";
+const prompt = inquirer.createPromptModule();
+const questions = [
+    {
+        type: "input",
+        name: "name",
+        message: "What is your project name?",
+        default: "my-project",
+    },
+    {
+        type: "list",
+        name: "type",
+        message: "What type of project is this?",
+        choices: ["app", "lib"],
+    },
+    {
+        type: "list",
+        name: "platform",
+        message: "What platform of project is this?",
+        choices: ["pc", "mobile"],
+        when: (response) => {
+            const { type } = response;
+            return type === 'app';
+        }
+    },
+    {
+        type: "checkbox",
+        name: "formats",
+        message: "What output format of project is this?",
+        choices: ["es", "umd", "systemjs"],
+        default: ["es", "umd"],
+        when: (response) => {
+            const { type } = response;
+            return type === 'lib';
+        }
+    },
+    {
+        type: "list",
+        name: "format",
+        message: "What output format of project is this?",
+        choices: ["es", "umd", "systemjs"],
+        default: ["es"],
+        when: (response) => {
+            const { type } = response;
+            return type === 'app';
+        }
+    }
+];
+export async function createApp() {
+    const response = await prompt(questions);
+    generateApp(response);
+}
+;

package/lib/commands/dev-serve.js

@@ -0,0 +1,23 @@
+import { createServer, mergeConfig } from 'vite';
+import { getViteConfig } from '../common/get-vite-config.js';
+export const devServe = async (options) => {
+    const { port = 1337, host = true } = options;
+    const config = await getViteConfig();
+    const devConfig = mergeConfig({
+        configFile: false,
+        mode: 'dev',
+        define: {
+            __VUE_OPTIONS_API__: 'true',
+            __VUE_PROD_DEVTOOLS__: 'true',
+            __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: 'true'
+        },
+        server: {
+            port,
+            host,
+            hmr: true
+        }
+    }, config);
+    const server = await createServer(devConfig);
+    await server.listen();
+    server.printUrls();
+};

package/lib/commands/preview-serve.js

@@ -0,0 +1,16 @@
+import { preview, mergeConfig } from 'vite';
+import { getViteConfig } from '../common/get-vite-config.js';
+export const previewServe = async (options) => {
+    const { port = 4137, host = true } = options;
+    const config = await getViteConfig();
+    const previewConfig = mergeConfig({
+        configFile: false,
+        preview: {
+            port,
+            host,
+            open: true
+        }
+    }, config);
+    const server = await preview(previewConfig);
+    server.printUrls();
+};

package/lib/common/constant.js

@@ -0,0 +1,18 @@
+import { existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { join, dirname } from 'node:path';
+function findRootDir(dir) {
+    if (existsSync(join(dir, 'farris.config.js'))) {
+        return dir;
+    }
+    const parentDir = dirname(dir);
+    if (dir === parentDir) {
+        return dir;
+    }
+    return findRootDir(parentDir);
+}
+export const getDirname = (url) => fileURLToPath(new URL('.', url));
+// Root paths
+export const CWD = process.cwd();
+export const ROOT = findRootDir(CWD);
+export const FAARIS_CONFIG_FILE = join(CWD, 'farris.config.mjs');

package/lib/common/generate-app.js

@@ -0,0 +1,44 @@
+import { resolve } from 'path';
+import { createRequire } from "node:module";
+import { CWD, getDirname } from './constant.js';
+import { getVersion } from "./get-version.js";
+const require = createRequire(import.meta.url);
+const { copySync, readFileSync, writeFileSync } = require("fs-extra");
+const Array2String = (arr) => {
+    return `[${arr.reduce((acc, cur, index) => {
+        acc = index === 1 ? "'" + acc + "'" : acc;
+        acc += `,'${cur}'`;
+        return acc;
+    })}]`;
+};
+const copyTemplate = (template, target) => {
+    const templatePath = resolve(getDirname(import.meta.url), '../../templates', template);
+    const targetPath = resolve(CWD, target);
+    console.log(templatePath, targetPath);
+    copySync(templatePath, targetPath);
+};
+const replaceContent = (path, args) => {
+    let content = readFileSync(path, 'utf-8');
+    Object.keys(args).forEach((key) => {
+        const regexp = new RegExp(`<%= ${key} %>`, 'g');
+        const value = Array.isArray(args[key]) ? Array2String(args[key]) : args[key];
+        content = content.replace(regexp, value);
+    });
+    writeFileSync(path, content);
+};
+export const generateApp = (options) => {
+    const { name, type, formats, format, platform } = options;
+    const template = type === 'lib' ? 'lib' : platform;
+    copyTemplate(template, name);
+    const replaceFiles = [
+        'package.json',
+        'farris.config.mjs',
+        'index.html'
+    ];
+    const cliVersion = getVersion();
+    replaceFiles.forEach(replaceFile => {
+        replaceContent(resolve(CWD, name, replaceFile), { name, formats, format, platform, cliVersion });
+    });
+    console.log(`cd ${name}`);
+    console.log(`npm install or yarn`);
+};

package/lib/common/get-dependencies.js

@@ -0,0 +1,9 @@
+import { readFileSync } from "node:fs";
+import { resolve } from 'node:path';
+import { CWD } from "../common/constant.js";
+export const getDependencies = () => {
+    const pkg = readFileSync(resolve(CWD, 'package.json'), 'utf-8');
+    const packageJson = JSON.parse(pkg);
+    const { dependencies, peerDependencies } = packageJson;
+    return [...Object.keys(dependencies || {}), ...Object.keys(peerDependencies || {})];
+};

package/lib/common/get-farris-config.js

@@ -0,0 +1,11 @@
+import { pathToFileURL } from 'node:url';
+import { FAARIS_CONFIG_FILE } from './constant.js';
+async function getFarrisConfigAsync() {
+    try {
+        return (await import(pathToFileURL(FAARIS_CONFIG_FILE).href)).default;
+    }
+    catch (err) {
+        return {};
+    }
+}
+export { getFarrisConfigAsync };

package/lib/common/get-version.js

@@ -0,0 +1,6 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const packageJson = require('../../package.json');
+export const getVersion = () => {
+    return packageJson.version;
+};

package/lib/common/get-vite-config.js

@@ -0,0 +1,38 @@
+import { mergeConfig } from 'vite';
+import { getFarrisConfigAsync } from './get-farris-config.js';
+import { getDependencies } from '../common/get-dependencies.js';
+const formatFarrisConfig = (farrisConfig, type) => {
+    const { lib, format, minify = true, externals = { include: [], exclude: [] }, externalDependencies, plugins, alias } = farrisConfig;
+    const dependencies = externalDependencies ? getDependencies() : [];
+    let external = externals.include ? [...externals.include, ...dependencies] : dependencies;
+    external = external.filter(item => !externals.exclude?.includes(item));
+    format && (process.env.FARRIS_FORMAT = format);
+    const viteConfig = {
+        build: {
+            minify,
+            lib: type === 'lib' ? lib : undefined,
+            rollupOptions: {
+                output: {
+                    format
+                },
+                external
+            }
+        },
+        plugins,
+        resolve: {
+            alias
+        }
+    };
+    return viteConfig;
+};
+const formatViteConfig = async (type) => {
+    const { viteConfig = {}, ...farrisConfig } = await getFarrisConfigAsync();
+    const customViteConfig = formatFarrisConfig(farrisConfig, type);
+    return mergeConfig(customViteConfig, viteConfig);
+};
+const getViteConfig = async (type = 'app') => {
+    const viteConfig = await formatViteConfig(type);
+    const { default: defaultViteConfig } = await import(`../config/vite-${type}.js`);
+    return mergeConfig(defaultViteConfig, viteConfig);
+};
+export { getViteConfig };

package/lib/config/vite-app.js

@@ -0,0 +1,14 @@
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import { CWD } from '../common/constant.js';
+import { htmlSystemPlugin } from '../plugins/html-system.js';
+export default {
+    root: CWD,
+    base: './',
+    // logLevel: 'silent',
+    plugins: [
+        vue(),
+        vueJsx(),
+        process.env.FARRIS_FORMAT === 'systemjs' && htmlSystemPlugin()
+    ]
+};

package/lib/config/vite-lib.js

@@ -0,0 +1,35 @@
+import vue from '@vitejs/plugin-vue';
+import vueJsx from '@vitejs/plugin-vue-jsx';
+import { CWD } from '../common/constant.js';
+import { resolve } from "node:path";
+export default {
+    root: CWD,
+    base: './',
+    logLevel: 'silent',
+    plugins: [vue(), vueJsx()],
+    build: {
+        lib: {
+            entry: resolve(CWD, `./src/main.ts`),
+            fileName: "index",
+            formats: ["es", "systemjs"],
+        },
+        outDir: resolve(CWD, `./lib`),
+        rollupOptions: {
+            external: [],
+            output: {
+                exports: "named",
+                globals: (id) => {
+                    if (id.includes('@components')) {
+                        const name = id.split('/').pop() || '';
+                        return name.slice(0, 1).toUpperCase() + name.slice(1);
+                    }
+                    const map = {
+                        vue: "Vue",
+                        '@farris/mobile-ui-vue': 'FarrisVue'
+                    };
+                    return map[id];
+                }
+            }
+        },
+    }
+};

package/lib/index.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { getVersion } from "./common/get-version.js";
+const program = new Command();
+program.version(`@farris/cli ${getVersion()}`);
+program
+    .command('build')
+    .description('构建')
+    .option('-c --configFile [configFile]', 'config file path')
+    .action(async (options) => {
+    const { buildCommon } = await import('./commands/build.js');
+    return buildCommon(options);
+});
+program
+    .command('build-lib')
+    .description('构建')
+    .option('-c --configFile [configFile]', 'config file path')
+    .option('-d --dts', 'dts')
+    .action(async (options) => {
+    const { buildLib } = await import('./commands/build-lib.js');
+    return buildLib(options);
+});
+program
+    .command('build-components')
+    .description('构建')
+    .option('-c --configFile [configFile]', 'config file path')
+    .action(async (options) => {
+    const { buildComponents } = await import('./commands/build-components.js');
+    return buildComponents(options);
+});
+program
+    .command('create-app')
+    .description('新建 App 模板')
+    .action(async () => {
+    const { createApp } = await import('./commands/create-app.js');
+    return createApp();
+});
+program
+    .command('dev')
+    .description('创建 Dev Server')
+    .option('-p --port [port]', 'Server Port')
+    .action(async (options) => {
+    const { devServe } = await import('./commands/dev-serve.js');
+    return devServe(options);
+});
+program
+    .command('preview')
+    .description('创建 Preview Server')
+    .option('-p --port [port]', 'Server Port')
+    .action(async (options) => {
+    const { previewServe } = await import('./commands/preview-serve.js');
+    return previewServe(options);
+});
+program.parse();

package/lib/plugins/dts.js

@@ -0,0 +1,8 @@
+import dts from "vite-plugin-dts";
+export function generateTypes(entry, outDir) {
+    return dts({
+        entryRoot: entry,
+        outDir
+    });
+}
+;

package/lib/plugins/gen-component-style.js

@@ -0,0 +1,43 @@
+const NotStyleComponents = ['designer-canvas', 'dynamic-view', 'dynamic-resolver', 'common'];
+const getComponentStyle = (imports) => {
+    const components = imports
+        .filter(path => {
+        return path.startsWith('@components/') && !NotStyleComponents.find(notStylecomponent => path.includes(notStylecomponent));
+    })
+        .filter((item, index, array) => {
+        return array.indexOf(item) === index;
+    })
+        .map(name => {
+        const paths = name.split('/');
+        return {
+            name: paths[1],
+            path: `../${paths[1]}/index.css`
+        };
+    });
+    components.push({
+        name: 'components',
+        path: `./index.css`
+    });
+    const template = `${components.map(component => {
+        const { path } = component;
+        return `import '${path}';`;
+    }).join('\n')}
+`;
+    return template;
+};
+export function genComponentStyle() {
+    return {
+        name: 'farris-gen-component-style',
+        renderChunk(code, chunk) {
+            const { imports } = chunk;
+            const template = getComponentStyle(imports);
+            this.emitFile({
+                type: 'asset',
+                fileName: 'style.js',
+                source: template
+            });
+            return code;
+        }
+    };
+}
+;

package/lib/plugins/html-system.js

@@ -0,0 +1,11 @@
+export const htmlSystemPlugin = () => {
+    return {
+        name: 'html-transform-system',
+        transformIndexHtml(html) {
+            const regexp = /<script.*type="module".*src="(.*?)"><\/script>/;
+            return html.replace(regexp, (str, p1) => `
+    <script src="https://cdn.bootcdn.net/ajax/libs/systemjs/6.15.1/system.js"></script>
+    <script >System.import("${p1}");</script>`);
+        }
+    };
+};

package/lib/plugins/replace.js

@@ -0,0 +1,13 @@
+export function replace(path) {
+    return {
+        name: 'farris-replace',
+        renderChunk(code, chunk) {
+            const fileNames = chunk.fileName.split('.');
+            const format = fileNames[fileNames.length - 2];
+            return code.replace(/@components(\/\w+)/g, (...args) => {
+                return path(format, args);
+            });
+        }
+    };
+}
+;

package/package.json

@@ -1,26 +1,38 @@
 {
   "name": "@farris/cli",
-  "version": "1.0.28",
-  "description": "Farris command line interface",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "private": false,
+  "version": "2.0.0-beta.7",
+  "type": "module",
+  "typings": "lib/index.d.ts",
+  "bin": {
+    "farris-cli": "./bin/index.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://git.iec.io/webadp/farris-cli.git"
+  "engines": {
+    "node": ">=16.0.0"
   },
-  "keywords": [
-    "Farris",
-    "CLI"
-  ],
-  "bin": {
-    "farris": "ci/cli.js"
+  "scripts": {
+    "build": "rimraf ./lib && tsc"
   },
-  "author": "Sagi Chen",
-  "license": "ISC",
+  "files": [
+    "lib",
+    "templates",
+    "bin.js"
+  ],
   "dependencies": {
-    "lerna": "^4.0.0",
-    "moment": "^2.29.3"
+    "@types/inquirer": "^9.0.7",
+    "@vitejs/plugin-vue": "^4.0.0",
+    "@vitejs/plugin-vue-jsx": "^3.0.0",
+    "commander": "^9.4.0",
+    "esbuild-sass-plugin": "^3.3.1",
+    "inquirer": "^9.3.0",
+    "typescript": "^4.6.4",
+    "vite": "^4.4.1",
+    "vite-plugin-dts": "^3.9.1",
+    "vite-plugin-html": "^3.2.2"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.7",
+    "rimraf": "^5.0.7",
+    "vue": "^3.2.37"
   }
 }

package/templates/lib/.eslintrc.cjs

@@ -0,0 +1,15 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}

package/templates/lib/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

package/templates/lib/farris.config.mjs

@@ -0,0 +1,35 @@
+import { fileURLToPath, URL } from 'node:url';
+
+export default {
+  // 库模式配置
+  lib: {
+    // 入口 默认值 './src/main.ts'
+    entry: './packages/index.ts', 
+    // 库名称
+    name: "<%= name %>",
+    // 输出文件名
+    fileName: "index",
+    // 输出文件格式 默认值 ["es", 'systemjs']
+    formats: <%= formats %>, 
+  },
+  // 输出目录  App模式默认值 './dist' Lib模式 './lib'
+  // outDir: fileURLToPath(new URL('./dist', import.meta.url)),
+  // 最小化 默认值 true
+  minify: true,
+  // 外部依赖排除项 默认值 { include: [], exclude: [] }
+  // externals: {
+  //   include: [],
+  //   exclude: []
+  // },
+  // 是否排除 package.json 中 dependencies和 peerDependencies 依赖的包; App模式默认值 false Lib模式默认值 true
+  externalDependencies: true,
+  // 路径别名 默认值 null
+  alias: [
+    { find: '@', replacement: fileURLToPath(new URL('./src', import.meta.url)) },
+    { find: '@packages', replacement: fileURLToPath(new URL('./packages', import.meta.url)) },
+  ],
+  // 插件 默认值 [vue(), vueJsx()] 不要重复添加
+  // plugins: [],
+  // viteConfig 配置项
+  viteConfig: {}
+}

package/templates/lib/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <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/templates/lib/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "<%= name %>",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.js",
+  "scripts": {
+    "dev": "farris-cli dev",
+    "build": "farris-cli build-lib",
+    "preview": "farris-cli preview",
+    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+    "format": "prettier --write src/"
+  },
+  "dependencies": {
+    "vue": "^3.4.29"
+  },
+  "devDependencies": {
+    "@farris/cli": "<%= cliVersion %>",
+    "@rushstack/eslint-patch": "^1.8.0",
+    "@vue/eslint-config-prettier": "^9.0.0",
+    "@vue/eslint-config-typescript": "^13.0.0",
+    "@vue/tsconfig": "^0.5.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-vue": "^9.23.0",
+    "prettier": "^3.2.5",
+    "typescript": "~5.4.0"
+  }
+}