Clear and concise description of the problem

目前garfish文档内容较少，而且部署部分几乎空白，所以大佬们可以出一份部署相关的文档供学习嘛？蟹蟹

Suggested solution

Alternative

No response

Additional context

No response

Validations

• [x] Read the Contributing Guidelines.
• [x] Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

Describe the bug

// main.ts
import { vueBridge } from '@garfish/bridge'
import { createPinia } from 'pinia'
import { createApp, h } from 'vue'

import App from './App'
import { newRouter } from './router'

const pinia = createPinia()

export const provider = vueBridge({
  createApp,
  rootComponent: App,
  appOptions: () => {
    return {
      el: '#app',
      render: () => h(App)
    }
  },
  handleInstance: (vueInstance, { basename }) => {
    vueInstance.use(newRouter(basename))
    vueInstance.use(pinia)
  }
})

if (!window.__GARFISH__) {
  const app = createApp(App)
  const router = newRouter('/')

  app.use(router)
  app.use(pinia)
  app.mount('#app')
}

Reproduction

https://gitee.com/jh_shot/micro-template

Used Package Manager

pnpm

System Info

System:
    OS: Windows 10 10.0.22000
    CPU: (12) x64 Intel(R) Core(TM) i5-10400 CPU @ 2.90GHz
    Memory: 5.39 GB / 15.84 GB
  Binaries:
    Node: 16.14.2 - C:\Program Files\nodejs\node.EXE
    Yarn: 1.22.18 - ~\AppData\Roaming\npm\yarn.CMD
    npm: 8.5.0 - C:\Program Files\nodejs\npm.CMD
  Browsers:
    Edge: Spartan (44.22000.120.0), Chromium (101.0.1210.53)
    Internet Explorer: 11.0.22000.120

Validations

• [X] Read the docs.
• [X] Read the common issues list.
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• [X] Make sure this is a Garfish issue and not a framework-specific issue.
• [X] The provided reproduction is a minimal reproducible example of the bug.

Description

• API 增加 routerChange 的使用说明
• 针对 hook 全局唯一补充相应的使用提醒

Related Issue

None

Motivation and Context

None

How Has This Been Tested

None

Types of changes

• [x] Docs change / refactoring / dependency upgrade
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [ ] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [ ] All new and existing tests passed.

Description

fix dependencies problem when run build

Related Issue

https://github.com/modern-js-dev/garfish/issues/515

Motivation and Context

I just wanna learn it.

How Has This Been Tested

Yep, when i modify it, every thing is correct

Types of changes

• [x] Docs change / refactoring / dependency upgrade
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document. Yes and btw, CONTRIBUTING.md write node version is >= 16.10 but package.json wanna >=16.14.0
• [ ] I have added tests to cover my changes.
• [ ] All new and existing tests passed.

PR Details

• [x] 支持无url()的@import语句
• [x] 移除@charset语句
• [x] 更新了匹配url()的正则

Description

1. 将无url()的@import语句转换为有url()，以供后续统一处理；
2. @charset在<style>无意义，直接移除；
3. url()可匹配带文件名带括号的资源

Related Issue

https://github.com/modern-js-dev/garfish/issues/446

Motivation and Context

1. 支持了无url()的@import语句，兼容性更好
2. 顺带移除了可能出现的@charset语句，减少控制台warning
3. 优化了url()匹配模式，能兼容更多合理的资源名

How Has This Been Tested

repo中无相关test case，可手动在 https://github.com/yanni4night/garfish-issue-reproduction/tree/issue-446 验证。

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [x] All new and existing tests passed.

PR Details

garfish new examples

Description

Related Issue

Motivation and Context

How Has This Been Tested

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [ ] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [ ] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [ ] All new and existing tests passed.

问题

目前 garfish 和 remote-module 的 externals 配置，均需要先引入依赖再设置，使得主应用难以做懒加载

目前的写法：

setExtenals({
    react: require('react'),
});

期望的使用方式

支持懒加载

setExtenals({
    react: () => import('react'),
    // 或者
    react: () => require('react'),
});

可能的解决方式

子应用使用 amd 格式，使用自定义的 define 函数执行

以下为示例，可能没有正确实现 amd loader 格式

const exec = (code: string) =>
    new Promise((resolve) => {
        async function define(depNames: string[], factor: () => any) {
            const deps = await Promise.all(depNames.map((depName) => externals[depName]()));
            resolve(factor(...deps));
        }
        const func = new Function('define', code);
        func(define);
    });

问题

目前 garfish 使用的是 commonjs 格式，需要想办法兼容

Description

