keen-builder 1.0.0 → 1.0.10
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 +19 -13
- package/readme.md +0 -90
package/package.json
CHANGED
|
@@ -1,9 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "keen-builder",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.10",
|
|
4
4
|
"main": "dist/index.cjs",
|
|
5
|
-
"module": "dist/index.mjs",
|
|
5
|
+
"module": "./dist/index.mjs",
|
|
6
6
|
"type": "module",
|
|
7
|
+
"bin": {
|
|
8
|
+
"keen-builder": "dist/cli.cjs"
|
|
9
|
+
},
|
|
10
|
+
"publishConfig": {
|
|
11
|
+
"access": "public",
|
|
12
|
+
"registry": "https://registry.npmjs.org/"
|
|
13
|
+
},
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/PaskalN/keen-project-watch-builder-pkg.git"
|
|
17
|
+
},
|
|
7
18
|
"files": [
|
|
8
19
|
"dist/**"
|
|
9
20
|
],
|
|
@@ -14,12 +25,13 @@
|
|
|
14
25
|
}
|
|
15
26
|
},
|
|
16
27
|
"scripts": {
|
|
17
|
-
"
|
|
18
|
-
"
|
|
19
|
-
"build": "webpack"
|
|
28
|
+
"dev": "node ./dist/index.mjs",
|
|
29
|
+
"build:cjs": "webpack --config webpack.cjs.mjs",
|
|
30
|
+
"build:esm": "webpack --config webpack.esm.mjs",
|
|
31
|
+
"build": "npm run build:cjs && npm run build:esm"
|
|
20
32
|
},
|
|
21
33
|
"keywords": [],
|
|
22
|
-
"author": "
|
|
34
|
+
"author": "Paskal Novakov",
|
|
23
35
|
"license": "ISC",
|
|
24
36
|
"description": "",
|
|
25
37
|
"dependencies": {
|
|
@@ -30,13 +42,7 @@
|
|
|
30
42
|
"get-stream": "^9.0.1"
|
|
31
43
|
},
|
|
32
44
|
"devDependencies": {
|
|
33
|
-
"@babel/core": "^7.28.4",
|
|
34
|
-
"@babel/preset-env": "^7.28.3",
|
|
35
|
-
"babel-loader": "^10.0.0",
|
|
36
|
-
"copy-webpack-plugin": "^13.0.1",
|
|
37
45
|
"husky": "^9.1.7",
|
|
38
|
-
"prettier": "^3.6.2"
|
|
39
|
-
"webpack": "^5.101.3",
|
|
40
|
-
"webpack-cli": "^6.0.1"
|
|
46
|
+
"prettier": "^3.6.2"
|
|
41
47
|
}
|
|
42
48
|
}
|
package/readme.md
DELETED
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
# KEEN PROJECT WATCH BUILDER
|
|
2
|
-
|
|
3
|
-
> **KEEN PROJECT WATCH BUILDER** is an npm package for creating and deploying **Keen Agents Projects** to a cloud server.
|
|
4
|
-
> This repository hosts the **development version** of the package.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 🚀 Overview
|
|
9
|
-
|
|
10
|
-
This package streamlines the process of creating, building, and deploying Keen Agents Projects to the cloud.
|
|
11
|
-
It comes preconfigured with modern developer tools and practices:
|
|
12
|
-
|
|
13
|
-
- **Husky hooks** for Git workflow automation
|
|
14
|
-
- **Prettier** for code style and formatting
|
|
15
|
-
- **Webpack** for building and bundling
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## 🛠️ Build Process
|
|
20
|
-
|
|
21
|
-
> The **package.json** includes a **build** command:
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
npm run build
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Running this will:
|
|
28
|
-
|
|
29
|
-
- Build the source code using Webpack
|
|
30
|
-
- Generate a /dist folder containing the compiled output
|
|
31
|
-
|
|
32
|
-
## 📝 Code Standards
|
|
33
|
-
|
|
34
|
-
We use **Prettier** to maintain consistent code style (spacing, formatting).
|
|
35
|
-
|
|
36
|
-
For the best experience:
|
|
37
|
-
|
|
38
|
-
- Install the Prettier VS Code plugin
|
|
39
|
-
- Make sure code is formatted before committing
|
|
40
|
-
|
|
41
|
-
## 🌿 Branching Strategy
|
|
42
|
-
|
|
43
|
-
Branch names must follow one of these formats:
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
- feature/KWB-<NUMBER>
|
|
47
|
-
- fix/KWB-<NUMBER>
|
|
48
|
-
- hotfix/KWB-<NUMBER>
|
|
49
|
-
- remove/KWB-<NUMBER>
|
|
50
|
-
- release/KWB-<NUMBER>
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Where `<NUMBER>` is the ticket number.
|
|
54
|
-
|
|
55
|
-
## 📝 Commit Messages
|
|
56
|
-
|
|
57
|
-
Each commit message must follow this format:
|
|
58
|
-
|
|
59
|
-
```
|
|
60
|
-
KWB-<NUMBER>:<ADD|FIX|DELETE>: <MESSAGE>
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
```
|
|
64
|
-
NUMBER: Ticket number
|
|
65
|
-
|
|
66
|
-
ADD: A new feature
|
|
67
|
-
|
|
68
|
-
FIX: A feature was fixed
|
|
69
|
-
|
|
70
|
-
DELETE: Code cleaned or removed
|
|
71
|
-
|
|
72
|
-
MESSAGE: Short description of the change
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
Example:
|
|
76
|
-
|
|
77
|
-
```
|
|
78
|
-
KWB-123:ADD: Implement project builder CLI
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## 🔀 Pull Requests
|
|
82
|
-
|
|
83
|
-
- After pushing, create a PR to the development branch
|
|
84
|
-
- A minimum of 2 reviewers must approve before merging
|
|
85
|
-
|
|
86
|
-
## 🌿 Release
|
|
87
|
-
|
|
88
|
-
Once the code is built, copy the **dist** folder and paste it in project **keen-project-watch-builder-pkg**
|
|
89
|
-
|
|
90
|
-
Continue with **keen-project-watch-builder-pkg** project specification
|