@athendrakomin/developer-toolkit-core
v1.0.2
Published
Fullstack Developer Toolkit with backend, frontend, and DevOps utilities for modern web development
Readme
@athendrakomin/developer-toolkit-core
Fullstack Developer Toolkit 是一个全面的全栈开发工具包,包含了现代 Web 开发中前后端所需的工具函数、配置和组件。
🚀 特性
- 验证工具: 基于 Zod 的常用数据验证函数
- HTTP 客户端: 简化的 HTTP 请求工具
- API 配置: 环境感知的 API 配置管理
- 类型定义: 常用的 TypeScript 类型定义
- 后端工具: Express.js 服务器、中间件、认证和数据库工具
- 前端工具: React hooks、组件和HTTP客户端
- DevOps工具: Docker配置、部署脚本和环境管理
- 零依赖: 除了 Zod 外无其他依赖
- Tree-shaking: 支持按需引入
📦 安装
npm install @athendrakomin/developer-toolkit-core🛠️ 使用方法
验证工具
import { validateEmail, validatePassword } from '@athendrakomin/developer-toolkit-core';
const isValidEmail = validateEmail('[email protected]');
const isValidPassword = validatePassword('MyPassword123');HTTP 客户端
import { httpGet, httpPost } from '@athendrakomin/developer-toolkit-core';
// GET 请求
const users = await httpGet('/api/users');
// POST 请求
const newUser = await httpPost('/api/users', {
username: 'john_doe',
email: '[email protected]'
});API 配置
import { getCurrentApiConfig } from '@athendrakomin/developer-toolkit-core';
const config = getCurrentApiConfig();
console.log(config.baseUrl); // 根据环境返回相应的 base URL类型定义
import type { User, ApiResponse } from '@athendrakomin/developer-toolkit-core';
const user: User = {
id: '1',
username: 'john_doe',
email: '[email protected]',
createdAt: '2023-01-01T00:00:00Z',
updatedAt: '2023-01-01T00:00:00Z'
};后端服务器
import { createServer } from '@athendrakomin/developer-toolkit-core';
const { app, start } = createServer({
port: 3000,
enableHelmet: true,
enableCompression: true
});
app.get('/api/hello', (req, res) => {
res.json({ message: 'Hello World!' });
});
start();前端React组件
import { Button, Card } from '@athendrakomin/developer-toolkit-core';
function App() {
return (
<Card title="Welcome">
<p>This is a sample card component</p>
<Button variant="primary">Click me</Button>
</Card>
);
}DevOps工具
import { generateDockerCompose } from '@athendrakomin/developer-toolkit-core';
const composeConfig = generateDockerCompose({
web: {
image: 'myapp:latest',
ports: ['3000:3000'],
environment: {
NODE_ENV: 'production'
}
}
});
console.log(JSON.stringify(composeConfig, null, 2));📁 包含的模块
- 验证工具 (
utils/validation)- 邮箱、密码、手机号、用户名、URL 验证
- HTTP 客户端 (
utils/http)- 封装的 fetch API,支持超时控制
- API 配置 (
config/api)- 环境相关的 API 配置管理
- 类型定义 (
types)- 常用的 TypeScript 接口和枚举
- 后端工具 (
backend)- Express.js 服务器配置
- 认证和授权中间件
- 数据库工具 (Prisma)
- 错误处理工具
- 前端工具 (
frontend)- React hooks (状态管理、表单处理、API调用等)
- UI 组件 (Button, Card, Input, Alert)
- HTTP 客户端
- DevOps工具 (
devops)- Docker 配置生成器
- 部署脚本生成器
- 环境变量管理
🚀 发布到 npm
自动化发布
项目包含了两个发布脚本,可根据您的操作系统选择:
# Linux/macOS
./publish.sh
# Windows
./publish.ps1手动发布步骤
确保已登录到 npm:
npm login运行测试和构建:
npm test npm run build预发布检查:
npm pack发布包:
npm publish --access public
📄 许可证
MIT
