neko-ui 2.6.7 → 2.7.0

package/es/@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/es/@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': '这是更新后的文本',
-});
-```

package/es/@moneko/mock/api.md

@@ -1,177 +0,0 @@
-[TOC]
-
-# @moneko/mock
-
-!> 在项目启动目录 mock 文件夹下创建 mock 脚本，达到模拟响应数据的效果
-
-## 函数方式
-
-!> (req: RequestFormData, res: Response) => void
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'GET /api/account': (req, res) => {
-    const resp = {
-      success: true,
-      message: '请求成功',
-      result: {
-        inme: '人大',
-        effte: '2022/7/1',
-      },
-    };
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 获取 Restful Api 参数
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'GET /api/account/:id': (req, res) => {
-    const resp = {
-      success: true,
-      message: '请求成功',
-      result: {
-        id: req.params.id,
-        csaa: '人额',
-        currency: req.params.id,
-        effee: '2022/7/1',
-      },
-    };
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 获取 POST 请求体数据
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'POST /api/login_by_username': (req, res) => {
-    const resp = {
-      status: 200,
-      message: '请求成功',
-      result: {
-        password: req.body.password,
-        username: req.body.username,
-      },
-    };
-
-    res.status(resp.status).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 模拟上传文件，返回文件 base64
-
-```typescript
-import type { MockConfiguration } from '@moneko/core';
-
-const conf: MockConfiguration = {
-  'POST /api/upload_file': (req, res) => {
-    const { files } = req;
-
-    const strBase64 = Buffer.from(files[0].buffer).toString('base64');
-
-    const resp = {
-      status: 200,
-      message: '上传成功',
-      result: 'data:image/jpeg;base64,' + strBase64,
-    };
-
-    res.status(resp.status).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 使用 YApi JSON Schema 生成数据
-
-```typescript
-import { yApiSchemaMock } from '@moneko/mock';
-import type { MockConfiguration } from '@moneko/mock';
-
-const getYApiOption = (id: string) => {
-  return {
-    // yapi host
-    host: 'http://yapihost',
-    // yapi open api token
-    token: 'yapi open api token',
-    // yapi 接口id
-    id,
-  };
-};
-
-const conf: MockConfiguration = {
-  'POST /getids/list': async (req, res) => {
-    const mockData = await yApiSchemaMock(getYApiOption('7610'), {
-      result: {
-        page: req.body.pageNum,
-        itemsPerPage: req.body.pageSize,
-        keyword: req.body.keyword,
-      },
-    });
-
-    res.status(200).send(mockData);
-  },
-};
-
-export default conf;
-```
-
-### 使用 YApi 高级 Mock
-
-```typescript
-import { yApiMock } from '@moneko/mock';
-import type { MockConfiguration, YApiOption } from '@moneko/mock';
-
-const yApi: YApiOption = {
-  // yapi host
-  host: 'http://yapihost:8080',
-  projectId: 143,
-  pathRewrite: '^/api/',
-};
-
-const conf: MockConfiguration = {
-  'POST /api/getids/list': async (req, res) => {
-    // 此时 mockData 将是来自 POST http://yapihost:8080/mock/143/getids/list 响应的数据
-    const resp = await yApiMock(req, yApi);
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-## KV 方式
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'POST /api/use/fun': {
-    status: 200,
-    message: '上传成功',
-    effectiveDate: '2022/7/1',
-  },
-};
-
-export default conf;
-```

package/es/@moneko/request/api.md

@@ -1,31 +0,0 @@
-[TOC]
-
-# @moneko/request
-
-> 数据请求
-
-## 设置响应拦截器、请求前缀
-
-```typescript
-// @/services/index.ts
-import { extend } from '@moneko/request';
-export { request } from '@moneko/request';
-
-extend({
-  interceptor: {
-    response: (resp) => resp,
-  },
-  prefixUrl: '/api',
-});
-```
-
-## 调用 request 案例
-
-```typescript
-import { request } from '@/services';
-
-// 实际访问 /api/list
-export const getApi = () => request('/list');
-// 实际访问 /api/list
-export const postApi = (params = {}) => request('/list', { data: params, method: 'POST' });
-```

package/es/@moneko/routes/doc.md

@@ -1,81 +0,0 @@
-[TOC]
-
-# 约定式路由
-
-> 通过内置的虚拟模块 @app/routes 获取约定式路由, 在编译期间动态生成,均采用懒加载;
-
-1. 路由根据 `src/pages` 文件夹内的 `index.ts` 和 `index.tsx` 路径信息自动生成
-2. 比如 `src/pages/user/index.tsx` 会生成一个 path 为 `/user/:id` 的路由
-3. 文件夹名称以 `$` 开头将创建为动态路由
-4. 比如 `src/pages/user/$id/index.tsx` 会生成一个 path 为 `/user/:id` 的动态路由
-
-<div style="display:flex;gap: 16px;align-items:center;">
-
-<div>
-
-```treeview
-项目根目录
-`-- src
-    `-- pages
-        |-- user
-        |   |-- $id
-        |   |   `-- index.tsx
-        |   `-- index.tsx
-        `-- index.tsx
-```
-
-</div>
-
-将创建出以下路由
-
-1. `/`
-2. `/user`
-3. `/user/:id`
-
-</div>
-
-## 使用
-
-> 或参考 [demo](https://github.com/monako97/demo-micro-app-solid)
-
-## 读取路由数据
-
-```ts
-import routes from '@app/routes';
-
-console.log(routes);
-```
-
-## 自定义路由
-
-!> 当创建的约定式路由不足以满足您的需求时, 您可以通过创建 `src/router/index.ts` 来对其进行补充, 最终通过 `@app/routes` 获取的数据将是合并后的路由数据
-
-```js
-// src/router/index.ts
-import { lazy } from 'solid-js';
-import type { RouteConfig } from '@app/routes';
-
-const router: RouteConfig[] = [
-  {
-    path: '/',
-    // 补充路由
-    component: lazy(() => import('@/layout')),
-    children: [
-      // 自定义路由
-      {
-        path: 'about',
-        children: [
-          {
-            path: '/',
-            component: lazy(() => import('@/pages/home')),
-          },
-        ],
-      },
-    ],
-  },
-];
-
-export default router;
-```
-
-> React 应用与 Solid应用稍有差别, 具体可参考 [React demo](https://github.com/monako97/demo-micro-app-react) 和 [Solid demo](https://github.com/monako97/demo-micro-app-solid)