fakeFetch函数中并没有对 input 的类型做判断 导致fetch请求失败。addSourceList方法中url参数需要是string类型

Related Issue

Motivation and Context

How Has This Been Tested

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [ ] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [ ] All new and existing tests passed.

Description

fix: link style render by order

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [x] I have added tests to cover my changes.
• [x] All new and existing tests passed.

Description

• Found the url of quick start is wrong in readme of Chinese version.

Related Issue

#533

Motivation and Context

• Fix url

How Has This Been Tested

Add tests to ensure that user can be redirected to correct address

Types of changes

• [x] Docs change / refactoring / dependency upgrade
• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [x] All new and existing tests passed.

Motivation and Context

There has type error where had import @garfish/bridge-*, such as where dev/app-react-18/src/root.tsx:L6

What had I do

Bridge had define Props Info for an app info, but it will be meaningful which renamed be AppInfo than it, so I did to redefine to AppInfo

How Has This Been Tested

Reinstall and reopen dev/app-react-18/src/root.tsx:L6

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [x] All new and existing tests passed.

fix(loader): fix the loader return the same loader when multi apps mount at the same time

Description

When multiple applications with the same entry are mounted at the same time, garfish will collect the dom created by the previous application as a side effect into the side effect category of the last sub-application. When the last sub application is unmount, it will cause all applications to be uninstalled.

This is because the loader of garfish will cache the loader instance for the same entry url, and return the previous loader instance when the entry is the same. In this way, when multiple sub applications are mounted at the same time, if these applications have the same entry, they will point to the same loader instance. In the vm sandbox, the document object of the loader will be rewritten to the document object of the sandbox. All loaders will also point to the sandbox document object of the last mounted application. Then the dom created by these applications will be collected as a side effect of the last application, causing some errors to occur.

Related Issue

Motivation and Context

How Has This Been Tested

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [x] I have added tests to cover my changes.
• [x] All new and existing tests passed.

Describe the bug

子应用使用了monaco editor,打包部署后可以正常工作,但从主应用启动时,web worker无法正常启动,报错如下:

Reproduction

none

Used Package Manager

npm

System Info

none

Validations

• [X] Read the docs.
• [X] Read the common issues list.
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• [X] Make sure this is a Garfish issue and not a framework-specific issue.
• [X] The provided reproduction is a minimal reproducible example of the bug.

Description

fix addSourceList can not support URL object type fetch request. for more detail info please check the issue #588

Related Issue

https://github.com/modern-js-dev/garfish/issues/588

Motivation and Context

How Has This Been Tested

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [x] I have added tests to cover my changes.
• [x] All new and existing tests passed.

Describe the bug

问题

在子平台编写这样的代码时会遇到错误：

fetch(new URL(window.location.href));

定位

我看了 addSourceList 实现的代码，其中并没有处理 URL 类型 https://github.com/modern-js-dev/garfish/blob/v1.13.1/packages/core/src/module/app.ts#L170

fetch标准

查看一些文档，看到 fetch 是可以是可以这样使用 URL 类型的，是被记录的标准用法 https://developer.mozilla.org/en-US/docs/Web/API/fetch https://developer.mozilla.org/en-US/docs/Web/API/URL

The toString() method of URL just returns the value of the href property, so the constructor can be used to normalize and encode a URL directly.

const response = await fetch(new URL('http://www.example.com/démonstration.html'));

同时，在大部分浏览器中测试也是可以通过的。比如在浏览器控制台中直接输入fetch(new URL(window.location.href))

Reproduction

none

Used Package Manager

npm

System Info

none

Validations

• [X] Read the docs.
• [X] Read the common issues list.
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• [X] Make sure this is a Garfish issue and not a framework-specific issue.
• [X] The provided reproduction is a minimal reproducible example of the bug.

Description

fix bugs:

• SVG camel tag is not support: add SVG judge for template parse
• SVG setAttribute xmlns:xlink failed: make sure the prefix is xlink, only xlink:XXX attribute need xlink namespace.

Related Issue

• SVG camel tag is not support https://github.com/modern-js-dev/garfish/issues/585
• SVG setAttribute xmlns:xlink failed https://github.com/modern-js-dev/garfish/issues/584

Motivation and Context

garfish render SVG in template error.

How Has This Been Tested

• SVG camel tag is not support: test SVG feFlood tag and DIV, make sure toLowercase is enable for normal tag.
• SVG setAttribute xmlns:xlink: test xmlns:xlink and xlink:href, make sure only xlink:href is set with xlink namespace.

Types of changes

• [ ] Docs change / refactoring / dependency upgrade
• [x] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document.
• [x] I have added tests to cover my changes.
• [x] All new and existing tests passed.