feat: 添加一些描述文件

packages/fes-plugin-access/package.json

@@ -32,6 +32,8 @@
   },
   "peerDependencies": {
     "@fesjs/fes": "^2.0.0",
-    "vue": "^3.0.5"
+    "vue": "^3.0.5",
-  }
+    "vue-router": "^4.0.1"
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-access/src/index.js

@@ -6,18 +6,18 @@ const namespace = 'plugin-access';
 
 export default (api) => {
     const {
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     api.describe({
         config: {
             schema(joi) {
                 return joi.object({
-                    roles: joi.object()
+                    roles: joi.object(),
                 });
             },
-            default: {}
+            default: {},
-        }
+        },
     });
 
     const absoluteFilePath = join(namespace, 'core.js');
@@ -30,27 +30,24 @@ export default (api) => {
 
         api.writeTmpFile({
             path: absoluteFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
-                {
                 REPLACE_ROLES: JSON.stringify(roles),
-                    lodashPath: resolvePkg('lodash-es')
+                lodashPath: resolvePkg('lodash-es'),
-                }
+            }),
-            )
         });
 
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['access', 'useAccess'],
-            source: absoluteFilePath
+            source: absoluteFilePath,
-        }
+        },
     ]);
 
     api.addRuntimePluginKey(() => 'access');

packages/fes-plugin-access/src/runtime/createDirective.js

@@ -41,6 +41,6 @@ export default function createDirective(useAccess) {
             if (ctx.unwatch) {
                 ctx.unwatch();
             }
-        }
+        },
     };
 }

packages/fes-plugin-access/src/runtime/runtime.js

@@ -6,12 +6,15 @@ export function onRouterCreated({ router }) {
         const runtimeConfig = plugin.applyPlugins({
             key: 'access',
             type: ApplyPluginsType.modify,
-            initialValue: {}
+            initialValue: {},
         });
         if (to.matched.length === 0) {
             if (runtimeConfig.noFoundHandler && typeof runtimeConfig.noFoundHandler === 'function') {
                 return runtimeConfig.noFoundHandler({
-                    router, to, from, next
+                    router,
+                    to,
+                    from,
+                    next,
                 });
             }
         }
@@ -27,7 +30,10 @@ export function onRouterCreated({ router }) {
         }
         if (runtimeConfig.unAccessHandler && typeof runtimeConfig.unAccessHandler === 'function') {
             return runtimeConfig.unAccessHandler({
-                router, to, from, next
+                router,
+                to,
+                from,
+                next,
             });
         }
         next(false);

packages/fes-plugin-access/types.d.ts

@@ -0,0 +1,14 @@
+import { Router, NavigationGuard } from 'vue-router';
+
+export interface AccessBuildConfig {
+    access: {
+        rules: Record<string, []>;
+    };
+}
+
+export interface AccessRuntimeConfig {
+    access: {
+        noFoundHandler: (param: { router: Router } & NavigationGuard) => void;
+        unAccessHandler: (param: { router: Router } & NavigationGuard) => void;
+    };
+}

packages/fes-plugin-layout/package.json

@@ -32,6 +32,8 @@
   "peerDependencies": {
     "@fesjs/fes": "^2.0.0",
     "@fesjs/fes-design": "^0.3.3",
-    "vue": "^3.0.5"
+    "vue": "^3.0.5",
-  }
+    "vue-router": "^4.0.1"
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-layout/src/index.js

@@ -6,7 +6,7 @@ const namespace = 'plugin-layout';
 
 export default (api) => {
     const {
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     const helper = require('./node/helper');
@@ -17,8 +17,8 @@ export default (api) => {
             schema(joi) {
                 return joi.object();
             },
-            onChange: api.ConfigChangeType.regenerateTmpFiles
+            onChange: api.ConfigChangeType.regenerateTmpFiles,
-        }
+        },
     });
 
     api.addRuntimePluginKey(() => 'layout');
