npm - @modern-js/main-doc - Versions diffs - 2.8.0 → 2.9.0 - Mend

@modern-js/main-doc 2.8.0 → 2.9.0

Files changed (1079) hide show

package/en/tutorials/first-app/c03-css.mdx DELETED Viewed

@@ -1,323 +0,0 @@
----
-title: Add Style
----
-# Add Style
-import { Tabs, Tab as TabItem } from "@theme";
-In the previous chapter, we learned how to use components from the three-way library.
-In this chapter, we will learn how to implement UI components.
-## JS components using CSS
-First of all, we want to control the display of contact avatars by ourselves, and implement this design draft:
-![design](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c03-css-expect.jpg)
-Hypothesis has no ready-made components to implement, so you need to write some CSS yourself. Here we use [styled-components] (https://styled-components.com/) to implement similar requirements. Modern.js out of the box supports styled-components, which requires neither dependency nor configuration.
-Style-components avoids many problems of traditional CSS writing through modularization. For example, writing styles directly on the style attribute of elements, the visual details of UI will also be mixed with the details of UI structure and business logic. Or classname needs to avoid global space renaming, which requires the use of naming conventions.
-Modify the code at the top in `src/routes/page.tsx`:
-```js
-import styled from '@modern-js/runtime/styled';
-```
-Add the following code:
-```js
-const Avatar = styled.img`
-  width: 50px;
-  height: 50px;
-  border: 4px solid #0ef;
-  border-radius: 50%;
-`;
-```
-Modify the code of `List.Item.Meta`:
-```tsx
-<List.Item.Meta
-  avatar={<Avatar src={avatar} />}
-  title={name}
-  description={email}
-/>
-```
-Execute `pnpm run dev` to see the expected running result:
-![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c03-css-result1.png)
-Next we do a little refactoring. To enhance legibility and make the code easier to maintain, we can split the Avatar component. We execute the following command at the end point to create a new file:
-<Tabs>
-<TabItem value="macOS" label="macOS" default>
-```bash
-mkdir -p src/components/Avatar
-touch src/components/Avatar/index.tsx
-```
-</TabItem>
-<TabItem value="Windows" label="Windows">
-```powershell
-mkdir -p src/components/Avatar
-ni src/components/Avatar/index.tsx
-```
-</TabItem>
-</Tabs>
-Delete the `<Avatar>` implementation in `src/routes/page.tsx` and change it to:
-```ts
-import Avatar from '../components/Avatar';
-```
-The content of `src/components/Avatar/index.tsx` is modified to:
-```ts
-import styled from '@modern-js/runtime/styled';
-const Avatar = styled.img`
-  width: 50px;
-  height: 50px;
-  border: 4px solid #0ef;
-  border-radius: 50%;
-`;
-export default Avatar;
-```
-Execute `pnpm run dev`, the result should be the same.
-:::info note
-The reason for using the directory form `Avatar/index.tsx` instead of the single-file form `Avatar.tsx` is that you can easily add sub-files inside the directory later, including dedicated resources (pictures, etc.), dedicated sub-components, CSS files, etc.
-:::
-## Utility
-We have used the style-components implementation `<Avatar>` component, but the current UI is still unsatisfactory and lacks professionalism, such as the list item inhouse layout is a bit rough and misaligned in many places.
-Now, let's implement a better `Item` component ourselves, implementing a design draft like this:
-![design](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/design2.png)
-The UI to be implemented this time is more complex and has an internal structure, but on the other hand, there is no very thick bright blue border of the `<Avatar>` component such a very special UI, which is a very conventional horizontal and vertical layout, centering, font style, etc. In this case, there is actually no need to write CSS at all. There is a more efficient implementation method that complements styled-components: **Utility Class**.
-Modern.js integrates the mainstream, light, general-purpose Utility Class library [Tailwind CSS](https://tailwindcss.com/).
-Execute `pnpm run new` and select the following to start Tailwind CSS:
-```bash
-? Action: Enable features
-? Enable features: Enable Tailwind CSS
-```
-Register the Tailwind plugin in `modern.config.ts`:
-```ts title="modern.config.ts"
-import appTools, { defineConfig } from '@modern-js/app-tools';
-import tailwindcssPlugin from '@modern-js/plugin-tailwindcss';
-export default defineConfig({
-  runtime: {
-    router: true,
-    state: true,
-  },
-  server: {
-    ssr: true,
-  },
-  plugins: [appTools(), tailwindcssPlugin()],
-});
-```
-Import the Tailwind CSS css file at the top of `src/routes/page.tsx` to start a quick implementation of the professional UI:
-```js
-import 'tailwindcss/base.css';
-import 'tailwindcss/components.css';
-import 'tailwindcss/utilities.css';
-```
-Create the Item component first:
-<Tabs>
-<TabItem value="macOS" label="macOS" default>
-```bash
-mkdir -p src/components/Item
-touch src/components/Item/index.tsx
-```
-</TabItem>
-<TabItem value="Windows" label="Windows">
-```powershell
-mkdir -p src/components/Item
-ni src/components/Item/index.tsx
-```
-</TabItem>
-</Tabs>
-Modify `src/routes/page.tsx` to pass the `render` implementation of `List` to `Item` component:
-```js
-import { List } from 'antd';
-import 'tailwindcss/base.css';
-import 'tailwindcss/components.css';
-import 'tailwindcss/utilities.css';
-import Item from '../components/Item';
-const getAvatar = (users: Array<{ name: string, email: string }>) =>
-  users.map(user => ({
-    ...user,
-    avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
-  }));
-const mockData = getAvatar([
-  { name: 'Thomas', email: 'w.kccip@bllmfbgv.dm' },
-  { name: 'Chow', email: 'f.lfqljnlk@ywoefljhc.af' },
-  { name: 'Bradley', email: 'd.wfovsqyo@gpkcjwjgb.fr' },
-  { name: 'Davis', email: '"t.kqkoj@utlkwnpwk.nu' },
-]);
-function Index() {
-  return (
-    <div className="container lg mx-auto">
-      <List
-        dataSource={mockData}
-        renderItem={info => <Item key={info.name} info={info} />}
-      />
-    </div>
-  );
-}
-export default Index;
-```
-Utility Class(https://tailwindcss.com/docs/container) is used on the parent container for a quick implementation of the most basic maximum width, center, and other styles.
-Next implementation `src/components/Item/index.tsx`:
-```tsx
-import Avatar from '../Avatar';
-type InfoProps = {
-  avatar: string;
-  name: string;
-  email: string;
-  archived?: boolean;
-};
-const Item = ({ info }: { info: InfoProps }) => {
-  const { avatar, name, email, archived } = info;
-  return (
-    <div className="flex p-4 items-center border-gray-200 border-b">
-      <Avatar src={avatar} />
-      <div className="ml-4 flex-1 flex justify-between">
-        <div className="flex-1">
-          <p>{name}</p>
-          <p>{email}</p>
-        </div>
-        <button
-          type="button"
-          disabled={archived}
-          className={`bg-blue-500  text-white font-bold
-            py-2 px-4 rounded-full hover:bg-blue-700`}
-        >
-          Archive
-        </button>
-      </div>
-    </div>
-  );
-};
-export default Item;
-```
-Execute `pnpm run dev` to see the expected running result:
-![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/result2.png)
-We only use a few Utility Classes, such as [Flex](https://tailwindcss.com/docs/display/), [Padding](https://tailwindcss.com/docs/padding/), [Margin](https://tailwindcss.com/docs/margin/), [Text](https://tailwindcss.com/docs/text-color/), [Font](https://tailwindcss.com/docs/font-weight/), [Border](https://tailwindcss.com/docs/border-width), without writing a single CSS implementation Professional UI that conforms to the design draft.
-## Customized Utility Class
-We can also implement the new Utility Class ourselves to facilitate reuse between codes.
-Utility Class itself is also a **component-oriented** technology (using different classes on a component is equivalent to setting some attributes from the base class for this component), but the classname of Utility Class is global (because it is used on arbitrary components/elements), it is very suitable for implementation with separate CSS files.
-Create a new CSS file:
-<Tabs>
-<TabItem value="macOS" label="macOS" default>
-```bash
-mkdir -p src/styles
-touch src/styles/utils.css
-```
-</TabItem>
-<TabItem value="Windows" label="Windows">
-```powershell
-mkdir -p src/styles
-ni src/styles/utils.css
-```
-</TabItem>
-</Tabs>
-在 `src/routes/page.tsx` 里导入 `utils.css`：
-```js
-import '../styles/utils.css';
-```
-A Utility Class named `custom-text-gray` is implemented in `src/routes/styles/utils.css`.
-```css
-:root {
-  --custom-text-color: rgb(113, 128, 150);
-}
-.custom-text-gray {
-  color: var(--custom-text-color);
-}
-```
-:::info note
-Modern.js integrates with [PostCSS](/guides/basic-features/css) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
-:::
-Use in `src/routes/components/Item/index.tsx`:
-```js
-<div className="ml-4 flex-1 flex justify-between">
-```
-Change to:
-```js
-<div className="ml-4 custom-text-gray flex-1 flex justify-between">
-```
-Execute `pnpm run dev`, you can see that the font color has changed:
-![design2](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/result3.png)
-:::info note
-This is just to demonstrate Utility Class usage. In a real project, with Tailwind CSS, this Utility Class is of little value and should be added to the font color through the [**theme**](https://tailwindcss.com/docs/customizing-colors) of the configuration Design System.
-`utils.css` can also be written as `utils.scss` or `utils.less`, Modern.js out of the box support for SCSS and Less.
-However, with the support of PostCSS, modern CSS should be sufficient to meet these development needs, and the performance is also better than that of the preprocessor. It is recommended to use `.css` files first.
-:::

package/scripts/config.ts DELETED Viewed

@@ -1,96 +0,0 @@
-import path from 'path';
-import fs from 'fs-extra';
-const tip: Record<string, string> = {
-  zh: '该配置由 Modern.js Builder 提供，更多信息可参考',
-  en: 'This config is provided by Modern.js Builder, more detail can see',
-};
-export type Summary = {
-  name: string;
-  dirname: string;
-};
-export type Language = 'en' | 'zh';
-const createMarkdown = (summary: Summary, lng: Language) => {
-  const { name, dirname } = summary;
-  const langPrefix = lng === 'zh' ? '' : `/${lng}`;
-  return `---
-sidebar_label: ${name}
----
-# ${dirname}.${name}
-:::tip
-${
-  tip[lng]
-} [${dirname}.${name}](https://modernjs.dev/builder${langPrefix}/api/config-${dirname}.html#${dirname}${name.toLowerCase()})${
-    lng === 'en' ? '.' : '。'
-  }
-:::
-import Main from '@modern-js/builder-doc/docs/${lng}/config/${dirname}/${name}.md'
-<Main />
-`;
-};
-const hyphenateRE = /\B([A-Z]+)/g;
-const hyphenate = function (str: string) {
-  return str.replace(hyphenateRE, '-$1').toLowerCase();
-};
-const configPath = 'configure/app';
-const getBaseDir = (lng: Language) => {
-  const cwd = process.cwd();
-  const baseDir = path.join(cwd, lng, configPath);
-  return baseDir;
-};
-export const gen = (jsonMap: Record<Language, Summary[]>) => {
-  Object.keys(jsonMap).forEach(lng => {
-    const baseDir = getBaseDir(lng as Language);
-    const json = jsonMap[lng as Language];
-    json.forEach(summary => {
-      const mdDir = path.join(baseDir, summary.dirname);
-      const mdPath = path.join(mdDir, `${hyphenate(summary.name)}.mdx`);
-      if (!fs.existsSync(mdDir)) {
-        fs.mkdirpSync(mdDir);
-      }
-      fs.writeFileSync(mdPath, createMarkdown(summary, lng as Language));
-    });
-  });
-};
-export const diff = (jsonMap: Record<Language, Summary[]>) => {
-  const outdatedURI: string[] = [];
-  Object.keys(jsonMap).forEach(lng => {
-    const json = jsonMap[lng as Language];
-    const old: {
-      name: string;
-      dirname: string;
-    }[] = require(`./summary.${lng}.json`);
-    const outdated = old.filter(oldSummary => {
-      return !json.find(summary => {
-        return (
-          summary.dirname === oldSummary.dirname &&
-          summary.name === oldSummary.name
-        );
-      });
-    });
-    const URIAry = outdated.map(summary => {
-      const baseDir = getBaseDir(lng as Language);
-      const mdDir = path.join(baseDir, summary.dirname);
-      const mdPath = path.join(mdDir, `${hyphenate(summary.name)}.md`);
-      return mdPath;
-    });
-    outdatedURI.push(...URIAry);
-  });
-  return outdatedURI;
-};

package/scripts/summary.en.json DELETED Viewed

@@ -1 +0,0 @@

- [{"name":"assetPrefix","dirname":"dev"},{"name":"beforeStartUrl","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"host","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"tags","dirname":"html"},{"name":"tagsByEntries","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssExtract","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"checkSyntax","dirname":"security"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"rspack","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]

package/scripts/summary.zh.json DELETED Viewed

@@ -1 +0,0 @@

package/scripts/sync.ts DELETED Viewed

@@ -1,57 +0,0 @@
-import path, { basename, dirname, extname } from 'path';
-import fs from 'fs-extra';
-import { diff, gen } from './config';
-const walk = (dir: string) => {
-  const fl: string[] = [];
-  fs.readdirSync(dir).forEach(ff => {
-    const fpath = path.join(dir, ff);
-    if (fs.statSync(fpath).isDirectory()) {
-      fl.push(...walk(fpath));
-    } else if (extname(fpath) === '.md') {
-      fl.push(fpath);
-    }
-  });
-  return fl;
-};
-const summary = (lng: string) => {
-  const fl = walk(
-    path.join(
-      process.cwd(),
-      `./node_modules/@modern-js/builder-doc/docs/${lng}/config`,
-    ),
-  );
-  const json = fl.map(fpath => {
-    return {
-      name: basename(fpath).replace(extname(fpath), ''),
-      dirname: basename(dirname(fpath)),
-    };
-  });
-  return json;
-};
-const zh = summary('zh');
-const en = summary('en');
-// 寻找已经过时的配置，并删除
-const outdated = diff({
-  zh,
-  en,
-});
-outdated.forEach(uri => {
-  if (fs.existsSync(uri)) {
-    fs.unlinkSync(uri);
-  }
-});
-// 生成新的配置
-fs.writeJSONSync(path.join(__dirname, 'summary.en.json'), en);
-fs.writeJSONSync(path.join(__dirname, 'summary.zh.json'), zh);
-gen({
-  zh,
-  en,
-});

package/tsconfig.json DELETED Viewed

@@ -1,7 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "jsx": "preserve"
-  },
-  "include": ["./src", "./navbar.js", "./sidebar.js", "./scripts"]
-}

package/zh/apis/monorepo/commands/new.mdx DELETED Viewed

@@ -1,39 +0,0 @@
----
-sidebar_position: 1
----
-# new
-```bash
-Usage: modern new [options]
-Monorepo 创建子项目
-Options:
-  -d, --debug            开启 Debug 模式，打印调试日志信息 (default: false)
-  -c, --config <config>  生成器运行默认配置(JSON 字符串)
-  --dist-tag <tag>       生成器使用特殊的 npm Tag 版本
-  --registry             生成器运行过程中定制 npm Registry
-  -h, --help             display help for command
-```
-`modern new` 命令在 monorepo 中可以用来添加应用工程和可复用的模块：
-```bash
-$ modern new
-? 请选择你想创建的工程类型 (Use arrow keys)
-❯ 应用
-  应用（测试）
-  模块
-  模块（内部）
-```
-应用工程默认会添加到 `apps` 目录， 测试应用会添加到 `examples` 目录，公共模块默认会添加到 `packages` 目录， 内部模块默认会添加到 `features` 目录。
-内部模块在 monorepo 的应用里面使用时，可以无需构建直接使用源码。
-:::caution 注意
-`--config` 参数对应参数值需要使用 JSON 字符串。
-pnpm 暂不支持使用 JSON 字符串作为参数值，可使用 `npm new` 开启相关功能。【[相关 Issue](https://github.com/pnpm/pnpm/issues/3876)】
-:::

package/zh/components/default-mwa-generate.mdx DELETED Viewed

@@ -1,5 +0,0 @@
-```bash
-? 请选择你想创建的工程类型 应用
-? 请选择开发语言 TS
-? 请选择包管理工具 pnpm
-```

package/zh/components/init-app.mdx DELETED Viewed

@@ -1,44 +0,0 @@
-Modern.js 生成器会提供一个可交互的问答界面，根据结果初始化项目，按照默认的选择进行初始化：
-```bash
-? 请选择你想创建的工程类型 应用
-? 请选择开发语言 TS
-? 请选择包管理工具 pnpm
-```
-在生成项目后，Modern.js 会自动安装依赖、创建 git 仓库。
-```bash
-[INFO] 依赖自动安装成功
-[INFO] git 仓库初始化成功
-[INFO] 创建成功！
-可在新项目的目录下运行以下命令：
-pnpm run dev          # 按开发环境的要求，运行和调试项目
-pnpm run build        # 按生产环境的要求，构建项目
-pnpm run serve        # 按生产环境的要求，运行项目
-pnpm run lint         # 检查和修复所有代码
-pnpm run new          # 继续创建更多项目要素，比如应用入口
-```
-:::note
-Modern.js 生成器除了在项目初始化时工作外，也能在后续研发中生成项目各种粒度的模块，并非一用即抛开。
-:::
-现在，项目结构如下：
-```
-.
-├── node_modules
-├── src
-│   ├── modern-app-env.d.ts
-│   └── routes
-│       ├── index.css
-│       ├── layout.tsx
-│       └── page.tsx
-├── modern.config.ts
-├── package.json
-├── pnpm-lock.yaml
-├── README.md
-└── tsconfig.json
-```

package/zh/components/init-rspack-app.mdx DELETED Viewed

@@ -1,7 +0,0 @@
-```bash
-$ npx @modern-js/create myapp
-? 请选择你想创建的工程类型 应用
-? 请选择开发语言 TS
-? 请选择包管理工具 pnpm
-? 请选择构建工具 Rspack
-```

package/zh/components/prerequisites.mdx DELETED Viewed

@@ -1,20 +0,0 @@
-### Node.js
-需要 [Node.js LTS](https://github.com/nodejs/Release)，并确保 Node 版本大于等于 v16.18.1。
-Modern.js 推荐在开发环境里先安装 [nvm](https://github.com/nvm-sh/nvm#install--update-script)，在 shell 里集成[自动切换 node 版本的脚本](https://github.com/nvm-sh/nvm#deeper-shell-integration)。
-然后只要仓库根目录下有内容为 `lts/gallium` 的 `.nvmrc` 文件，进入这个仓库时就会自动安装或切换到正确的 Node.js 版本。
-### pnpm
-推荐使用 [pnpm](https://pnpm.io/installation) 来管理依赖：
-```bash
-npm install -g pnpm
-```
-:::note
-Modern.js 同样支持使用 `yarn`、`npm` 进行依赖管理。
-:::