@modern-js/main-doc 2.42.0 → 2.42.2

package/docs/en/guides/basic-features/output-files.mdx

@@ -0,0 +1,173 @@
+---
+sidebar_position: 10
+---
+
+# Output Files
+
+This chapter will introduces the directory structure of output files and how to control the output directory of different types of files.
+
+## Default Directory Structure
+
+The following is a basic directory for output files. By default, the compiled files will be output in the `dist` directory of current project.
+
+```bash
+dist
+├── static
+│   ├── css
+│   │   ├── [name].[hash].css
+│   │   └── [name].[hash].css.map
+│   │
+│   └── js
+│       ├── [name].[hash].js
+│       ├── [name].[hash].js.LICENSE.txt
+│       └── [name].[hash].js.map
+│
+└── html
+    └── [name]
+        └── index.html
+```
+
+The most common output files are HTML files, JS files, and CSS files:
+
+- HTML files: default output to the `html` directory.
+- JS files: default output to `static/js` directory,
+- CSS files: default output to the `static/css` directory.
+
+In addition, JS files and CSS files sometimes generate some related files:
+
+- License files: contains open source license, which is output to the same level directory of the JS file, and adds `.LICENSE.txt` suffix.
+- Source Map files: contains the source code mappings, which is output to the same level directory of JS files and CSS files, and adds a `.map` suffix.
+
+In the filename, `[name]` represents the entry name corresponding to this file, such as `index`, `main`. `[hash]` is the hash value generated based on the content of the file.
+
+## Modify the Directory
+
+Builder provides some configs to modify the directory or filename, you can:
+
+- Modify the filename through [output.filename](/configure/app/output/filename).
+- Modify the output path of through [output.distPath](/configure/app/output/dist-path).
+- Modify the license file through [output.legalComments](/configure/app/output/legal-comments).
+- Remove Source Map file through [output.disableSourceMap](/configure/app/output/disable-source-map).
+- Remove the folder corresponding to the HTML files through [html.disableHtmlFolder](/configure/app/html/disable-html-folder).
+
+## Static Assets
+
+When you import static assets such as images, SVG, fonts, media, etc. in the code, they will also be output to the `dist/static` directory, and automatically assigned to the corresponding subdirectories according to the file type:
+
+```bash
+dist
+└── static
+    ├── image
+    │   └── foo.[hash].png
+    │
+    ├── svg
+    │   └── bar.[hash].svg
+    │
+    ├── font
+    │   └── baz.[hash].woff2
+    │
+    └── media
+        └── qux.[hash].mp4
+```
+
+You can use the [output.distPath](/configure/app/output/dist-path) config to uniformly input these static assets into a directory, for example, output to the `assets` directory:
+
+```ts
+export default {
+  output: {
+    distPath: {
+      image: 'assets',
+      svg: 'assets',
+      font: 'assets',
+      media: 'assets',
+    },
+  },
+};
+```
+
+The above config produces the following directory structure:
+
+```bash
+dist
+└── assets
+    ├── foo.[hash].png
+    ├── bar.[hash].svg
+    ├── baz.[hash].woff2
+    └── qux.[hash].mp4
+```
+
+## Node.js Output Directory
+
+When you enable SSR or SSG features in Modern.js, Modern.js will generate a Node.js bundle after the build and output it to the `bundles` directory.
+
+```bash
+dist
+├── bundles
+│   └── [name].js
+├── static
+└── html
+```
+
+Node.js files usually only contain JS files, no HTML or CSS. Also, JS file names will not contain hash.
+
+You can modify the output path of Node.js files through the [output.distPath.server](/configure/app/output/dist-path) config.
+
+For example, output Node.js files to the `server` directory:
+
+```ts
+export default {
+  output: {
+    distPath: {
+      server: 'server',
+    },
+  },
+};
+```
+
+## Flatten the Directory
+
+Sometimes you don't want the dist directory to have too many levels, you can set the directory to an empty string to flatten the generated directory.
+
+See the example below:
+
+```ts
+export default {
+  output: {
+    distPath: {
+      js: '',
+      css: '',
+      html: '',
+    },
+  },
+  html: {
+    disableHtmlFolder: true,
+  }
+};
+```
+
+The above config produces the following directory structure:
+
+```bash
+dist
+├── [name].[hash].css
+├── [name].[hash].css.map
+├── [name].[hash].js
+├── [name].[hash].js.map
+└── [name].html
+```
+
+## Not Written to Disk
+
+By default, Modern.js will write the generated files to disk, so developers can view the file content or configure proxy rules for static assets.
+
+In development, you can choose to keep the generated files in the Dev Server's memory to reduce the overhead of file operations.
+
+Just set the `dev.writeToDisk` config to `false`:
+
+```ts
+export default {
+  dev: {
+    writeToDisk: false,
+  },
+};
+```

