-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPUBLISHING_GUIDE.md
More file actions
203 lines (161 loc) · 5.25 KB
/
Copy pathPUBLISHING_GUIDE.md
File metadata and controls
203 lines (161 loc) · 5.25 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
#!/usr/bin/env node
const fs = require('fs');
const path = require('path');
console.log('📦 创建新的 ModernX 包...\n');
// 获取包名
const packageName = process.argv[2];
if (!packageName) {
console.error('❌ 请提供包名: node scripts/create-package.js <package-name>');
console.log('示例: node scripts/create-package.js modernx-utils');
process.exit(1);
}
// 验证包名格式
if (!packageName.startsWith('modernx-')) {
console.error('❌ 包名必须以 "modernx-" 开头');
process.exit(1);
}
const packageDir = path.join(__dirname, '..', 'packages', packageName);
// 检查包是否已存在
if (fs.existsSync(packageDir)) {
console.error(`❌ 包 ${packageName} 已存在`);
process.exit(1);
}
// 创建目录结构
console.log(`📁 创建包目录: ${packageName}`);
fs.mkdirSync(packageDir, { recursive: true });
fs.mkdirSync(path.join(packageDir, 'src'), { recursive: true });
fs.mkdirSync(path.join(packageDir, 'test'), { recursive: true });
// 创建 package.json
const packageJson = {
name: packageName,
version: "1.0.0",
description: `ModernX ${packageName.replace('modernx-', '')} plugin`,
main: "dist/index.js",
module: "dist/index.esm.js",
types: "index.d.ts",
sideEffects: false,
files: [
"dist",
"src",
"index.d.ts"
],
repository: {
type: "git",
url: "https://github.com/perlinson/modernx",
directory: `packages/${packageName}`
},
homepage: "https://github.com/perlinson/modernx",
keywords: [
"modernx",
"modernx-plugin",
packageName.replace('modernx-', '')
],
author: "perlinson <perlinson2024@gmail.com>",
license: "MIT",
dependencies: {
"@babel/runtime": "^7.20.0"
},
peerDependencies: {
"modernx": "^1.0.0"
},
devDependencies: {
"modernx": "*"
},
scripts: {
"build": "father-build",
"test": "jest",
"lint": "eslint src"
}
};
fs.writeFileSync(
path.join(packageDir, 'package.json'),
JSON.stringify(packageJson, null, 2) + '\n'
);
// 创建主入口文件
const indexContent = `/**
* ${packageName}
* ModernX ${packageName.replace('modernx-', '')} plugin
*/
export default function ${packageName.replace('modernx', '').replace(/^-/, '').charAt(0).toUpperCase() + packageName.replace('modernx-', '').slice(1)}(options = {}) {
return {
name: '${packageName}',
...options
};
};
export * from './src';
`;
fs.writeFileSync(path.join(packageDir, 'index.js'), indexContent);
// 创建源文件
const srcContent = `/**
* ${packageName} source code
*/
export const hello = () => {
console.log('Hello from ${packageName}!');
};
export default hello;
`;
fs.writeFileSync(path.join(packageDir, 'src', 'index.js'), srcContent);
// 创建测试文件
const testContent = `import { hello } from '../src';
describe('${packageName}', () => {
test('should export hello function', () => {
expect(typeof hello).toBe('function');
});
test('should log hello message', () => {
const consoleSpy = jest.spyOn(console, 'log').mockImplementation();
hello();
expect(consoleSpy).toHaveBeenCalledWith('Hello from ${packageName}!');
consoleSpy.mockRestore();
});
});
`;
fs.writeFileSync(path.join(packageDir, 'test', 'index.test.js'), testContent);
// 创建 README
const readmeContent = `# ${packageName}
ModernX ${packageName.replace('modernx-', '')} plugin.
## Installation
\`\`\`bash
npm install ${packageName}
\`\`\`
## Usage
\`\`\`javascript
import ${packageName.replace('modernx', '').replace(/^-/, '').charAt(0).toUpperCase() + packageName.replace('modernx-', '').slice(1)} from '${packageName}';
const app = createApp({
plugins: [
${packageName.replace('modernx', '').replace(/^-/, '').charAt(0).toUpperCase() + packageName.replace('modernx-', '').slice(1)}()
]
});
\`\`\`
## API
### ${packageName.replace('modernx', '').replace(/^-/, '').charAt(0).toUpperCase() + packageName.replace('modernx-', '').slice(1)}(options)
创建 ${packageName.replace('modernx-', '')} 插件实例。
#### Options
- \`options\` (Object): 配置选项
## License
MIT
`;
fs.writeFileSync(path.join(packageDir, 'README.md'), readmeContent);
// 创建 TypeScript 定义文件
const typesContent = `declare module '${packageName}' {
export interface Options {
[key: string]: any;
}
export default function ${packageName.replace('modernx', '').replace(/^-/, '').charAt(0).toUpperCase() + packageName.replace('modernx-', '').slice(1)}(options?: Options): any;
export * from './src';
}
`;
fs.writeFileSync(path.join(packageDir, 'index.d.ts'), typesContent);
console.log(`✅ 包 ${packageName} 创建成功!`);
console.log('\n📁 创建的文件:');
console.log(` - packages/${packageName}/package.json`);
console.log(` - packages/${packageName}/index.js`);
console.log(` - packages/${packageName}/src/index.js`);
console.log(` - packages/${packageName}/test/index.test.js`);
console.log(` - packages/${packageName}/README.md`);
console.log(` - packages/${packageName}/index.d.ts`);
console.log('\n🚀 下一步:');
console.log(` 1. 编辑 packages/${packageName}/src/index.js 实现功能`);
console.log(` 2. 添加测试到 packages/${packageName}/test/`);
console.log(` 3. 更新文档 packages/${packageName}/README.md`);
console.log(` 4. 运行 npm run workspaces:link 链接依赖`);
console.log(` 5. 运行 npm test 测试新包`);