create-module

分类: 数据与AI | 上传者: pierreb-devkit | 下载: 0 | 版本: v1.0（最新）

Create a new feature module by duplicating the canonical `tasks` module template. Use when adding a new module to the application, scaffolding a new domain area from scratch, or generating the boilerplate for a new feature.

更新日志: Source: GitHub https://github.com/pierreb-devkit/Node

目录结构

当前层级: .claude/skills/create-module/

📄 SKILL.md 3.3 KB

SKILL.md

---
name: create-module
description: Create a new feature module by duplicating the canonical `tasks` module template. Use when adding a new module to the application, scaffolding a new domain area from scratch, or generating the boilerplate for a new feature.
---

# Create Module Skill

Create a new module by copying and renaming the `tasks` template module.

## Prerequisites

- The canonical template module `modules/tasks` must exist
- You need a name for the new module (kebab-case)

## Steps

### 1. Ask for the module name

Prompt user for the new module name in kebab-case (e.g., `my-feature`, `user-settings`)

### 2. Derive naming conventions

Follow `/naming` for the full reference. Quick summary from the module name (e.g., `my-feature`):

- **kebab-case**: `my-feature` (folder names, file prefixes, routes)
- **PascalCase**: `MyFeature` (Mongoose model names, class names)
- **lowerCamelCase**: `myFeature` (variable names, function names, JS exports)
- **UPPER_SNAKE_CASE**: `MY_FEATURE` (constants)

### 3. Duplicate the module

```bash
cp -r modules/tasks modules/{new-module-name}
```

### 4. Rename references

Search and replace the following tokens across the new module:

- `tasks` → `{new-module-name}` (kebab-case)
- `Tasks` → `{NewModuleName}` (PascalCase)
- `task` → `{new-module}` (singular kebab-case, if applicable)
- `Task` → `{NewModule}` (singular PascalCase, if applicable)

Files to check in `modules/{new-module-name}/`:

- File names (controllers, services, repositories, models, schemas, policies, routes, tests)
- Mongoose model name and collection name
- Route paths and prefixes
- Joi validation schemas
- Policy function names
- Test descriptions and fixture data

### 5. Show rename plan (if broad changes)

If renaming affects many files, show a brief plan before applying changes.

### 6. Apply renames carefully

Use safe search+replace to avoid false positives:

- Be case-sensitive
- Match whole words where possible
- Don't rename unrelated code (e.g., "tasks" in comments about other features)

### 7. Run verify

```bash
npm run lint
npm test
```

### 8. Report results

Provide a summary:

- ✅ Module created at: `modules/{new-module-name}`
- ✅ Renamed tokens: `tasks` → `{new-module-name}`, etc.
- ✅ Verification: lint passed, tests passed
- 📝 Next steps: Customize the schema, update business logic in services. Routes are auto-discovered via glob `modules/*/routes/*.js` — no registration needed

## Module Structure

```
modules/{new-module-name}/
├── controllers/
│   └── {module}.controller.js
├── services/
│   └── {module}.service.js
│   └── {module}.data.service.js
├── repositories/
│   └── {module}.repository.js
├── models/
│   └── {module}.model.mongoose.js
│   └── {module}.model.sequelize.js  (optional)
│   └── {module}.schema.js
├── policies/
│   └── {module}.policy.js
├── routes/
│   └── {module}.routes.js
└── tests/
    ├── {module}.integration.tests.js
    └── {module}.unit.tests.js
```

## Notes

- Preserves the layered architecture: controllers → services → repositories → models
- Follows modularity rules: keeps the module self-contained
- Policy functions control route authorization — update them for your use case
- Remove `{module}.model.sequelize.js` if not using SQL

登录后下载/点赞/收藏 ❤ 19 | ★ 0

create-module

目录结构

SKILL.md

举报内容

提示