neko-ui 2.6.7 → 2.7.0

package/lib/@moneko/cli/doc.md

@@ -1,211 +0,0 @@
-[TOC]
-
-# @moneko/cli
-
-> 这是一个脚手架工具, 可以快速进行一个组件库、单页面、微前端(乾坤)、后台管理、模块联邦应用的开发, 目前支持React18、Solid.js
-
-## 快速开始
-
-```shell
-# 安装脚手架工具
-npm i @moneko/cli -g
-```
-
-## 创建一个新项目
-
-```shell
-mo create my-project
-# 按提示步骤完成创建, my-project 为项目名
-```
-
-## 进入项目目录
-
-```shell
-cd my-project
-```
-
-## 使用 npm
-
-### 安装依赖
-
-```shell
-npm install
-```
-
-### 启动开发服务器
-
-```shell
-npm start
-```
-
-### 补充配置启动
-
-例如额外加载 `/config/prod.ts` 中的启动参数
-
-```shell
-npm start --config=prod
-```
-
-### 构建项目
-
-```shell
-npm run build
-```
-
-### 补充配置构建
-
-例如额外加载 `/config/prod.ts` 中的启动参数
-
-```shell
-npm run build --config=prod
-```
-
-## 使用 Yarn
-
-### 安装
-
-```shell
-yarn
-```
-
-### 启动
-
-```shell
-yarn start
-```
-
-### 使用补充配置启动
-
-例如额外加载 `/config/prod.ts` 中的启动参数
-
-```shell
-yarn start config=prod
-```
-
-### 构建
-
-```shell
-yarn build
-```
-
-### 使用补充配置构建
-
-例如额外加载 `/config/prod.ts` 中的启动参数
-
-```shell
-yarn build config=prod
-```
-
-## 编译 app
-
-> 使用 flutter 3.0
-> 应用类型为 mobile 的项目中执行打包步骤`npm run build`，确保正确生产出的资产在 `dist` 文件夹中，然后执行 `mo buildApp`，按控制台提示操作
-
-```shell
-mo buildApp
-? 请输入软件包名称? com.moneko.bid ## 默认值
-? 请选择需要打包的类型 打包为apk (release)
-❯◉ 打包为apk (release) # 方向上下键选择条目，按空格键选中，回车键确认
- ◯ 打包为apk (debug)
- ◯ 打包为ipa (release)[未签名，需要 OSX 及 Xcode]
- ◯ 打包为ipa (debug)[未签名，需要 OSX 及 Xcode]
-
- # ...
- Running Gradle task 'assembleRelease'...                           27.7s
-✓  Built build/app/outputs/flutter-apk/app-release.apk (15.8MB).
-Done
-
-```
-
-## Commands
-
-### eslint
-
-**使用:**
-
-```shell
-mo eslint [options] <source>
-```
-
-描述：js代码规范检查。
-
-### stylelint
-
-**使用:**
-
-```shell
-mo stylelint [options] <source>
-```
-
-描述：css代码规范检查。
-
-### build
-
-**使用:**
-
-```shell
-mo build <type> <framework>
-```
-
-描述：编译项目。
-
-### start
-
-**使用:**
-
-```shell
-mo start <type> <framework>
-```
-
-描述：运行项目。
-
-### create
-
-**使用:**
-
-```shell
-mo create <name> [destination]
-```
-
-描述：创建一个新项目。
-
-### buildApp
-
-**使用:**
-
-```shell
-mo buildApp
-```
-
-描述：编译将 h5 应用打包成移动客户端，使用 Flutter。
-
-### githooks
-
-**使用:**
-
-```shell
-mo githooks pre-commit=\"yarn precommit\"
-```
-
-描述：git hooks工具。
-
-### changelog
-
-**使用:**
-
-```shell
-mo changelog <filename>
-# mo changelog CHANGELOG.md
-```
-
-描述：生成 `CHANGELOG.md`。
-
-### help
-
-**使用:**
-
-```shell
-mo help
-```
-
-描述：展示命令的帮助。

package/lib/@moneko/config/api.md

