keen-builder 1.0.0

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.
@@ -0,0 +1,62 @@
1
+ /*!
2
+ * normalize-path <https://github.com/jonschlinkert/normalize-path>
3
+ *
4
+ * Copyright (c) 2014-2018, Jon Schlinkert.
5
+ * Released under the MIT License.
6
+ */
7
+
8
+ /*! chokidar - MIT License (c) 2012 Paul Miller (paulmillr.com) */
9
+
10
+ /*! crc32.js (C) 2014-present SheetJS -- http://sheetjs.com */
11
+
12
+ /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */
13
+
14
+ /*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
15
+
16
+ /**
17
+ * Archiver Core
18
+ *
19
+ * @ignore
20
+ * @license [MIT]{@link https://github.com/archiverjs/node-archiver/blob/master/LICENSE}
21
+ * @copyright (c) 2012-2014 Chris Talkington, contributors.
22
+ */
23
+
24
+ /**
25
+ * Archiver Vending
26
+ *
27
+ * @ignore
28
+ * @license [MIT]{@link https://github.com/archiverjs/node-archiver/blob/master/LICENSE}
29
+ * @copyright (c) 2012-2014 Chris Talkington, contributors.
30
+ */
31
+
32
+ /**
33
+ * JSON Format Plugin
34
+ *
35
+ * @module plugins/json
36
+ * @license [MIT]{@link https://github.com/archiverjs/node-archiver/blob/master/LICENSE}
37
+ * @copyright (c) 2012-2014 Chris Talkington, contributors.
38
+ */
39
+
40
+ /**
41
+ * TAR Format Plugin
42
+ *
43
+ * @module plugins/tar
44
+ * @license [MIT]{@link https://github.com/archiverjs/node-archiver/blob/master/LICENSE}
45
+ * @copyright (c) 2012-2014 Chris Talkington, contributors.
46
+ */
47
+
48
+ /**
49
+ * ZIP Format Plugin
50
+ *
51
+ * @module plugins/zip
52
+ * @license [MIT]{@link https://github.com/archiverjs/node-archiver/blob/master/LICENSE}
53
+ * @copyright (c) 2012-2014 Chris Talkington, contributors.
54
+ */
55
+
56
+ /**
57
+ * ZipStream
58
+ *
59
+ * @ignore
60
+ * @license [MIT]{@link https://github.com/archiverjs/node-zip-stream/blob/master/LICENSE}
61
+ * @copyright (c) 2014 Chris Talkington, contributors.
62
+ */
package/package.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "name": "keen-builder",
3
+ "version": "1.0.0",
4
+ "main": "dist/index.cjs",
5
+ "module": "dist/index.mjs",
6
+ "type": "module",
7
+ "files": [
8
+ "dist/**"
9
+ ],
10
+ "exports": {
11
+ ".": {
12
+ "require": "./dist/index.cjs",
13
+ "import": "./dist/index.mjs"
14
+ }
15
+ },
16
+ "scripts": {
17
+ "start": "node ./test/init.js",
18
+ "dev": "node ./src/init.js",
19
+ "build": "webpack"
20
+ },
21
+ "keywords": [],
22
+ "author": "Keen Agents",
23
+ "license": "ISC",
24
+ "description": "",
25
+ "dependencies": {
26
+ "archiver": "^7.0.1",
27
+ "chalk": "^5.6.2",
28
+ "chokidar": "^4.0.3",
29
+ "fs-extra": "^11.3.1",
30
+ "get-stream": "^9.0.1"
31
+ },
32
+ "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
+ "husky": "^9.1.7",
38
+ "prettier": "^3.6.2",
39
+ "webpack": "^5.101.3",
40
+ "webpack-cli": "^6.0.1"
41
+ }
42
+ }
package/readme.md ADDED
@@ -0,0 +1,90 @@
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