package/docs/en/guides/basic-features/static-assets.mdx

@@ -0,0 +1,165 @@
+---
+sidebar_position: 10
+---
+
+# Import Static Assets
+
+Modern.js supports import static assets, including images, fonts, and medias.
+
+:::tip What is Static Assets
+Static assets are files that are part of a web application and do not change, even when the application is being used. Examples of static assets include images, fonts, medias, stylesheets, and JavaScript files. These assets are typically stored on a web server or CDN, and delivered to the user's web browser when the Web application is accessed. Because they do not change, static assets can be cached by the browser, which helps to improve the performance of the Web application.
+:::
+
+## Assets Format
+
+The following are the formats supported by Modern.js by default:
+
+- **Image**: png, jpg, jpeg, gif, svg, bmp, webp, ico, apng, avif, tiff.
+- **Fonts**: woff, woff2, eot, ttf, otf, ttc.
+- **Media**: mp4, webm, ogg, mp3, wav, flac, aac, mov.
+
+If you need to import assets in other formats, please refer to [Extend Asset Types](#extend-asset-types).
+
+:::tip SVG images
+SVG image is a special case. Modern.js support convert SVG to React components, so SVG is processed separately. For details, see [Import SVG Assets](/guides/basic-features/svg-assets.html).
+:::
+
+## Import Assets in JS file
+
+In JS files, you can directly import static assets in relative paths:
+
+```tsx
+// Import the logo.png image in the static directory
+import logo from './static/logo.png';
+
+export default = () => <img src={logo} />;
+```
+
+Import with [alias](/guides/basic-features/alias.html) are also supported:
+
+```tsx
+import logo from '@/static/logo.png';
+
+export default = () => <img src={logo} />;
+```
+
+## Import Assets in CSS file
+
+In CSS files, you can reference static assets in relative paths:
+
+```css
+.logo {
+  background-image: url('../static/logo.png');
+}
+```
+
+Import with [alias](/guides/basic-features/alias.html) are also supported:
+
+```css
+.logo {
+  background-image: url('@/static/logo.png');
+}
+```
+
+## Import Results
+
+The result of importing static assets depends on the file size:
+
+- When the file size is greater than 10KB, a URL will be returned, and the file will be output to the dist directory.
+- When the file size is less than 10KB, it will be automatically inlined to Base64 format.
+
+```js
+import largeImage from './static/largeImage.png';
+import smallImage from './static/smallImage.png';
+
+console.log(largeImage); // "/static/largeImage.6c12aba3.png"
+console.log(smallImage); // "data:image/png;base64,iVBORw0KGgo..."
+```
+
+For a more detailed introduction to asset inlining, please refer to the [Static Asset Inlining](/guides/advanced-features/inline-assets) chapter.
+
+## Output Files
+
+When static assets are imported, they will be output to the dist directory. You can:
+
+- Modify the output filename through [output.filename](/configure/app/output/filename).
+- Modify the output path through [output.distPath](/configure/app/output/dist-path).
+
+Please read [Output Files](/guides/basic-features/output-files) for details.
+
+## URL Prefix
+
+The URL returned after importing a asset will automatically include the path prefix:
+
+- In development, using [dev.assetPrefix](/configure/app/dev/asset-prefix) to set the path prefix.
+- In production, using [output.assetPrefix](/configure/app/output/asset-prefix) to set the path prefix.
+
+For example, you can set `output.assetPrefix` to `https://modern.com`:
+
+```js
+import logo from './static/logo.png';
+
+console.log(logo); // "https://modern.com/static/logo.6c12aba3.png"
+```
+
+## Add Type Declaration
+
+When you import static assets in TypeScript code, TypeScript may prompt that the module is missing a type definition:
+
+```
+TS2307: Cannot find module './logo.png' or its corresponding type declarations.
+```
+
+To fix this, you need to add a type declaration file for the static assets, please create a `src/global.d.ts` file, and add the corresponding type declaration. Taking png images as an example, you need to add the following declarations:
+
+```ts title="src/global.d.ts"
+declare module '*.png' {
+  const content: string;
+  export default content;
+}
+```
+
+After adding the type declaration, if the type error still exists, you can try to restart the current IDE, or adjust the directory where `global.d.ts` is located, making sure the TypeScript can correctly identify the type definition.
+
+## Extend Asset Types
+
+If the built-in asset types in Modern.js cannot meet your requirements, you can modify the built-in webpack/Rspack configuration and extend the asset types you need using [tools.bundlerChain](/configure/app/tools/bundler-chain).
+
+For example, if you want to treat `*.pdf` files as assets and directly output them to the dist directory, you can add the following configuration:
+
+```ts
+export default {
+  tools: {
+    bundlerChain(chain) {
+      chain.module
+        .rule('pdf')
+        .test(/\.pdf$/)
+        .type('asset/resource');
+    },
+  },
+};
+```
+
+After adding the above configuration, you can import `*.pdf` files in your code, for example:
+
+```js
+import myFile from './static/myFile.pdf';
+
+console.log(myFile); // "/static/myFile.6c12aba3.pdf"
+```
+
+For more information about asset modules, please refer to:
+
+- [Rspack Documentation - Asset modules](https://www.rspack.dev/guide/asset-module.html#asset-modules)
+- [webpack Documentation - Asset modules](https://webpack.js.org/guides/asset-modules/)
+
+## Image Format
+
+When using image assets, you can choose a appropriate image format according to the pros and cons in the table below.
+
+| Format | Pros                                                                                                      | Cons                                                                                | Scenarios                                                                                                                                              |
+| ------ | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| PNG    | Lossless compression, no loss of picture details, no distortion, support for translucency                 | Not suitable for pictures with complex color tables                                 | Suitable for pictures with few colors and well-defined borders, suitable for logos, icons, transparent images and other scenes                         |
+| JPG    | Rich colors                                                                                               | Lossy compression, which will cause image distortion, does not support transparency | Suitable for pictures with a large number of colors, gradients, and overly complex pictures, suitable for portrait photos, landscapes and other scenes |
+| WebP   | Supports both lossy and lossless compression, supports transparency, and is much smaller than PNG and JPG | iOS compatibility is not good                                                       | Pixel images of almost any scene, and the hosting environment that supports WebP, should prefer WebP image format                                      |
+| SVG    | Lossless format, no distortion, supports transparency                                                     | Not suitable for complex graphics                                                   | Suitable for vector graphics, suitable for icons                                                                                                       |

package/docs/en/guides/basic-features/svg-assets.mdx

@@ -0,0 +1,155 @@
+---
+sidebar_position: 11
+---
+
+# Import SVG Assets
+
+Modern.js supports import SVG assets and transform SVG into React components or URLs.
+
+:::tip What is SVG
+SVG stands for Scalable Vector Graphics. It is a type of image format that uses vector graphics to represent images. Vector graphics are different from raster graphics, which are made up of pixels. Instead, vector graphics use geometric shapes, lines, and curves to represent images. Because vector graphics are not made up of pixels, they can be scaled to any size without losing resolution or quality.
+:::
+
+## Import SVG in JS file
+
+When import an SVG in a JS file, if you import `ReactComponent`, Modern.js will call [SVGR](https://react-svgr.com/) to convert the SVG into a React component.
+
+```tsx title="src/component/Logo.tsx"
+import { ReactComponent as Logo } from './static/logo.svg';
+
+export default () => <Logo />;
+```
+
+If you use the default import, then the SVG will be treated as a normal static asset and you will get a URL:
+
+```tsx title="src/component/Logo.tsx"
+import logoURL from './static/logo.svg';
+
+console.log(logoURL); // => "/static/logo.6c12aba3.png"
+```
+
+## Modify the Default Export
+
+You can modify the default export of SVG files through the [output.svgDefaultExport](/configure/app/output/svg-default-export) config. For example, set the default export as a React component:
+
+```ts
+export default {
+  output: {
+    svgDefaultExport: 'component',
+  },
+};
+```
+
+Then import the SVG, you'll get a React component instead of a URL:
+
+```tsx title="src/component/Logo.tsx"
+import Logo from './static/logo.svg';
+
+export default () => <Logo />;
+```
+
+## Import SVG in CSS file
+
+When import an SVG in a CSS file, the SVG is treated as a normal static asset and you will get a URL:
+
+```css
+.logo {
+  background-image: url('../static/logo.svg');
+}
+```
+
+## Assets Processing
+
+When SVG is imported not as a React component but as a normal static asset, it is processed exactly the same as other static assets, and it is also affected by rules such as assets inlining and URL prefixing.
+
+Please read the [Import Static Assets](/guides/basic-features/static-assets) section to understand the processing rules for static assets.
+
+## Disable SVGR Processing
+
+By default, when an SVG resource is referenced in a JS file, Modern.js will call SVGR to convert the SVG into a React component. If you are sure that all SVG resources in your project are not being used as React components, you can turn off this conversion by setting [disableSvgr](/configure/app/output/disable-svgr) to true to improve build performance.
+
+```js
+export default {
+  output: {
+    disableSvgr: true,
+  },
+};
+```
+
+## Add type declaration
+
+When you reference an SVG asset in TypeScript code, TypeScript may prompt that the module is missing a type definition:
+
+```
+TS2307: Cannot find module './logo.svg' or its corresponding type declarations.
+```
+
+To fix this, you need to add a type declaration file for the SVG asset, please create a `src/global.d.ts` file, and add the following type declaration:
+
+```ts
+declare module '*.svg' {
+  export const ReactComponent: React.FunctionComponent<
+    React.SVGProps<SVGSVGElement>
+  >;
+
+  const content: string;
+  export default content;
+}
+```
+
+If you set `svgDefaultExport` to `'component'`, then change the type declaration to:
+
+```ts
+declare module '*.svg' {
+  export const ReactComponent: React.FunctionComponent<
+    React.SVGProps<SVGSVGElement>
+  >;
+
+  export default ReactComponent;
+}
+```
+
+After adding the type declaration, if the type error still exists, you can try to restart the current IDE, or adjust the directory where `global.d.ts` is located, making sure the TypeScript can correctly identify the type definition.
+
+## Modify the SVGR configuration
+
+When SVGR is enabled, its default configuration is as follows:
+
+```js
+{
+  svgo: true,
+  svgoConfig: {
+    plugins: [
+      {
+        name: 'preset-default',
+        params: {
+          overrides: {
+            removeViewBox: false,
+          },
+        },
+      },
+      'prefixIds',
+    ],
+  },
+}
+```
+
+If you need to modify the SVGR configuration, you can do the following:
+
+```js
+export default {
+  tools: {
+    bundlerChain: (chain, { CHAIN_ID }) => {
+      chain.module
+        .rule(CHAIN_ID.RULE.SVG)
+        .oneOf(CHAIN_ID.ONE_OF.SVG)
+        .use(CHAIN_ID.USE.SVGR)
+        .tap(options => {
+          // modify svgoConfig
+          options.svgoConfig.plugins[0].params.overrides.removeUselessDefs = false;
+          return options;
+        });
+    },
+  },
+};
+```

package/docs/en/guides/basic-features/wasm-assets.mdx

@@ -0,0 +1,66 @@
+---
+sidebar_position: 13
+---
+
+# Import Wasm Assets
+
+Modern.js supports import WebAssembly assets in code.
+
+:::tip What is WebAssembly
+WebAssembly (Wasm) is a portable, high-performance binary format designed to execute CPU-intensive computing tasks in modern web browsers, bringing performance and reliability similar to native compiled code to the web platform.
+:::
+
+## Import
+
+You can import a WebAssembly module directly in a JavaScript file:
+
+```js title="index.js"
+import { add } from './add.wasm';
+
+console.log(add); // [native code]
+console.log(add(1, 2)); // 3
+```
+
+WebAssembly modules can also be imported via dynamic import:
+
+```js title="index.js"
+import('./add.wasm').then(({ add }) => {
+  console.log('---- Async Wasm Module');
+  console.log(add); // [native code]
+  console.log(add(1, 2)); // 3
+});
+```
+
+You can also get the path of a WebAssembly module using the `new URL` syntax:
+
+```js title="index.js"
+const wasmURL = new URL('./add.wasm', import.meta.url);
+
+console.log(wasmURL).pathname; // "/static/wasm/[hash].module.wasm"
+```
+
+## Output Directory
+
+When a `.wasm` asset is imported, it will be output by Modern.js to the `dist/static/wasm` directory by default.
+
+You can change the output directory of `.wasm` files via [output.distPath](/configure/app/output/dist-path) config.
+
+```ts
+export default {
+  output: {
+    distPath: {
+      wasm: 'resource/wasm',
+    },
+  },
+};
+```
+
+## Add Type Declaration
+
+When you import a Wasm file in TypeScript code, you usually need to add the corresponding type declaration.
+
+For example, the `add.wasm` file exports an `add()` method, then you can create an `add.wasm.d.ts` file in the same directory and add the corresponding type declaration:
+
+```ts title="add.wasm.d.ts"
+export const add = (num1: number, num2: number) => number;
+```

package/docs/en/guides/get-started/quick-start.mdx

@@ -116,7 +116,7 @@ dist
     └── js
 ```
 
-> If you need to customize the directory of the build artifacts, please refer to [Output files](https://modernjs.dev/builder/guide/basic/output-files.html).
+> If you need to customize the directory of the build artifacts, please refer to [Output files](/guides/basic-features/output-files).
 
 ## Verify