keen-project-create 1.0.10 → 1.0.12
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/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "keen-project-create",
|
|
3
3
|
"description": "Project scaffolder for Keen projects",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.12",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
},
|
|
10
10
|
"repository": {
|
|
11
11
|
"type": "git",
|
|
12
|
-
"url": "git+https://github.com/
|
|
12
|
+
"url": "git+https://github.com/Keen-Agents/keen-project-create.git"
|
|
13
13
|
},
|
|
14
14
|
"files": [
|
|
15
15
|
"dist/",
|
package/readme.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# KEEN PROJECT CREATE
|
|
2
|
+
|
|
3
|
+
> **KEEN PROJECT CREATE** is scaffold **Keen Agents Projects**.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Overview
|
|
8
|
+
|
|
9
|
+
This package is a NPX command that creates ready for use project setup.
|
|
10
|
+
It comes preconfigured with modern developer tools and practices:
|
|
11
|
+
|
|
12
|
+
- **Husky hooks** for Git workflow automation
|
|
13
|
+
- **Prettier** for code style and formatting
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
## 🌿 Usage
|
|
17
|
+
Standard template
|
|
18
|
+
```
|
|
19
|
+
npx keen-project-create <PROJECT_DIR>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
VSCode template with prettrier and debugger
|
|
23
|
+
```
|
|
24
|
+
npx keen-project-create <PROJECT_DIR> vscode
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 📝 Code Standards
|
|
30
|
+
|
|
31
|
+
We use **Prettier** to maintain consistent code style (spacing, formatting).
|
|
32
|
+
|
|
33
|
+
For the best experience:
|
|
34
|
+
|
|
35
|
+
- Install the Prettier VS Code plugin
|
|
36
|
+
- Make sure code is formatted before committing
|
|
37
|
+
|
|
38
|
+
## 🌿 Branching Strategy
|
|
39
|
+
|
|
40
|
+
Branch names must follow one of these formats:
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
- feature/KPC-<NUMBER>
|
|
44
|
+
- fix/KPC-<NUMBER>
|
|
45
|
+
- hotfix/KPC-<NUMBER>
|
|
46
|
+
- remove/KPC-<NUMBER>
|
|
47
|
+
- release/KPC-<NUMBER>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Where `<NUMBER>` is the ticket number.
|
|
51
|
+
|
|
52
|
+
## 📝 Commit Messages
|
|
53
|
+
|
|
54
|
+
Each commit message must follow this format:
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
KPC-<NUMBER>:<ADD|FIX|DELETE>: <MESSAGE>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
NUMBER: Ticket number
|
|
62
|
+
|
|
63
|
+
ADD: A new feature
|
|
64
|
+
|
|
65
|
+
FIX: A feature was fixed
|
|
66
|
+
|
|
67
|
+
DELETE: Code cleaned or removed
|
|
68
|
+
|
|
69
|
+
MESSAGE: Short description of the change
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Example:
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
KPC-123:ADD: Version X.X.X
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 🔀 Pull Requests
|
|
79
|
+
|
|
80
|
+
- After pushing, create a PR to the development branch
|
|
81
|
+
- A minimum of 2 reviewers must approve before merging
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
"version": "0.2.0",
|
|
3
3
|
"configurations": [
|
|
4
4
|
{
|
|
5
|
-
"name": "Attach to Keen
|
|
6
|
-
"type": "
|
|
5
|
+
"name": "Attach to Keen",
|
|
6
|
+
"type": "node",
|
|
7
7
|
"request": "attach",
|
|
8
|
-
"address": "
|
|
9
|
-
"port":
|
|
8
|
+
"address": "<__REPLACE__>",
|
|
9
|
+
"port": 9229,
|
|
10
10
|
"timeout": 30000,
|
|
11
11
|
"skipFiles": ["<node_internals>/**"],
|
|
12
|
+
"sourceMaps": true,
|
|
12
13
|
"localRoot": "${workspaceFolder}/src",
|
|
13
|
-
"remoteRoot": "
|
|
14
|
-
"sourceMaps": true
|
|
14
|
+
"remoteRoot": "/app/projects/sketch"
|
|
15
15
|
}
|
|
16
16
|
]
|
|
17
17
|
}
|