@@ -36,7 +36,7 @@ export default (api) => {
         const userConfig = {
             title: name,
             footer: 'Created by Fes.js',
-            ...(api.config.layout || {})
+            ...(api.config.layout || {}),
         };
 
         // 路由信息
@@ -46,46 +46,39 @@ export default (api) => {
 
         const icons = helper.getIconsFromMenu(userConfig.menus);
 
-        const iconsString = icons.map(
+        const iconsString = icons.map((iconName) => `import { ${iconName} } from '@fesjs/fes-design/icon'`);
-            iconName => `import { ${iconName} } from '@fesjs/fes-design/icon'`
-        );
         api.writeTmpFile({
             path: join(namespace, 'icons.js'),
             content: `
         ${iconsString.join(';\n')}
         export default {
             ${icons.join(',\n')}
-        }`
+        }`,
         });
 
         api.writeTmpFile({
             path: absFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/index.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/index.tpl'), 'utf-8'),
-                {
                 REPLACE_USER_CONFIG: JSON.stringify(userConfig),
-                    HAS_LOCALE
+                HAS_LOCALE,
-                }
+            }),
-            )
         });
 
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);
 
     // 把BaseLayout插入到路由配置中，作为根路由
-    api.modifyRoutes(routes => [
+    api.modifyRoutes((routes) => [
         {
             path: '/',
-            component: winPath(
+            component: winPath(join(api.paths.absTmpPath || '', absFilePath)),
-                join(api.paths.absTmpPath || '', absFilePath)
+            children: routes,
-            ),
+        },
-            children: routes
-        }
     ]);
 };

packages/fes-plugin-layout/types.d.ts

@@ -0,0 +1,38 @@
+import { Component } from 'vue';
+import { Router, NavigationGuard } from 'vue-router';
+
+interface Menu {
+    name: string;
+    path: string;
+    match: string[];
+    title: string;
+    icon: string;
+    children?: Menu[]
+}
+
+export interface LayoutBuildConfig {
+    layout: {
+        title: string;
+        footer: string;
+        theme: 'dark' | 'light';
+        multiTabs: boolean;
+        navigation: 'side' | 'top' | 'mixin';
+        fixedHeader: boolean;
+        fixedSideBar: boolean;
+        sideWidth: number;
+        menus: Menu[];
+    };
+}
+
+
+
+export interface LayoutRuntimeConfig {
+    layout: {
+        header: boolean;
+        sidebar: boolean;
+        logo: boolean;
+        customHeader: Component,
+        noFoundHandler: (param: { router: Router } & NavigationGuard) => void;
+        unAccessHandler: (param: { router: Router } & NavigationGuard) => void;
+    };
+}

packages/fes-plugin-locale/package.json

@@ -34,5 +34,6 @@
     "@fesjs/fes": "^2.0.0",
     "@fesjs/fes-design": "^0.1.10",
     "vue": "^3.0.5"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-locale/src/index.js

@@ -7,7 +7,7 @@ const namespace = 'plugin-locale';
 
 export default (api) => {
     const {
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     api.describe({
@@ -17,8 +17,8 @@ export default (api) => {
                 return joi.object();
             },
             default: {},
-            onChange: api.ConfigChangeType.regenerateTmpFiles
+            onChange: api.ConfigChangeType.regenerateTmpFiles,
-        }
+        },
     });
 
     api.addRuntimePluginKey(() => 'locale');
@@ -41,7 +41,7 @@ export default (api) => {
             fallbackLocale: 'zh-CN', // set fallback locale
             legacy: true,
             baseNavigator: true, // 开启浏览器语言检测
-            ...api.config.locale
+            ...api.config.locale,
         };
 
         const localeConfigFileBasePath = getLocaleFileBasePath();
@@ -50,33 +50,34 @@ export default (api) => {
 
         api.writeTmpFile({
             path: absoluteFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
-                {
                 REPLACE_LOCALES: locales,
-                    REPLACE_DEFAULT_OPTIONS: JSON.stringify({
+                REPLACE_DEFAULT_OPTIONS: JSON.stringify(
+                    {
                         locale: userConfig.locale,
                         fallbackLocale: userConfig.fallbackLocale,
-                        legacy: userConfig.legacy
+                        legacy: userConfig.legacy,
-                    }, null, 2),
+                    },
+                    null,
+                    2,
+                ),
                 BASE_NAVIGATOR: userConfig.baseNavigator,
-                    VUE_I18N_PATH: resolvePkg('vue-i18n')
+                VUE_I18N_PATH: resolvePkg('vue-i18n'),
-                }
+            }),
-            )
         });
 
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['useI18n', 'locale'],
-            source: absoluteFilePath
+            source: absoluteFilePath,
-        }
+        },
     ]);
 
     api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);

packages/fes-plugin-locale/types.d.ts

@@ -0,0 +1,8 @@
+export interface LocalBuildConfig {
+    locale: {
+        locale: string;
+        fallbackLocale: string;
+        baseNavigator: boolean;
+        legacy: boolean;
+    };
+}

packages/fes-plugin-model/src/index.js

@@ -1,4 +1,3 @@
-
 import { readFileSync } from 'fs';
 import { join } from 'path';
 import { lodash, winPath } from '@fesjs/utils';
@@ -10,7 +9,7 @@ const namespace = 'plugin-model';
 export default (api) => {
     const {
         paths,
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     function getModelDir() {
@@ -24,7 +23,7 @@ export default (api) => {
     function getAllModels() {
         const srcModelsPath = getModelsPath();
         return lodash.uniq([
-            ...getModels(srcModelsPath)
+            ...getModels(srcModelsPath),
             // ...getModels(
             //     paths.absPagesPath,
             //     `**/${getModelDir()}/**/*.{js,jsx}`
@@ -35,14 +34,16 @@ export default (api) => {
 
     const absCoreFilePath = join(namespace, 'core.js');
     const absRuntimeFilePath = join(namespace, 'runtime.js');
-    const absInitlaStateFilePath = join(namespace, 'models/initialState.js');
+    const absInitialStateFilePath = join(namespace, 'models/initialState.js');
 
     api.register({
         key: 'addExtraModels',
-        fn: () => [{
+        fn: () => [
-            absPath: winPath(join(paths.absTmpPath, absInitlaStateFilePath)),
+            {
-            namespace: '@@initialState'
+                absPath: winPath(join(paths.absTmpPath, absInitialStateFilePath)),
-        }]
+                namespace: '@@initialState',
+            },
+        ],
     });
 
     api.onGenerateFiles(async () => {
@@ -51,7 +52,7 @@ export default (api) => {
         const additionalModels = await api.applyPlugins({
             key: 'addExtraModels',
             type: api.ApplyPluginsType.add,
-            initialValue: []
+            initialValue: [],
         });
 
         const tmpFiles = getTmpFile(files, additionalModels, paths.absSrcPath);
@@ -59,28 +60,26 @@ export default (api) => {
         api.writeTmpFile({
             path: absCoreFilePath,
             content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
-                ...tmpFiles
+                ...tmpFiles,
-            })
+            }),
         });
 
         api.writeTmpFile({
             path: absRuntimeFilePath,
-            content: Mustache.render(readFileSync(join(__dirname, 'runtime/runtime.tpl'), 'utf-8'), {
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/runtime.tpl'), 'utf-8'), {}),
-            })
         });
 
         api.writeTmpFile({
-            path: absInitlaStateFilePath,
+            path: absInitialStateFilePath,
-            content: Mustache.render(readFileSync(join(__dirname, 'runtime/models/initialState.tpl'), 'utf-8'), {
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/models/initialState.tpl'), 'utf-8'), {}),
-            })
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['useModel'],
-            source: absCoreFilePath
+            source: absCoreFilePath,
-        }
+        },
     ]);
 
     api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);

packages/fes-plugin-monaco-editor/package.json

@@ -33,5 +33,6 @@
   "peerDependencies": {
     "@fesjs/fes": "^2.0.0",
     "vue": "^3.0.5"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-monaco-editor/src/index.js

@@ -6,7 +6,7 @@ const namespace = 'plugin-monaco-editor';
 
 export default (api) => {
     const {
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     api.describe({
@@ -18,12 +18,11 @@ export default (api) => {
                     publicPath: joi.string(),
                     languages: joi.array(),
                     features: joi.array(),
-                    globalAPI: joi.boolean()
+                    globalAPI: joi.boolean(),
                 });
-            }
             },
-        default: {
+        },
-        }
+        default: {},
     });
 
     const absoluteFilePath = join(namespace, 'core.js');
@@ -37,52 +36,40 @@ export default (api) => {
         // 文件写出
         api.writeTmpFile({
             path: absoluteFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {}),
-                readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
-                {
-                }
-            )
         });
 
         api.writeTmpFile({
             path: absRuntimeFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/runtime.tpl'), 'utf-8')),
-                readFileSync(join(__dirname, 'runtime/runtime.tpl'), 'utf-8')
-            )
         });
 
         api.writeTmpFile({
             path: absLoaderFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/loader.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/loader.tpl'), 'utf-8'),
+                MONACO_EDITOR: resolvePkg('monaco-editor'),
-                {
+            }),
-                    MONACO_EDITOR: resolvePkg('monaco-editor')
-                }
-            )
         });
 
         api.writeTmpFile({
             path: absEditorFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/editor.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/editor.tpl'), 'utf-8'),
+                LODASH_ES: resolvePkg('lodash-es'),
-                {
+            }),
-                    LODASH_ES: resolvePkg('lodash-es')
-                }
-            )
         });
 
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['monaco', 'MonacoEditor'],
-            source: absoluteFilePath
+            source: absoluteFilePath,
-        }
+        },
     ]);
 
     api.addRuntimePluginKey(() => 'monacoEditor');
@@ -90,11 +77,7 @@ export default (api) => {
     api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);
 
     api.chainWebpack((webpackConfig) => {
-        webpackConfig
+        webpackConfig.plugin('monaco-editor').use(require('monaco-editor-webpack-plugin'), [api.config?.monacoEditor || {}]);
-            .plugin('monaco-editor')
-            .use(require('monaco-editor-webpack-plugin'), [
-                api.config?.monacoEditor || {}
-            ]);
         return webpackConfig;
     });
 };

packages/fes-plugin-monaco-editor/types.d.ts

@@ -0,0 +1,12 @@
+import type { EditorLanguage } from 'monaco-editor-webpack-plugin/out/languages';
+import type { EditorFeature } from 'monaco-editor-webpack-plugin/out/features';
+
+export interface MonacoEditorBuildConfig {
+    monacoEditor: {
+        filename: string;
+        publicPath: string;
+        languages: EditorLanguage[];
+        features: EditorFeature[];
+        globalAPI: boolean;
+    };
+}

packages/fes-plugin-pinia/src/index.js

@@ -8,7 +8,7 @@ const namespace = 'plugin-pinia';
 export default (api) => {
     const {
         paths,
-        utils: { Mustache }
+        utils: { Mustache },
     } = api;
 
     api.describe({
@@ -17,8 +17,8 @@ export default (api) => {
             schema(joi) {
                 return joi.object();
             },
-            onChange: api.ConfigChangeType.regenerateTmpFiles
+            onChange: api.ConfigChangeType.regenerateTmpFiles,
-        }
+        },
     });
 
     const absCoreFilePath = join(namespace, 'core.js');
@@ -31,27 +31,24 @@ export default (api) => {
         // 文件写出
         api.writeTmpFile({
             path: absCoreFilePath,
-            content: Mustache.render(
+            content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
-                readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
-                {
                 IMPORT_PLUGINS: store.importPlugins.join('\n'),
-                    PLUGINS: store.plugins
+                PLUGINS: store.plugins,
-                }
+            }),
-            )
         });
 
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['pinia'],
-            source: absCoreFilePath
+            source: absCoreFilePath,
-        }
+        },
     ]);
 
     api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);

packages/fes-template/package.json

@@ -58,6 +58,7 @@
     "@fesjs/plugin-windicss": "^2.0.0",
     "@fesjs/plugin-pinia": "^2.0.0",
     "@fesjs/fes-design": "^0.3.3",
+    "@fesjs/build-webpack": "^1.0.0",
     "vue": "^3.0.5",
     "vuex": "^4.0.0",
     "pinia": "^2.0.11"