@@ -1,213 +0,0 @@
-[TOC]
-
-# 配置项
-
-!> 适用于使用 `@moneko/cli` 创建的项目
-!> 可以在项目根目录下的 `config/` 文件夹中进行以下配置
-
-[1]: https://swc.rs/docs/configuration/minification#jscminifycompress 'SwcOptions'
-[2]: https://terser.org/docs/api-reference#compress-options 'TerserOptions'
-
-## ConfigType
-
-| 属性              | 说明                                              | 类型                                                                                            | 默认值             |
-| ----------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------ |
-| clean             | 清除过时的打包文件                                | boolean                                                                                         | true               |
-| compiler          | 编译方式                                          | swc\|tsc                                                                                        | swc                |
-| swcrc             | swc 配置项                                        | SwcConfig \| ((isDev: boolean) => SwcConfig)                                                    | -                  |
-| entry             | 额外的 entry, 比如兼容 es10 的 object.fromentries | Record<string, string>                                                                          | -                  |
-| minifier          | js、css 压缩配置                                  | { type?: swc\|tsc; options?: [SwcOptions][1] \| [TerserOptions][2]; css?: cssnano \| parcelCss} | -                  |
-| env               | 环境变量, 可通过 process.env 获取                 | Record<string, any>                                                                             | -                  |
-| sourceMap         | sourceMap 配置                                    | SourceMapDevToolPluginOptions \| false                                                          | -                  |
-| devtool           | devtool 配置                                      | Configuration['devtool']                                                                        | -                  |
-| alias             | 路径别名映射                                      | Record<string, string>                                                                          | -                  |
-| basename          | 根路由                                            | string                                                                                          | /                  |
-| publicPath        | 资源根路径                                        | string                                                                                          | auto               |
-| rem               | 设置与设计图相匹配的rem                           | {designSize: number}                                                                            | {designSize: 1680} |
-| fallbackCompPath  | 自定义容错组件路径                                | string                                                                                          | -                  |
-| modifyVars        | less 全局变量                                     | Record<string, string>                                                                          | -                  |
-| prefixCls         | 类名前缀                                          | string                                                                                          | n                  |
-| moduleRules       | 自定义 webpack module rules                       |                                                                                                 | -                  |
-| cssModules        | node_modules 中, 需要开启 cssModules 的模块       | string[]                                                                                        | -                  |
-| importOnDemand    | 按需引入                                          | SwcImportOnDemandTransform \| TsImportPlugin.Options                                            | -                  |
-| proxy             | 服务器代理                                        | Record<string, string>                                                                          | -                  |
-| cacheDirectory    | 自定义缓存目录，为 false 时，不使用缓存           | string \| false                                                                                 | -                  |
-| devServer         | 开发服务器设置                                    | Record<string, string>                                                                          | -                  |
-| assetHtml         | 自定义插入 html 的 js 和 css                      | AssetHtmlOptions[]                                                                              | -                  |
-| htmlPluginOption  | HtmlWebpackPlugin Option                          | HtmlWebpackPluginOptions                                                                        | -                  |
-| routerMode        | 路由模式                                          | hash \| browser \| memory                                                                       | browser            |
-| plugins           | webpack 插件                                      |                                                                                                 | -                  |
-| splitChunk        | 对生产 chunk 进行拆分                             | false \| OptimizationSplitChunksOptions                                                         | -                  |
-| output            | 编译输出路径                                      | string                                                                                          | -                  |
-| runtimeChunk      | 拆分 runtime                                      | boolean\|single \| multiple\| { name?: string \| Function };                                    | -                  |
-| moduleFederation  | 模块联邦                                          | ModuleFederationOption[]                                                                        | -                  |
-| externals         | 跳过编译的模块                                    | string[]                                                                                        | -                  |
-| rulesInclude      | 需要进入到规则的模块或者位置                      | { less?: string[]; css?: string[]; js?: string[]; media?: string[]; fonts?: string[]; }         | -                  |
-| bundleAnalyzer    | js打包体积分析                                    | { analyzerMode: string; reportFilename: string; openAnalyzer: false }                           | -                  |
-| prefixJsLoader    | 解析js/ts的前置loader                             | -                                                                                               | -                  |
-| bar               | 是否打包显示进度条                                | -                                                                                               | true               |
-| theme             | 设置主题, 可以在 `@app/info` 中获取值             | -                                                                                               | -                  |
-| seo               | 配置seo优化                                       | {domain: string; nojekyll?: boolean; path?: string;}                                            | true               |
-| done              | 打包完成执行的回调                                | () => void                                                                                      | -                  |
-| mdx               | mdx loader的配置项                                | MDXOptions                                                                                      | -                  |
-| jsxDomExpressions | 使用solidjs时jsx-dom-expressions的配置项          | JsxDomExpressions                                                                               | -                  |
-| virtualModule     | 自定义虚拟模块                                    | Record<string, string \| object>                                                                | -                  |
-| normalizeCss      | 是否使用 normalize css                            | boolean                                                                                         | true               |
-
-### SwcOptions
-
-!> [SwcOptions][1]
-
-### TerserOptions
-
-!> [TerserOptions][2]
-
-## 按需导入 `swc`
-
-!> 使用 swc 时的按需导入配置 importOnDemand: { '库名': {...配置项} }
-
-### SwcImportOnDemandTransform
-
-| 属性                  | 说明                                                                            | 类型                  | 默认值  |
-| --------------------- | ------------------------------------------------------------------------------- | --------------------- | ------- |
-| transform             | 要使用的库名称，而不是导入语句中指定的库名称。`${member}` 是替换的成员          | string                | -       |
-| style                 | 设置转换时需要单独导入的样式，`${member}` 是替换的成员                          | `string` \|`boolean`  | `false` |
-| skipDefaultConversion | 当设置为 true 时，将保留 `import { Button }` 语法，而不是转换为 `import Button` | boolean               | `false` |
-| preventFullImport     | 当遇到会导致导入整个模块时，是否抛出                                            | boolean               | `true`  |
-| memberTransformers    | 成员转换规则                                                                    | `MemberTransformer`[] | []      |
-
-### MemberTransformer
-
-| 属性        | 说明                                                                                                       |
-| ----------- | ---------------------------------------------------------------------------------------------------------- |
-| pascal_case | 帕斯卡拼写法(大驼峰): 所有单词的首字母大写，然后直接连接起来，单词之间没有连接符                           |
-| camel_case  | 骆驼拼写法(小驼峰): 第一个单词的首字母小写, 后续所有单词的首字母大写，然后直接连接起来，单词之间没有连接符 |
-| kebab_case  | 连字符拼写法: 各个单词或缩写之间以`-`做间隔                                                                |
-| dashed_case | 破折号式: 每个单词全小写或全大写，多单词使用`-`隔开                                                        |
-| snake_case  | 蛇形命名: 每个单词全小写或全大写，多单词使用`_`隔开                                                        |
-
-### 配置案例 MemberTransformer
-
-```javascript
-const conf = {
-  importOnDemand: {
-    /** 库名 */
-    lodash: {
-      transform: '${member}',
-    },
-    /** 库名 */
-    antd: {
-      transform: 'es/${member}',
-      style: 'es/${member}/style',
-      memberTransformers: ['dashed_case'],
-    },
-  },
-};
-// 以下代码将会按照预期进行转换
-import { BackTop } from 'antd';
-import { isFunction } from 'lodash';
-// to
-import BackTop from 'antd/es/back-top';
-import 'antd/es/back-top/style';
-import isFunction from 'lodash/isFunction';
-```
-
-## 模块联邦
-
-!> Webpack5 Module Federation
-
-### ModuleFederationOption
-
-| 属性     | 说明                                           | 类型                                                 | 默认值            |
-| -------- | ---------------------------------------------- | ---------------------------------------------------- | ----------------- |
-| name     | 模块名称，唯一性，不能重名                     | string                                               | -                 |
-| filename | 打包的模块文件名                               | string                                               | `remote_entry.js` |
-| name     | 模块名称，唯一性，不能重名                     | string                                               | -                 |
-| remotes  | 表示作为 Host 时, 去消费哪些 Remote            | `ModuleFederationRemotes`[]                          | -                 |
-| exposes  | 当前模块具体导出去的内容                       | `string` \| { name: `string`; path: `string`; }      | -                 |
-| shared   | 优先用 Host 的依赖, 如果 Host 没有, 再用自己的 | `Record<string, SharedConfig \| string>`\|`string`[] | -                 |
-| library  | library                                        | { type: `var` \| `string`; name: `string`; }         | -                 |
-| runtime  | runtime                                        | string                                               | -                 |
-
-### ModuleFederationRemotes
-
-| 属性     | 说明                   | 类型       | 默认值            |
-| -------- | ---------------------- | ---------- | ----------------- |
-| name     | 远程模块名称           | string     | -                 |
-| filename | 远程模块文件名         | string     | `remote_entry.js` |
-| host     | 远程模块访问地址       | string     | -                 |
-| alias    | 远程模块别名           | string     | -                 |
-| library  | 从此模块加载的 library | `string`[] | -                 |
-
-### SharedConfig
-
-| 属性            | 说明                                                                                                                   | 类型    | 默认值 |
-| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ------- | ------ |
-| eager           | 直接在异步请求后面包含提供的和后备模块,这也允许在初始加载中使用此共享模块,所有可能的共享模块也都需要急切               | boolean | -      |
-| import          | 应提供共享范围的提供的模块,如果在共享作用域中找不到共享模块或版本无效,则还充当回退模块,默认为属性名称                  | number  | -      |
-| packageName     | 软件包名称,用于从描述文件中确定所需的版本,仅当无法根据请求自动确定包名称时才需要                                       | string  | -      |
-| requiredVersion | 共享范围中来自模块的版本要求                                                                                           | number  | -      |
-| shareKey        | 在共享范围内的此键下查找模块                                                                                           | string  | -      |
-| shareScope      | 共享范围名称                                                                                                           | string  | -      |
-| singleton       | 在共享范围内仅允许共享模块的单个版本(默认情况下处于禁用状态)                                                           | boolean | -      |
-| strictVersion   | 如果版本无效,则不接受共享模块(默认为是,如果本地后备模块可用并且共享模块不是单例,否则为 no,如果未指定所需的版本,则无效) | boolean | -      |
-| version         | 所提供模块的版本,将替换较低的匹配版本,但不会替换较高的版本                                                             | number  | -      |
-
-### 配置案例 moduleFederation
-
-```javascript
-import type { ConfigType } from '@moneko/core';
-
-const PACKAGENAME = process.env.npm_package_name; // 当前package.json中的name
-const config: Partial<ConfigType> = {
-  htmlPluginOption: {
-    tags: [
-      {
-        textContent: `window.__RemoteEntry__={
-          // 比如你已经构建了一个 sharedLibrary 作为模块联邦的共享库
-          sharedLibrary: '//可以访问 sharedLibrary 的链接'
-        };`,
-      },
-    ],
-  },
-  moduleFederation: [
-    {
-      name: PACKAGENAME.replace(/-/g, '_'),
-      remotes: [
-        {
-          name: 'sharedLibrary',
-          host: '[window.__RemoteEntry__.sharedLibrary]',
-          // 下面的这些模块在将通过网络使用sharedLibrary中的资源,而不是本地
-          library: ['react', 'react-dom', 'react-router', 'react-router-dom', 'antd'],
-        },
-      ],
-    },
-  ],
-};
-
-export default config;
-```
-
-## 自定义模块解析规则
-
-```javascript
-// config/index.ts
-export default {
-  moduleRules: [
-    {
-      test: /\.aaa$/,
-      type: 'assets',
-      exclude: [/node_modules/],
-    },
-  ],
-};
-```
-
-## 自定义 ts-loader 配置
-
-!> 在项目根目录下创建一个 tsloader.config.ts
-
-```javascript
-// tsloader.config.ts
-export default {};
-```

