Quick Start

3 minute demo

Want to experience Module Tools in action? The only prerequisite you need is Node.js LTS and make sure your Node version is >= 14.18.0.We recommend using the LTS version of Node.js 16.

From your shell, install the following dependencies in your project.

  • @modern-js/module-tools
  • "typescript" (omitted if not a TypeScript project)

If it's a TypeScript project, add the "typescript" dependency.

npm install -D @modern-js/module-tools typescript

For projects that use pnpm or the Yarn package manager, just replace npm. pnpm is recommended.

Next, create the modern.config.(t|j)s file in the root of the project.

import moduleTools, { defineConfig } from '@modern-js/module-tools';
export default defineConfig({
plugins: [moduleTools()],

Finally, add the command "build": "modern build" to the project's package.json file.

"scripts": {
"build": "modern build"

If your project has a src/index.(js|jsx) file or both src/index.(ts|tsx) and tsconfig.json files, then congratulations you can run the npm run build command directly to build your project with Module Tools.

If you want to see the complete project using the modular engineering scheme, you can execute the following command.

git clone https://github.com/web-infra-dev/module-tools-examples
cd module-tools-example/base
## Execute the build.
pnpm build
## Execute the build in listening mode.
pnpm build --watch
## Start Storybook
pnpm dev storybook
## Test
pnpm test

If you want to create a complete module project, you can execute the following command:

npx @modern-js/create your-project-dir-name


Execute npx @modern-js/create -hfor more command line arguments

Next, in the issue interaction, follow the options below.

? Please select the type of project you want to create: Npm Module
? Please fill in the project name: library
? Please select the development language: TS
? Please select the package manager: pnpm

The project name is the value of the "name" field in package.json.

Then the process of initializing the project will start. After the project directory and files are generated and the dependencies are installed, a complete module project is created.

We can start the project build directly with the pnpm build command, and start the build in watching mode with the pnpm build --watch command.

Let's get started

Choose your tutorial scenario...

  • I'm a beginner and need to learn basic usage of Module Tools.
  • I have learned the basic usage of Module Tools and can learn advanced usage of Module Tools.
  • I need to expand my project capabilities and need to learn how to develop plugins for Module Tools.