blackteay/fes.js
1
0
Fork 0
mirror of https://github.com/WeBankFinTech/fes.js.git synced 2025-04-05 19:41:57 +08:00
Code Issues Projects Releases Wiki Activity

feat: 添加一些描述文件

Browse Source
This commit is contained in:
wanchun 2022-03-28 20:17:54 +08:00
parent a9ffca2262
commit 3ffab50096
17 changed files with 183 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/fes-plugin-access/package.json
View File

@ -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"
}

25
packages/fes-plugin-access/src/index.js
View File

@ -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(
readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
{
REPLACE_ROLES: JSON.stringify(roles),
lodashPath: resolvePkg('lodash-es')
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
REPLACE_ROLES: JSON.stringify(roles),
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');

2
packages/fes-plugin-access/src/runtime/createDirective.js
View File

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

12
packages/fes-plugin-access/src/runtime/runtime.js
View File

@ -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);

14
packages/fes-plugin-access/types.d.ts vendored Normal file
View File

@ -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;
};
}

6
packages/fes-plugin-layout/package.json
View File

@ -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"
}

37
packages/fes-plugin-layout/src/index.js
View File

@ -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(
iconName => `import { ${iconName} } from '@fesjs/fes-design/icon'`
);
const iconsString = icons.map((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(
readFileSync(join(__dirname, 'runtime/index.tpl'), 'utf-8'),
{
REPLACE_USER_CONFIG: JSON.stringify(userConfig),
HAS_LOCALE
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/index.tpl'), 'utf-8'), {
REPLACE_USER_CONFIG: JSON.stringify(userConfig),
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(
join(api.paths.absTmpPath || '', absFilePath)
),
children: routes
}
component: winPath(join(api.paths.absTmpPath || '', absFilePath)),
children: routes,
},
]);
};

38
packages/fes-plugin-layout/types.d.ts vendored Normal file
View File

@ -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;
};
}

3
packages/fes-plugin-locale/package.json
View File

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

37
packages/fes-plugin-locale/src/index.js
View File

@ -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(
readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
{
REPLACE_LOCALES: locales,
REPLACE_DEFAULT_OPTIONS: JSON.stringify({
content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
REPLACE_LOCALES: locales,
REPLACE_DEFAULT_OPTIONS: JSON.stringify(
{
locale: userConfig.locale,
fallbackLocale: userConfig.fallbackLocale,
legacy: userConfig.legacy
}, null, 2),
BASE_NAVIGATOR: userConfig.baseNavigator,
VUE_I18N_PATH: resolvePkg('vue-i18n')
}
)
legacy: userConfig.legacy,
},
null,
2,
),
BASE_NAVIGATOR: userConfig.baseNavigator,
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}`);

8
packages/fes-plugin-locale/types.d.ts vendored Normal file
View File

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

35
packages/fes-plugin-model/src/index.js
View File

@ -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: () => [{
absPath: winPath(join(paths.absTmpPath, absInitlaStateFilePath)),
namespace: '@@initialState'
}]
fn: () => [
{
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,
content: Mustache.render(readFileSync(join(__dirname, 'runtime/models/initialState.tpl'), 'utf-8'), {
})
path: absInitialStateFilePath,
content: Mustache.render(readFileSync(join(__dirname, 'runtime/models/initialState.tpl'), 'utf-8'), {}),
});
});
api.addPluginExports(() => [
{
specifiers: ['useModel'],
source: absCoreFilePath
}
source: absCoreFilePath,
},
]);
api.addRuntimePlugin(() => `@@/${absRuntimeFilePath}`);

3
packages/fes-plugin-monaco-editor/package.json
View File

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

49
packages/fes-plugin-monaco-editor/src/index.js
View File

@ -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(
readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
{
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {}),
});
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: absLoaderFilePath,
content: Mustache.render(
readFileSync(join(__dirname, 'runtime/loader.tpl'), 'utf-8'),
{
MONACO_EDITOR: resolvePkg('monaco-editor')
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/loader.tpl'), 'utf-8'), {
MONACO_EDITOR: resolvePkg('monaco-editor'),
}),
});
api.writeTmpFile({
path: absEditorFilePath,
content: Mustache.render(
readFileSync(join(__dirname, 'runtime/editor.tpl'), 'utf-8'),
{
LODASH_ES: resolvePkg('lodash-es')
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/editor.tpl'), 'utf-8'), {
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
.plugin('monaco-editor')
.use(require('monaco-editor-webpack-plugin'), [
api.config?.monacoEditor || {}
]);
webpackConfig.plugin('monaco-editor').use(require('monaco-editor-webpack-plugin'), [api.config?.monacoEditor || {}]);
return webpackConfig;
});
};

12
packages/fes-plugin-monaco-editor/types.d.ts vendored Normal file
View File

@ -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;
};
}

23
packages/fes-plugin-pinia/src/index.js
View File

@ -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(
readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),
{
IMPORT_PLUGINS: store.importPlugins.join('\n'),
PLUGINS: store.plugins
}
)
content: Mustache.render(readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'), {
IMPORT_PLUGINS: store.importPlugins.join('\n'),
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}`);

1
packages/fes-template/package.json
View File

@ -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"