feat: new plugin api, api.modifyDepInfo (#5207)

umijs · Aug 12, 2020 · 1e57afc · 1e57afc
1 parent bae9097
commit 1e57afc
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 19 deletions.
diff --git a/docs/plugins/api.md b/docs/plugins/api.md
@@ -642,6 +642,20 @@ api.modifyDefaultConfig((memo) => {
 });
 ```
 
+### modifyDepInfo
+
+添加依赖信息，包括 semver range 和别名信息。
+
+```js
+api.modifyDepInfo((memo) => {
+  memo['foo'] = {
+    range: pkg.dependencies.foo,
+    alias: [pathToFooPackage],
+  };
+  return memo;
+});
+```
+
 ### modifyHTML
 
 修改 HTML，基于 [cheerio](https://github.com/cheeriojs/cheerio) 的 ast。

diff --git a/docs/plugins/api.zh-CN.md b/docs/plugins/api.zh-CN.md
@@ -643,6 +643,20 @@ api.modifyDefaultConfig((memo) => {
 });
 ```
 
+### modifyDepInfo
+
+添加依赖信息，包括 semver range 和别名信息。
+
+```js
+api.modifyDepInfo((memo) => {
+  memo['foo'] = {
+    range: pkg.dependencies.foo,
+    alias: [pathToFooPackage],
+  };
+  return memo;
+});
+```
+
 ### modifyHTML
 
 修改 HTML，基于 [cheerio](https://github.com/cheeriojs/cheerio) 的 ast。

diff --git a/packages/preset-built-in/src/plugins/generateFiles/constants.ts b/packages/preset-built-in/src/plugins/generateFiles/constants.ts
@@ -0,0 +1,9 @@
+import { winPath } from '@umijs/utils';
+import { dirname } from 'path';
+
+export const runtimePath = winPath(
+  dirname(require.resolve('@umijs/runtime/package.json')),
+);
+export const renderReactPath = winPath(
+  require.resolve('@umijs/renderer-react'),
+);
diff --git a/packages/preset-built-in/src/plugins/generateFiles/core/history.ts b/packages/preset-built-in/src/plugins/generateFiles/core/history.ts
@@ -1,7 +1,7 @@
 import { readFileSync } from 'fs';
-import { dirname, join } from 'path';
+import { join } from 'path';
 import { IApi } from '@umijs/types';
-import { winPath } from '@umijs/utils';
+import { runtimePath } from '../constants';
 
 export default function (api: IApi) {
   const {
@@ -53,9 +53,7 @@ export default function (api: IApi) {
           null,
           2,
         ),
-        runtimePath: winPath(
-          dirname(require.resolve('@umijs/runtime/package.json')),
-        ),
+        runtimePath,
       }),
     });
   });

diff --git a/packages/preset-built-in/src/plugins/generateFiles/core/plugin.ts b/packages/preset-built-in/src/plugins/generateFiles/core/plugin.ts
@@ -1,7 +1,8 @@
 import { readFileSync } from 'fs';
-import { join, dirname } from 'path';
+import { join } from 'path';
 import { IApi } from '@umijs/types';
 import { getFile, winPath } from '@umijs/utils';
+import { runtimePath } from '../constants';
 
 export default function (api: IApi) {
   const {
@@ -38,9 +39,7 @@ export default function (api: IApi) {
         readFileSync(join(__dirname, 'plugin.tpl'), 'utf-8'),
         {
           validKeys,
-          runtimePath: winPath(
-            dirname(require.resolve('@umijs/runtime/package.json')),
-          ),
+          runtimePath,
         },
       ),
     });

diff --git a/packages/preset-built-in/src/plugins/generateFiles/core/routes.ts b/packages/preset-built-in/src/plugins/generateFiles/core/routes.ts
@@ -1,8 +1,8 @@
 import { readFileSync } from 'fs';
-import { dirname, join } from 'path';
-import { IApi, IConfig } from '@umijs/types';
+import { join } from 'path';
+import { IApi } from '@umijs/types';
 import { Route } from '@umijs/core';
-import { winPath } from '@umijs/utils';
+import { runtimePath } from '../constants';
 
 export default function (api: IApi) {
   const {
@@ -17,9 +17,7 @@ export default function (api: IApi) {
       path: 'core/routes.ts',
       content: Mustache.render(routesTpl, {
         routes: new Route().getJSON({ routes, config: api.config, cwd }),
-        runtimePath: winPath(
-          dirname(require.resolve('@umijs/runtime/package.json')),
-        ),
+        runtimePath,
         config: api.config,
       }),
     });

diff --git a/packages/preset-built-in/src/plugins/generateFiles/umi.ts b/packages/preset-built-in/src/plugins/generateFiles/umi.ts
@@ -2,6 +2,7 @@ import { readFileSync } from 'fs';
 import { join, dirname } from 'path';
 import { IApi } from '@umijs/types';
 import { winPath } from '@umijs/utils';
+import { runtimePath, renderReactPath } from './constants';
 
 export function importsToStr(
   imports: { source: string; specifier?: string }[],
@@ -21,12 +22,24 @@ export default function (api: IApi) {
     utils: { Mustache },
   } = api;
 
+  api.modifyDepInfo((memo) => {
+    memo['@umijs/runtime'] = {
+      range: '3',
+      alias: [runtimePath],
+    };
+    memo['@umijs/renderer-react'] = {
+      range: '3',
+      alias: [renderReactPath],
+    };
+    return memo;
+  });
+
   api.onGenerateFiles(async (args) => {
     const umiTpl = readFileSync(join(__dirname, 'umi.tpl'), 'utf-8');
     const rendererPath = await api.applyPlugins({
       key: 'modifyRendererPath',
       type: api.ApplyPluginsType.modify,
-      initialValue: require.resolve('@umijs/renderer-react'),
+      initialValue: renderReactPath,
     });
     api.writeTmpFile({
       path: 'umi.ts',
@@ -35,9 +48,7 @@ export default function (api: IApi) {
         enableTitle: api.config.title !== false,
         defaultTitle: api.config.title || '',
         rendererPath: winPath(rendererPath),
-        runtimePath: winPath(
-          dirname(require.resolve('@umijs/runtime/package.json')),
-        ),
+        runtimePath,
         rootElement: api.config.mountElementId,
         enableSSR: !!api.config.ssr,
         dynamicImport: !!api.config.dynamicImport,

diff --git a/packages/preset-built-in/src/plugins/registerMethods.ts b/packages/preset-built-in/src/plugins/registerMethods.ts
@@ -42,6 +42,7 @@ export default function (api: IApi) {
     'modifyBabelOpts',
     'modifyBabelPresetOpts',
     'modifyBundleImplementor',
+    'modifyDepInfo',
     'modifyHTMLChunks',
     'modifyDevHTMLContent',
     'modifyExportRouteMap',

diff --git a/packages/types/index.d.ts b/packages/types/index.d.ts
@@ -191,6 +191,7 @@ export interface IApi extends PluginAPI {
     }
   >;
   modifyBundleImplementor: IModify<any, {}>;
+  modifyDepInfo: IModify<any, {}>;
   modifyConfig: IModify<IConfig, {}>;
   modifyDefaultConfig: IModify<IConfig, {}>;
   modifyHTML: IModify<CheerioStatic, { route: IRoute }>;