express-skill 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -50
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,85 +1,71 @@
|
|
|
1
1
|
# express-skill
|
|
2
2
|
|
|
3
|
-
> An open, production-ready AI Agent Skill for Express.js
|
|
3
|
+
> An open, production-ready AI Agent Skill for building scalable, secure Express.js applications. Compatible with `npx skills`, Claude Code, Cursor, Antigravity, and AI coding assistants.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
`express-skill`
|
|
9
|
+
`express-skill` provides AI coding assistants with standardized architectural guidelines, production security defaults, and proven middleware patterns when developing Express.js applications.
|
|
10
|
+
|
|
11
|
+
By equipping your agent with this skill, it automatically enforces clean separation of concerns, strict input validation, centralized error handling, and security best practices without requiring repeated prompt instructions.
|
|
10
12
|
|
|
11
13
|
---
|
|
12
14
|
|
|
13
|
-
## Features
|
|
15
|
+
## Features & Capabilities
|
|
14
16
|
|
|
15
|
-
- **Layered Architecture**: Enforces
|
|
16
|
-
- **Strict Request Validation**:
|
|
17
|
-
- **Production Middleware**: Reusable error
|
|
18
|
-
- **Security Defaults**:
|
|
19
|
-
- **TypeScript & JavaScript
|
|
17
|
+
- **Layered Architecture**: Enforces clean 4-layer separation (Routes ➔ Thin Controllers ➔ Domain Services ➔ Repositories/Models).
|
|
18
|
+
- **Strict Request Validation**: Uses `zod` schemas to validate body, query, and route params before reaching business logic.
|
|
19
|
+
- **Production Middleware**: Reusable patterns for global error handling, JWT authentication, async wrappers, and structured logging.
|
|
20
|
+
- **OWASP Security Defaults**: Best practices for `helmet`, CORS restriction, rate limiting, and safe payload boundaries.
|
|
21
|
+
- **TypeScript & JavaScript Starters**: Modular blueprints for rapid project scaffolding.
|
|
20
22
|
|
|
21
23
|
---
|
|
22
24
|
|
|
23
|
-
##
|
|
24
|
-
|
|
25
|
-
```text
|
|
26
|
-
express-skill/
|
|
27
|
-
├── package.json # NPM package manifest
|
|
28
|
-
├── README.md # Skill documentation & publishing guide
|
|
29
|
-
├── LICENSE # MIT License
|
|
30
|
-
├── .gitignore # Git & NPM ignore rules
|
|
31
|
-
└── skills/
|
|
32
|
-
└── express-skill/
|
|
33
|
-
├── SKILL.md # Core agent instructions & metadata (YAML frontmatter)
|
|
34
|
-
├── references/ # Detailed modular guides loaded on demand
|
|
35
|
-
│ ├── architecture.md
|
|
36
|
-
│ ├── middleware.md
|
|
37
|
-
│ └── security.md
|
|
38
|
-
└── templates/ # Boilerplate starters
|
|
39
|
-
├── express-ts-starter.md
|
|
40
|
-
└── express-js-starter.md
|
|
41
|
-
```
|
|
25
|
+
## Installation Guide
|
|
42
26
|
|
|
43
|
-
|
|
27
|
+
### Option 1: Install via `npx skills` (Recommended)
|
|
44
28
|
|
|
45
|
-
|
|
29
|
+
Add `express-skill` directly to your project workspace or global AI agent configuration:
|
|
46
30
|
|
|
47
|
-
### Option 1: Via `npx skills` (GitHub Repository)
|
|
48
|
-
Push this repository to GitHub and install it into any workspace:
|
|
49
31
|
```bash
|
|
32
|
+
# Add to your current project
|
|
50
33
|
npx skills add ac-aman/express-skill
|
|
51
|
-
```
|
|
52
34
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
35
|
+
# Or install specifically for Claude Code
|
|
36
|
+
npx skills add ac-aman/express-skill --agent claude-code
|
|
37
|
+
|
|
38
|
+
# Or install globally for all AI agents
|
|
39
|
+
npx skills add ac-aman/express-skill -g
|
|
57
40
|
```
|
|
58
41
|
|
|
59
|
-
|
|
42
|
+
### Option 2: Install via NPM
|
|
60
43
|
|
|
61
|
-
|
|
44
|
+
Install the package directly into your project dependencies:
|
|
62
45
|
|
|
63
|
-
### Step 1: Login to NPM
|
|
64
|
-
Ensure you have an account on [npmjs.com](https://www.npmjs.com/) and log in via CLI:
|
|
65
46
|
```bash
|
|
66
|
-
npm
|
|
47
|
+
npm install express-skill
|
|
67
48
|
```
|
|
68
49
|
|
|
69
|
-
|
|
70
|
-
Test which files will be included in your npm tarball:
|
|
50
|
+
Sync skills automatically using `npx skills`:
|
|
71
51
|
```bash
|
|
72
|
-
|
|
52
|
+
npx skills experimental_sync
|
|
73
53
|
```
|
|
74
54
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Supported AI Agents & Tools
|
|
58
|
+
|
|
59
|
+
This skill follows the open [`SKILL.md`](https://skills.sh) standard and is natively supported by:
|
|
60
|
+
|
|
61
|
+
- **Claude Code** & **Claude Desktop**
|
|
62
|
+
- **Cursor**
|
|
63
|
+
- **Antigravity**
|
|
64
|
+
- **GitHub Copilot**
|
|
65
|
+
- **Custom Agentic Workflows**
|
|
80
66
|
|
|
81
67
|
---
|
|
82
68
|
|
|
83
69
|
## License
|
|
84
70
|
|
|
85
|
-
[MIT](./LICENSE)
|
|
71
|
+
[MIT](./LICENSE) © [ac-aman](https://github.com/ac-aman)
|
package/package.json
CHANGED