feat: 将createApp改名为setupApp (#66)

Tencent · Aug 16, 2022 · 8aa3218 · 8aa3218
1 parent a093062
commit 8aa3218
Show file tree

Hide file tree

Showing 15 changed files with 44 additions and 44 deletions.
diff --git a/examples/main-react/src/index.js b/examples/main-react/src/index.js
@@ -12,13 +12,13 @@ import credentialsFetch from "./fetch";
 import lifecycles from "./lifecycle";
 import plugins from "./plugin";
 
-const { createApp, preloadApp, bus } = WujieReact;
+const { setupApp, preloadApp, bus } = WujieReact;
 const isProduction = process.env.NODE_ENV === "production";
 bus.$on("click", (msg) => window.alert(msg));
 
 const degrade = window.localStorage.getItem("degrade") === "true" || !window.Proxy || !window.CustomElementRegistry;
 // 创建应用，主要是设置配置，preloadApp、startApp的配置基于这个配置做覆盖
-createApp({
+setupApp({
   name: "react16",
   url: hostMap("//localhost:7600/"),
   attrs: isProduction ? { src: hostMap("//localhost:7600/") } : {},
@@ -32,7 +32,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "react17",
   url: hostMap("//localhost:7100/"),
   attrs: isProduction ? { src: hostMap("//localhost:7100/") } : {},
@@ -44,7 +44,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vue2",
   url: hostMap("//localhost:7200/"),
   attrs: isProduction ? { src: hostMap("//localhost:7200/") } : {},
@@ -55,7 +55,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vue3",
   url: hostMap("//localhost:7300/"),
   attrs: isProduction ? { src: hostMap("//localhost:7300/") } : {},
@@ -70,7 +70,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "angular12",
   url: hostMap("//localhost:7400/"),
   attrs: isProduction ? { src: hostMap("//localhost:7400/") } : {},
@@ -81,7 +81,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vite",
   url: hostMap("//localhost:7500/"),
   attrs: isProduction ? { src: hostMap("//localhost:7500/") } : {},

diff --git a/examples/main-vue/src/main.js b/examples/main-vue/src/main.js
@@ -17,7 +17,7 @@ import lifecycles from "./lifecycle";
 import plugins from "./plugin";
 
 const isProduction = process.env.NODE_ENV === "production";
-const { createApp, preloadApp, bus } = WujieVue;
+const { setupApp, preloadApp, bus } = WujieVue;
 Vue.use(WujieVue).use(Switch).use(Tooltip).use(button).use(Icon);
 
 Vue.config.productionTip = false;
@@ -31,7 +31,7 @@ const props = {
   },
 };
 // 创建应用，主要是设置配置，preloadApp、startApp的配置基于这个配置做覆盖
-createApp({
+setupApp({
   name: "react16",
   url: hostMap("//localhost:7600/"),
   attrs: isProduction ? { src: hostMap("//localhost:7600/") } : {},
@@ -46,7 +46,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "react17",
   url: hostMap("//localhost:7100/"),
   attrs: isProduction ? { src: hostMap("//localhost:7100/") } : {},
@@ -59,7 +59,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vue2",
   url: hostMap("//localhost:7200/"),
   attrs: isProduction ? { src: hostMap("//localhost:7200/") } : {},
@@ -71,7 +71,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vue3",
   url: hostMap("//localhost:7300/"),
   attrs: isProduction ? { src: hostMap("//localhost:7300/") } : {},
@@ -87,7 +87,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "angular12",
   url: hostMap("//localhost:7400/"),
   attrs: isProduction ? { src: hostMap("//localhost:7400/") } : {},
@@ -99,7 +99,7 @@ createApp({
   ...lifecycles,
 });
 
-createApp({
+setupApp({
   name: "vite",
   url: hostMap("//localhost:7500/"),
   attrs: isProduction ? { src: hostMap("//localhost:7500/") } : {},

diff --git a/packages/wujie-core/src/index.ts b/packages/wujie-core/src/index.ts
@@ -151,7 +151,7 @@ if (!wujieSupport) warn(WUJIE_TIPS_NOT_SUPPORTED);
 /**
  * 缓存子应用配置
  */
-export function createApp(options: cacheOptions): void {
+export function setupApp(options: cacheOptions): void {
   if (options.name) addSandboxCacheWithOptions(options.name, options);
 }
 

diff --git a/packages/wujie-doc/docs/.vuepress/config.js b/packages/wujie-doc/docs/.vuepress/config.js
@@ -41,7 +41,7 @@ module.exports = {
           sidebarDepth: 2,
           children: [
             'bus.md',
-            'createApp.md',
+            'setupApp.md',
             'startApp.md',
             'preloadApp.md',
             'destroyApp.md'

diff --git a/packages/wujie-doc/docs/README.md b/packages/wujie-doc/docs/README.md
@@ -14,9 +14,9 @@ footer: Copyright © 2021-present yiludege
 ---
 
 ```javascript
-import { bus, createApp, preloadApp, startApp, destroyAPP } from "wujie";
+import { bus, setupApp, preloadApp, startApp, destroyAPP } from "wujie";
 
-createApp({ name: "唯一id", url: "子应用路径", exec: true, el: "容器", sync: true });
+setupApp({ name: "唯一id", url: "子应用路径", exec: true, el: "容器", sync: true });
 
 preloadApp({ name: "唯一id" });
 

diff --git a/packages/wujie-doc/docs/api/createApp.md → packages/wujie-doc/docs/api/setupApp.md b/packages/wujie-doc/docs/api/createApp.md → packages/wujie-doc/docs/api/setupApp.md
@@ -1,4 +1,4 @@
-# createApp
+# setupApp
 
 - **类型：** `Function`
 
@@ -51,5 +51,5 @@ type cacheOptions  {
 };
 ```
 
-- **详情：** `createApp`创建子应用，主要作用是设置子应用默认属性，[startApp](/api/startApp.html)、[preloadApp](/api/preloadApp.html) 会从这里获取子应用默认属性，如果有相同的属性则会直接覆盖
+- **详情：** `setupApp`设置子应用默认属性，[startApp](/api/startApp.html)、[preloadApp](/api/preloadApp.html) 会从这里获取子应用默认属性，如果有相同的属性则会直接覆盖
 
diff --git a/packages/wujie-doc/docs/guide/start.md b/packages/wujie-doc/docs/guide/start.md
@@ -8,7 +8,7 @@ collapsable: false
 ### 引入
 
 ```javascript
-import { bus, createApp, preloadApp, startApp, destroyApp } from "wujie";
+import { bus, setupApp, preloadApp, startApp, destroyApp } from "wujie";
 ```
 
 ::: tip 提示
@@ -18,7 +18,7 @@ import { bus, createApp, preloadApp, startApp, destroyApp } from "wujie";
 ### 创建主应用
 
 ```javascript
-createApp({{ name: "唯一id", url: "子应用地址", exec: true, el: "容器", sync: true }})
+setupApp({{ name: "唯一id", url: "子应用地址", exec: true, el: "容器", sync: true }})
 ```
 
 ### 预加载

diff --git a/packages/wujie-doc/docs/pack/README.md b/packages/wujie-doc/docs/pack/README.md
@@ -23,7 +23,7 @@ import WujieVue from "wujie-vue2";
 // vue3
 import WujieVue from "wujie-vue3";
 
-const { bus, createApp, preloadApp, destroyApp } = WujieVue;
+const { bus, setupApp, preloadApp, destroyApp } = WujieVue;
 
 Vue.use(WujieVue);
 ```
@@ -53,9 +53,9 @@ Vue.use(WujieVue);
 
 [同 API](/api/bus.html)
 
-### createApp
+### setupApp
 
-[同 API](/api/createApp.html)
+[同 API](/api/setupApp.html)
 
 ### preloadApp
 
@@ -69,7 +69,7 @@ Vue.use(WujieVue);
 
 ```javascript
 import Vue from "vue";
-import { bus, preloadApp, startApp, destroyApp } from "wujie";
+import { bus, setupApp, preloadApp, startApp, destroyApp } from "wujie";
 import { createApp, h, defineComponent } from "vue";
 const vue3Flag = !!createApp;
 
@@ -164,7 +164,7 @@ const wujieVueOptions = {
 
 const WujieVue = vue3Flag ? defineComponent(wujieVueOptions) : Vue.extend(wujieVueOptions);
 
-WujieVue.createApp = createApp;
+WujieVue.setupApp = setupApp;
 WujieVue.preloadApp = preloadApp;
 WujieVue.bus = bus;
 WujieVue.destroyApp = destroyApp;

diff --git a/packages/wujie-doc/docs/pack/react.md b/packages/wujie-doc/docs/pack/react.md
@@ -16,7 +16,7 @@ npm i wujie-react -S
 ```javascript
 import WujieReact from "wujie-react";
 
-const { bus, createApp, preloadApp, destroyApp } = WujieReact;
+const { bus, setupApp, preloadApp, destroyApp } = WujieReact;
 ```
 
 ## 使用
@@ -42,9 +42,9 @@ const { bus, createApp, preloadApp, destroyApp } = WujieReact;
 
 [同 API](/api/bus.html)
 
-### createApp
+### setupApp
 
-[同 API](/api/createApp.html)
+[同 API](/api/setupApp.html)
 
 ### preloadApp
 
@@ -59,7 +59,7 @@ const { bus, createApp, preloadApp, destroyApp } = WujieReact;
 ```javascript
 import React from "react";
 import PropTypes from "prop-types";
-import { bus, preloadApp, startApp, destroyApp } from "wujie";
+import { bus, setupApp ,preloadApp, startApp, destroyApp } from "wujie";
 
 export default class WujieReact extends React.PureComponent {
   static propTypes = {
@@ -86,7 +86,7 @@ export default class WujieReact extends React.PureComponent {
     loadError: PropTypes.func,
   };
   static bus = bus;
-  static createApp = createApp;
+  static setupApp = setupApp;
   static preloadApp = preloadApp;
   static destroyApp = destroyApp;
 

diff --git a/packages/wujie-react/index.d.ts b/packages/wujie-react/index.d.ts
@@ -1,4 +1,4 @@
-import { bus, preloadApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, destroyApp, setupApp } from "wujie";
 import PropTypes from "prop-types";
 import React from "react";
 
@@ -27,7 +27,7 @@ export default class WujieReact extends React.PureComponent {
     loadError: typeof PropTypes.func,
   };
   static bus: typeof bus;
-  static createApp: typeof createApp;
+  static setupApp: typeof setupApp;
   static preloadApp: typeof preloadApp;
   static destroyApp: typeof destroyApp;
 }
diff --git a/packages/wujie-react/index.js b/packages/wujie-react/index.js
@@ -1,6 +1,6 @@
 import React from "react";
 import PropTypes from "prop-types";
-import { bus, preloadApp, startApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, startApp, destroyApp, setupApp } from "wujie";
 
 export default class WujieReact extends React.PureComponent {
   static propTypes = {
@@ -28,7 +28,7 @@ export default class WujieReact extends React.PureComponent {
     loadError: PropTypes.func,
   };
   static bus = bus;
-  static createApp = createApp;
+  static setupApp = setupApp;
   static preloadApp = preloadApp;
   static destroyApp = destroyApp;
 

diff --git a/packages/wujie-vue2/index.d.ts b/packages/wujie-vue2/index.d.ts
@@ -1,9 +1,9 @@
 import Vue from "vue";
-import { bus, preloadApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, destroyApp, setupApp } from "wujie";
 
 declare const WujieVue: {
   bus: typeof bus;
-  createApp: typeof createApp;
+  setupApp: typeof setupApp;
   preloadApp: typeof preloadApp;
   destroyApp: typeof destroyApp;
   install: (Vue: Vue) => void;

diff --git a/packages/wujie-vue2/index.js b/packages/wujie-vue2/index.js
@@ -1,5 +1,5 @@
 import Vue from "vue";
-import { bus, preloadApp, startApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, startApp, destroyApp, setupApp } from "wujie";
 
 const wujieVueOptions = {
   name: "WujieVue",
@@ -93,7 +93,7 @@ const wujieVueOptions = {
 
 const WujieVue = Vue.extend(wujieVueOptions);
 
-WujieVue.createApp = createApp;
+WujieVue.setupApp = setupApp;
 WujieVue.preloadApp = preloadApp;
 WujieVue.bus = bus;
 WujieVue.destroyApp = destroyApp;

diff --git a/packages/wujie-vue3/index.d.ts b/packages/wujie-vue3/index.d.ts
@@ -1,9 +1,9 @@
-import { bus, preloadApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, destroyApp, setupApp } from "wujie";
 import { App } from "vue";
 
 declare const WujieVue: {
   bus: typeof bus;
-  createApp: typeof createApp;
+  setupApp: typeof setupApp;
   preloadApp: typeof preloadApp;
   destroyApp: typeof destroyApp;
   install: (app: App) => any;

diff --git a/packages/wujie-vue3/index.js b/packages/wujie-vue3/index.js
@@ -1,4 +1,4 @@
-import { bus, preloadApp, startApp, destroyApp, createApp } from "wujie";
+import { bus, preloadApp, startApp, destroyApp, setupApp } from "wujie";
 import { h, defineComponent } from "vue";
 
 const wujieVueOptions = {
@@ -93,7 +93,7 @@ const wujieVueOptions = {
 
 const WujieVue = defineComponent(wujieVueOptions);
 
-WujieVue.createApp = createApp;
+WujieVue.setupApp = setupApp;
 WujieVue.preloadApp = preloadApp;
 WujieVue.bus = bus;
 WujieVue.destroyApp = destroyApp;