Storybook Design Token 项目教程

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

storybook-design-token/
├── addon/
│   ├── index.js
│   └── ...
├── docs/
│   ├── index.md
│   └── ...
├── .gitignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
└── ...

目录结构介绍

• addon/: 包含项目的核心功能代码，如插件的实现逻辑。
• docs/: 包含项目的文档文件，如README.md等。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• .prettierignore: 指定Prettier代码格式化工具忽略的文件和目录。
• .prettierrc: Prettier代码格式化工具的配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是addon/index.js，该文件是插件的入口文件，负责初始化和配置插件的主要功能。

// addon/index.js
import { addons } from '@storybook/addons';
import { STORY_RENDERED } from '@storybook/core-events';
import { DesignTokenPanel } from './DesignTokenPanel';

addons.register('storybook-design-token', api => {
  const channel = addons.getChannel();
  channel.on(STORY_RENDERED, id => {
    // 初始化逻辑
  });
  addons.addPanel('storybook-design-token/panel', {
    title: 'Design Tokens',
    render: ({ active, key }) => <DesignTokenPanel api={api} active={active} key={key} />,
  });
});

启动文件介绍

• addons.register: 注册插件，初始化插件的主要功能。
• channel.on: 监听Storybook的事件，如STORY_RENDERED，在故事渲染时执行相关逻辑。
• addons.addPanel: 添加插件的面板，用于在Storybook中显示设计令牌。

3. 项目的配置文件介绍

.prettierrc

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80
}

.gitignore

node_modules/
dist/
*.log

LICENSE

MIT License

Copyright (c) 2023 UX-and-I

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

配置文件介绍

• .prettierrc: 配置Prettier代码格式化工具的规则，如单引号、尾随逗号和每行最大字符数。
• .gitignore: 指定Git忽略的文件和目录，如node_modules/和dist/。
• LICENSE: 项目的开源许可证，采用MIT许可证。

通过以上内容，您可以了解Storybook Design Token项目的目录结构、启动文件和配置文件的基本情况。