package/lib/@moneko/locales/doc.md

@@ -1,130 +0,0 @@
-[TOC]
-
-# 文本国际化
-
-> 通过内置的虚拟模块 @app/locales 进行文本国际化;
-> 国际化内容依赖项目目录下的 `src/locales` 文件夹内容自动生成
-> 一个文件对应一种语言, 默认语言名称为文件名
-
-<div style="display:flex;gap: 16px;">
-
-<div>
-
-```treeview
-项目根目录
-`-- src
-    `-- locales
-        |-- zh-CN.ts
-        `-- en.ts
-```
-
-</div>
-
-```ts
-// zh-CN.ts
-import type { LocaleConfig } from '@app/locales';
-
-const en: LocaleConfig = {
-  title: '中文',
-  translation: {
-    home: '首页',
-  },
-};
-
-export default en;
-```
-
-```ts
-// en.ts
-import type { LocaleConfig } from '@app/locales';
-
-const en: LocaleConfig = {
-  language: 'en_US', // 自定义语言名称
-  title: '英文',
-  translation: {
-    home: 'Home',
-  },
-};
-
-export default en;
-```
-
-</div>
-
-## 使用
-
-> 或参考 [demo](https://github.com/monako97/demo-micro-app-solid)
-
-```ts
-import { setLang, t } from '@app/locales';
-
-console.log(t.home); // 首页
-setLang('en_US');
-console.log(t.home); // Home
-```
-
-## 语言列表
-
-!> 通过 `locales` 获取当前项目的语言列表
-
-```ts
-import { locales } from '@app/locales';
-
-console.log(locales);
-```
-
-## 插值字符串
-
-!> 通过 `interpolateString` 方法进行插值字符串转换; 替换字符串中的占位符 `${}` 为对应的值
-
-```ts
-import { interpolateString } from '@app/locales';
-
-interpolateString('`The length is ${val} characters!`', { val: 62 });
-```
-
-## 修改语言
-
-!> 使用 `setLang` 方法修改语言
-
-```ts
-import { setLang } from '@app/locales';
-
-setLang('zh_CN');
-```
-
-## 使用的语言
-
-!> 使用 `lang` 获取当前使用的语言
-
-```ts
-import { lang } from '@app/locales';
-
-console.log(lang);
-```
-
-## 映射
-
-!> 使用 `t` 获取对应字典的当前语言文本
-
-```ts
-import { t } from '@app/locales';
-
-console.log(t['password-fap']);
-```
-
-## 设置语种
-
-!> 通过 `setLocalizable` 设置或修改一个新的语种(滞后/更新), 可用于线上紧急更新文案
-
-```ts
-import { setLocalizable } from '@app/locales';
-
-setLocalizable('lang', {
-  language: 'zh-HK',
-  title: '繁体中文',
-});
-setLocalizable('t', {
-  'password-fap': '这是更新后的文本',
-});
-```