Design Systems & Component Libraries · 课时

包管理（NPM/Yarn）

学习如何使用行业标准的包管理器发布、使用和管理组件库的版本

第 2 / 4 课11 个步骤

包管理（NPM/Yarn） 是 CoddyKit 上的免费 Design Systems & Component Libraries 课时。这是第 2 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Design Systems & Component Libraries 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Design Systems & Component Libraries 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

Your Code's Best Friend: Package Managers

Package managers like NPM (Node Package Manager) and Yarn are essential tools in modern software development. They automate the process of finding, installing, updating, and managing external code libraries and dependencies.

Instead of manually downloading files, you simply tell the package manager what you need, and it handles the rest!

Why Design Systems Need Package Managers

Design systems are collections of reusable UI components and guidelines. To truly be 'reusable' across many different projects and teams, these components need to be easily distributable.

Package managers provide the perfect solution:

Distribution: Make your component library available to all applications.
Consistency: Ensure all projects use approved, consistent versions.
Updates: Easily roll out bug fixes or new features to consumers.
Dependency Management: Handle your library's own requirements.

NPM & Yarn: The Big Players

In the JavaScript ecosystem, NPM and Yarn are the two dominant package managers. While they share the same goal, they have different command structures and performance characteristics.

NPM: The default package manager for Node.js, widely adopted and robust.
Yarn: Created by Facebook, often praised for faster installations and improved security features.

Both primarily manage your project's package.json file and the node_modules directory.

Starting Your Component Library Package

To turn your component library into a shareable package, you need a package.json file. This file is the manifest for your project, containing metadata like its name, version, and dependencies.

You can create this file interactively using the following commands:

npm init
# or
yarn init -y

Key Fields in `package.json` for Libraries

For a component library, specific fields in package.json are critical for proper distribution and consumption:

name: A unique identifier for your package (e.g., @myorg/design-system).
version: The current version, following Semantic Versioning (SemVer).
main: Specifies the entry point file for your package (e.g., dist/index.js).
files: An array of files or directories to include when your package is published.
private: true: Prevents accidental publishing to a public registry.

{
  "name": "@myorg/design-system",
  "version": "1.0.0",
  "main": "dist/index.js",
  "files": [
    "dist"
  ],
  "license": "MIT",
  "private": false
}

Managing Dependencies: Dev, Peer, Optional

Your component library might rely on other packages. package.json allows you to specify different types of dependencies:

dependencies: Packages absolutely required for your library to run (e.g., a utility library).
devDependencies: Packages only needed during development, testing, or building (e.g., a testing framework, a bundler like Webpack).
peerDependencies: Dependencies that your *consumers* are expected to provide (e.g., React if your components are React components). This prevents multiple versions of the same dependency.

{
  "name": "my-component-lib",
  "version": "1.0.0",
  "dependencies": {
    "lodash": "^4.17.21"
  },
  "peerDependencies": {
    "react": ">=16.8.0",
    "react-dom": ">=16.8.0"
  },
  "devDependencies": {
    "webpack": "^5.0.0"
  }
}

Publishing Your Component Library

Once your component library is built and configured (e.g., compiled to dist/index.js), you can publish it. This makes it available for others to install.

You typically publish to a package registry:

Public Registries: Like the official npm registry, for open-source or widely shared packages.
Private Registries: For internal company design systems, ensuring privacy and control (e.g., GitHub Packages, Azure Artifacts, private npm).

First, log in, then build your library, and finally publish:

npm login
npm run build # Assuming you have a build script
npm publish --access public # Or omit --access public for private

Consuming Your Design System Package

In an application project that needs to use your design system, consuming the published package is simple. You just install it like any other dependency using its name.

Once installed, you can import and use the components:

// app.js
// This file would be in an application project.
// First, install the package via command line:
// npm install @myorg/design-system
// or
// yarn add @myorg/design-system

// Then, import/require components within your code:
const { Button, Card } = require('@myorg/design-system');

function mainApplicationEntry() {
  console.log("Application started!");
  console.log("Successfully imported Button component.");
  console.log("Successfully imported Card component.");
  // In a real application, you would now use these
  // components to build your UI, e.g., render <Button />
}

mainApplicationEntry();

Semantic Versioning (SemVer) Explained

Package managers rely on Semantic Versioning (SemVer), a standard for version numbers like MAJOR.MINOR.PATCH (e.g., 1.2.3). It communicates the nature of changes in each release:

MAJOR (1.0.0 -> 2.0.0): Indicates backward-incompatible API changes. Consumers might need to update their code.
MINOR (1.0.0 -> 1.1.0): New features added, but backward-compatible. Existing code should still work.
PATCH (1.0.0 -> 1.0.1): Backward-compatible bug fixes. No new features, no breaking changes.

Always increment your version number according to SemVer rules before publishing!

Quick Check: Publishing & Consuming

Imagine you have a new application project and you want to start using components from your company's published design system library.

在交互式课程中回答

Lesson Summary: Package Management

We've explored how package managers like NPM and Yarn are vital for design systems. They enable you to:

Initialize and configure your component library as a package.
Manage different types of dependencies (dependencies, devDependencies, peerDependencies) effectively.
Publish your library to public or private registries for others to use.
Seamlessly consume shared components in applications using simple install commands.
Understand and apply Semantic Versioning (SemVer) for clear and predictable updates.

Mastering package management is key to maintaining a scalable, consistent, and easily distributable design system!

免费开始

用 AI 导师学习 Design Systems & Component Libraries — 免费

在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。

课程: 12
课程: 48

免费开始学习查看完整课程

常见问题解答

「包管理（NPM/Yarn）」课时是免费的吗？

是的 — 「包管理（NPM/Yarn）」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Design Systems & Component Libraries 课程的其余内容，请升级到 CoddyKit PRO。 Design Systems & Component Libraries 课程共包含 4 节课。

「包管理（NPM/Yarn）」这节课中我会学到什么？

学习如何使用行业标准的包管理器发布、使用和管理组件库的版本你通过在浏览器中直接运行的动手代码来练习 Design Systems & Component Libraries，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Design Systems & Component Libraries 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Design Systems & Component Libraries 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 2 节课，共 4 节。

「包管理（NPM/Yarn）」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Design Systems & Component Libraries 课中编写并运行代码吗？

能。每节 Design Systems & Component Libraries 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Design Systems & Component Libraries