@zxx_npm/create-react-component
v1.0.1
Published
一个用于快速生成 React 组件的命令行工具。当前版本支持:
Downloads
202
Readme
Create React Component
一个用于快速生成 React 组件的命令行工具。当前版本支持:
- 生成普通组件和页面组件
- 生成
jsx/tsx入口文件 - 生成
scss/less模块化样式文件 - 在普通组件创建时自动补全外层
index.ts导出
安装
全局安装:
npm install -g @zxx_npm/create-react-component临时执行:
npx @zxx_npm/create-react-component generate MyComponent安装后会注册命令:
rcc命令
rcc generate <componentName>
生成一个新的 React 组件目录。
别名:
rcc g <componentName>选项
| 选项 | 说明 |
| --- | --- |
| -p, --page | 生成页面组件 |
| -c, --component | 生成普通组件,默认行为 |
| -t, --typescript | 生成 tsx / ts 文件 |
| -j, --javascript | 生成 jsx / js 文件,默认行为 |
| -s, --scss | 生成 index.module.scss |
| -l, --less | 生成 index.module.less |
互斥规则:
--page和--component不能同时传--typescript和--javascript不能同时传--scss和--less不能同时传
组件名规则:
- 只能以字母开头
- 只能包含字母、数字、
_、-
用法示例
生成普通组件:
rcc generate MyComponent生成 TypeScript 普通组件:
rcc generate MyComponent --typescript生成带 scss 模块样式的普通组件:
rcc generate MyComponent --scss生成带 less 模块样式的 TypeScript 页面组件:
rcc generate MyPage --page --typescript --less生成结果
普通组件
命令:
rcc generate MyComponent --scss生成目录:
MyComponent/
├── index.jsx
└── index.module.scss生成的 index.jsx 会包含样式导入:
import React from 'react';
import styles from './index.module.scss';
export const MyComponent = () => {
return (
<div className={styles.container}>
<h1>MyComponent</h1>
</div>
);
};如果当前目录不存在 index.ts,工具会自动创建;存在则追加导出:
export * from './MyComponent';页面组件
命令:
rcc generate MyPage --page --typescript --less生成目录:
MyPage/
├── components/
│ └── index.ts
├── index.module.less
├── index.tsx
└── services/
└── index.ts其中页面入口会自动引入样式文件:
import React from 'react';
import styles from './index.module.less';
const MyPage = () => {
return (
<div className={styles.container}>
<h1>MyPage</h1>
</div>
);
};
export default MyPage;开发
构建命令:
npm run build本地联调:
npm link
rcc --version