Primer Primitives 项目教程

1. 项目的目录结构及介绍

primer-primitives/
├── README.md
├── package.json
├── src/
│   ├── colors/
│   │   ├── base.js
│   │   ├── text.js
│   │   └── ...
│   ├── shadows/
│   │   ├── base.js
│   │   └── ...
│   ├── spacing/
│   │   ├── base.js
│   │   └── ...
│   └── ...
├── dist/
│   ├── primer-primitives.css
│   └── ...
└── ...

• README.md: 项目介绍和使用说明。
• package.json: 项目依赖和脚本配置。
• src/: 源代码目录，包含颜色、阴影、间距等模块。
  • colors/: 颜色相关模块。
  • shadows/: 阴影相关模块。
  • spacing/: 间距相关模块。
• dist/: 编译后的文件，包含CSS文件等。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的脚本配置。以下是一些常见的脚本命令：

{
  "scripts": {
    "start": "node index.js",
    "build": "webpack",
    "test": "jest"
  }
}

• start: 启动项目。
• build: 构建项目，生成编译后的文件。
• test: 运行测试。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和可能存在的 webpack.config.js 或 babel.config.js 等。

package.json

{
  "name": "primer-primitives",
  "version": "1.0.0",
  "description": "Primer design system primitives",
  "main": "dist/primer-primitives.css",
  "scripts": {
    "start": "node index.js",
    "build": "webpack",
    "test": "jest"
  },
  "dependencies": {
    "webpack": "^5.0.0",
    "jest": "^27.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件。
• scripts: 脚本命令。
• dependencies: 项目依赖。

webpack.config.js

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    filename: 'primer-primitives.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
};

• entry: 入口文件。
• output: 输出配置。
• module: 模块加载规则。

以上是 primer-primitives 项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。希望对你有所帮助！