@modern-js/module-tools-docs 2.10.0 → 2.11.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @modern-js/module-tools-docs
 
+## 2.11.0
+
+### Minor Changes
+
+- f1b2629: feat: add `dts.abortOnError` config
+  feat: 添加 `dts.abortOnError` 配置
+
+### Patch Changes
+
+- 6118636: fix(module-tools, module-tools-docs): fix svgr usage
+  fix(module-tools, module-tools-docs): 修复 svgr 的使用
+- Updated dependencies [210e9d6]
+- Updated dependencies [95dd73e]
+  - @modern-js/doc-tools@2.11.0
+  - @modern-js/doc-plugin-auto-sidebar@2.11.0
+
 ## 2.10.0
 
 ### Patch Changes

package/docs/en/api/config/build-config.md

@@ -95,6 +95,34 @@ Packaged to handle svg as a React component, options reference [svgr](https://re
 - type: `boolean | Object`
 - default: `false`
 
+When svgr feature is enabled, you can use svg as a component using the default export.
+
+```js index.ts
+// true
+import Logo from './logo.svg';
+
+export default () => <Logo />;
+```
+
+:::warning
+The following usage is not currently supported:
+
+```js index.ts
+import { ReactComponent } from './logo.svg';
+```
+:::
+
+When enabled, the type of svg used can be modified by adding a type definition to the `modern-app-env.d.ts` file:
+
+``` ts modern-app-env.d.ts focus=1:3
+declare module '*.svg' {
+  const src: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+  export default src;
+}
+
+/// <reference types='@modern-js/module-tools/types' />
+```
+
 #### include
 
 Set the matching svg file
@@ -183,17 +211,30 @@ To prevent excessive global replacement substitution, it is recommended that the
 
 ## dts
 
-The dts file generates the relevant configuration, by default it generates
+The dts file generates the relevant configuration, by default it generates.
 
 - type: `false | Object`
-- default: `{}`
+- default:
 
-### tsconfigPath
+``` js
+{
+  abortOnError: true,
+  distPath: './',
+  only: false,
+  tsconfigPath: './tsconfig.json',
+}
+```
 
-Path to the tsconfig file
+### abortOnError
 
-- type: `string`
-- default: `. /tsconfig.json`
+Whether to allow the build to succeed in case of a type error. By default, this will cause the build to fail in case of a type error.
+
+:::warning
+When this configuration is turned on, there is no guarantee that the type files will be generated properly and accurately. In `buildType: 'bundle'` or Bundle build mode, the type file must not be generated.
+:::
+
+- type: `boolean`
+- default: `true`
 
 ### distPath
 
@@ -209,6 +250,13 @@ Generate only dts files, not js files
 - type: `boolean`
 - default: `false`
 
+### tsconfigPath
+
+Path to the tsconfig file
+
+- type: `string`
+- default: `. /tsconfig.json`
+
 ## externals
 
 Configure external dependencies that will not be packaged into the final bundle

package/docs/zh/api/config/build-config.md

@@ -98,34 +98,51 @@ export default defineConfig({
 
 ### svgr
 
-打包时将 svg 作为一个 React 组件处理，options 参考 [svgr](https://react-svgr.com/docs/options/)，另外还支持了 `include` 和 `exclude` 两个配置项，用于匹配需要处理的 svg 文件。
+打包时将 SVG 作为一个 React 组件处理，options 参考 [svgr](https://react-svgr.com/docs/options/)，另外还支持了 `include` 和 `exclude` 两个配置项，用于匹配需要处理的 SVG 文件。
 
 - 类型： `boolean | Object`
 - 默认值： `false`
 
-:::tip
-开启 svgr 后，仍然使用 default export 导出 svg，所以你只能导入默认值。
+开启 svgr 功能后，可以使用默认导出的方式将 SVG 当做组件使用。
 
 ```js index.ts
 // true
-import logo from './logo.svg';
+import Logo from './logo.svg';
+
+export default () => <Logo />;
+```
+
+:::warning
 
-// false
+目前不支持下面的用法：
+
+```js index.ts
 import { ReactComponent } from './logo.svg';
 ```
 
 :::
 
+当开启功能后，可以通过在 `modern-app-env.d.ts` 文件中增加类型定义，修改使用 SVG 的类型：
+
+``` ts modern-app-env.d.ts focus=1:3
+declare module '*.svg' {
+  const src: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+  export default src;
+}
+
+/// <reference types='@modern-js/module-tools/types' />
+```
+
 #### include
 
-设定匹配的 svg 文件
+设定匹配的 SVG 文件
 
 - 类型： `string | RegExp | (string | RegExp)[]`
 - 默认值： `/\.svg$/`
 
 #### exclude
 
-设定不匹配的 svg 文件
+设定不匹配的 SVG 文件
 
 - 类型： `string | RegExp | (string | RegExp)[]`
 - 默认值： `undefined`
@@ -236,17 +253,30 @@ export default defineConfig({
 
 ## dts
 
-类型文件生成的相关配置，默认会生成。
+类型文件生成的相关配置，默认情况会生成。
 
 - 类型： `false | Object`
-- 默认值： `{}`
+- 默认值：
 
-### tsconfigPath
+``` js
+{
+  abortOnError: true,
+  distPath: './',
+  only: false,
+  tsconfigPath: './tsconfig.json',
+}
+```
 
-TypeScript 配置文件的路径。
+### abortOnError
 
-- 类型： `string`
-- 默认值： `./tsconfig.json`
+在出现类型错误的时候，是否允许构建成功。**默认情况下，在出现类型错误的时候会导致构建失败**。
+
+:::warning
+当关闭该配置后，无法保证类型文件能正常生成，且不保证内容正确。在 `buildType: 'bundle'` 或者 Bundle 构建模式下，类型文件一定不会生成。
+:::
+
+- 类型：`boolean`
+- 默认值：`true`
 
 ### distPath
 
@@ -262,6 +292,14 @@ TypeScript 配置文件的路径。
 - 类型： `boolean`
 - 默认值： `false`
 
+### tsconfigPath
+
+TypeScript 配置文件的路径。
+
+- 类型： `string`
+- 默认值： `./tsconfig.json`
+
+
 ## externals
 
 配置外部依赖，不会被打包到最终的 bundle 中。

package/package.json

@@ -5,15 +5,15 @@
   "bugs": "https://github.com/web-infra-dev/modern.js/issues",
   "repository": "web-infra-dev/modern.js",
   "license": "MIT",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "main": "index.js",
   "dependencies": {
     "@code-hike/mdx": "^0.7.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "shiki": "^0.11.1",
-    "@modern-js/doc-plugin-auto-sidebar": "2.10.0",
-    "@modern-js/doc-tools": "2.10.0"
+    "@modern-js/doc-plugin-auto-sidebar": "2.11.0",
+    "@modern-js/doc-tools": "2.11.0"
   },
   "scripts": {
     "dev": "modern dev",