@nikovirtala/projen-colima 0.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.
package/.jsii ADDED
@@ -0,0 +1,155 @@
1
+ {
2
+ "author": {
3
+ "email": "niko.virtala@hey.com",
4
+ "name": "Niko Virtala",
5
+ "roles": [
6
+ "author"
7
+ ]
8
+ },
9
+ "dependencies": {
10
+ "@nikovirtala/projen-homebrew": "^1.0.0",
11
+ "constructs": "^10.4.3",
12
+ "projen": "^0.98.10"
13
+ },
14
+ "dependencyClosure": {
15
+ "@nikovirtala/projen-homebrew": {
16
+ "targets": {
17
+ "js": {
18
+ "npm": "@nikovirtala/projen-homebrew"
19
+ }
20
+ }
21
+ },
22
+ "constructs": {
23
+ "targets": {
24
+ "dotnet": {
25
+ "namespace": "Constructs",
26
+ "packageId": "Constructs"
27
+ },
28
+ "go": {
29
+ "moduleName": "github.com/aws/constructs-go"
30
+ },
31
+ "java": {
32
+ "maven": {
33
+ "artifactId": "constructs",
34
+ "groupId": "software.constructs"
35
+ },
36
+ "package": "software.constructs"
37
+ },
38
+ "js": {
39
+ "npm": "constructs"
40
+ },
41
+ "python": {
42
+ "distName": "constructs",
43
+ "module": "constructs"
44
+ }
45
+ }
46
+ },
47
+ "projen": {
48
+ "submodules": {
49
+ "projen.awscdk": {},
50
+ "projen.build": {},
51
+ "projen.cdk": {},
52
+ "projen.cdk8s": {},
53
+ "projen.cdktf": {},
54
+ "projen.circleci": {},
55
+ "projen.github": {},
56
+ "projen.github.workflows": {},
57
+ "projen.gitlab": {},
58
+ "projen.java": {},
59
+ "projen.javascript": {},
60
+ "projen.javascript.biome_config": {},
61
+ "projen.python": {},
62
+ "projen.release": {},
63
+ "projen.typescript": {},
64
+ "projen.vscode": {},
65
+ "projen.web": {}
66
+ },
67
+ "targets": {
68
+ "go": {
69
+ "moduleName": "github.com/projen/projen-go"
70
+ },
71
+ "java": {
72
+ "maven": {
73
+ "artifactId": "projen",
74
+ "groupId": "io.github.cdklabs"
75
+ },
76
+ "package": "io.github.cdklabs.projen"
77
+ },
78
+ "js": {
79
+ "npm": "projen"
80
+ },
81
+ "python": {
82
+ "distName": "projen",
83
+ "module": "projen"
84
+ }
85
+ }
86
+ }
87
+ },
88
+ "description": "Colima component for projen projects",
89
+ "docs": {
90
+ "stability": "stable"
91
+ },
92
+ "homepage": "https://github.com/nikovirtala/projen-colima.git",
93
+ "jsiiVersion": "5.9.11 (build e3d2007)",
94
+ "license": "MIT",
95
+ "metadata": {
96
+ "jsii": {
97
+ "pacmak": {
98
+ "hasDefaultInterfaces": true
99
+ }
100
+ },
101
+ "tscRootDir": "src"
102
+ },
103
+ "name": "@nikovirtala/projen-colima",
104
+ "readme": {
105
+ "markdown": "# projen-colima\n\nColima component for projen projects.\n\n## Installation\n\n```bash\nnpm install @nikovirtala/projen-colima\n```\n\n## Usage\n\nAdd the Colima component to your projen project:\n\n```typescript\nimport { Colima } from \"@nikovirtala/projen-colima\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n name: \"my-project\",\n defaultReleaseBranch: \"main\",\n});\n\nnew Colima(project);\n\nproject.synth();\n```\n\n## Features\n\n- Automatically installs Colima and Docker via Homebrew\n- Creates task to manage Colima\n\n## Tasks\n\nThe component creates the following task:\n\n- `colima` - Starts Colima if not already running\n\n## License\n\nMIT\n"
106
+ },
107
+ "repository": {
108
+ "type": "git",
109
+ "url": "https://github.com/nikovirtala/projen-colima.git"
110
+ },
111
+ "schema": "jsii/0.10.0",
112
+ "targets": {
113
+ "js": {
114
+ "npm": "@nikovirtala/projen-colima"
115
+ }
116
+ },
117
+ "types": {
118
+ "@nikovirtala/projen-colima.Colima": {
119
+ "assembly": "@nikovirtala/projen-colima",
120
+ "base": "projen.Component",
121
+ "docs": {
122
+ "remarks": "Adds Colima support to your project with automatic installation and startup.",
123
+ "stability": "stable",
124
+ "summary": "Colima component for projen projects."
125
+ },
126
+ "fqn": "@nikovirtala/projen-colima.Colima",
127
+ "initializer": {
128
+ "docs": {
129
+ "stability": "stable"
130
+ },
131
+ "locationInModule": {
132
+ "filename": "src/index.ts",
133
+ "line": 11
134
+ },
135
+ "parameters": [
136
+ {
137
+ "name": "project",
138
+ "type": {
139
+ "fqn": "projen.javascript.NodeProject"
140
+ }
141
+ }
142
+ ]
143
+ },
144
+ "kind": "class",
145
+ "locationInModule": {
146
+ "filename": "src/index.ts",
147
+ "line": 10
148
+ },
149
+ "name": "Colima",
150
+ "symbolId": "src/index:Colima"
151
+ }
152
+ },
153
+ "version": "0.0.0",
154
+ "fingerprint": "G5Z9v802S2DhdjICgDCNlM1Dbk7WYu3Ry2nRx1dvsVs="
155
+ }
package/API.md ADDED
@@ -0,0 +1,167 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### Colima <a name="Colima" id="@nikovirtala/projen-colima.Colima"></a>
6
+
7
+ Colima component for projen projects.
8
+
9
+ Adds Colima support to your project with automatic installation and startup.
10
+
11
+ #### Initializers <a name="Initializers" id="@nikovirtala/projen-colima.Colima.Initializer"></a>
12
+
13
+ ```typescript
14
+ import { Colima } from '@nikovirtala/projen-colima'
15
+
16
+ new Colima(project: NodeProject)
17
+ ```
18
+
19
+ | **Name** | **Type** | **Description** |
20
+ | --- | --- | --- |
21
+ | <code><a href="#@nikovirtala/projen-colima.Colima.Initializer.parameter.project">project</a></code> | <code>projen.javascript.NodeProject</code> | *No description.* |
22
+
23
+ ---
24
+
25
+ ##### `project`<sup>Required</sup> <a name="project" id="@nikovirtala/projen-colima.Colima.Initializer.parameter.project"></a>
26
+
27
+ - *Type:* projen.javascript.NodeProject
28
+
29
+ ---
30
+
31
+ #### Methods <a name="Methods" id="Methods"></a>
32
+
33
+ | **Name** | **Description** |
34
+ | --- | --- |
35
+ | <code><a href="#@nikovirtala/projen-colima.Colima.toString">toString</a></code> | Returns a string representation of this construct. |
36
+ | <code><a href="#@nikovirtala/projen-colima.Colima.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
37
+ | <code><a href="#@nikovirtala/projen-colima.Colima.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
38
+ | <code><a href="#@nikovirtala/projen-colima.Colima.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
39
+
40
+ ---
41
+
42
+ ##### `toString` <a name="toString" id="@nikovirtala/projen-colima.Colima.toString"></a>
43
+
44
+ ```typescript
45
+ public toString(): string
46
+ ```
47
+
48
+ Returns a string representation of this construct.
49
+
50
+ ##### `postSynthesize` <a name="postSynthesize" id="@nikovirtala/projen-colima.Colima.postSynthesize"></a>
51
+
52
+ ```typescript
53
+ public postSynthesize(): void
54
+ ```
55
+
56
+ Called after synthesis.
57
+
58
+ Order is *not* guaranteed.
59
+
60
+ ##### `preSynthesize` <a name="preSynthesize" id="@nikovirtala/projen-colima.Colima.preSynthesize"></a>
61
+
62
+ ```typescript
63
+ public preSynthesize(): void
64
+ ```
65
+
66
+ Called before synthesis.
67
+
68
+ ##### `synthesize` <a name="synthesize" id="@nikovirtala/projen-colima.Colima.synthesize"></a>
69
+
70
+ ```typescript
71
+ public synthesize(): void
72
+ ```
73
+
74
+ Synthesizes files to the project output directory.
75
+
76
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
77
+
78
+ | **Name** | **Description** |
79
+ | --- | --- |
80
+ | <code><a href="#@nikovirtala/projen-colima.Colima.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
81
+ | <code><a href="#@nikovirtala/projen-colima.Colima.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
82
+
83
+ ---
84
+
85
+ ##### `isConstruct` <a name="isConstruct" id="@nikovirtala/projen-colima.Colima.isConstruct"></a>
86
+
87
+ ```typescript
88
+ import { Colima } from '@nikovirtala/projen-colima'
89
+
90
+ Colima.isConstruct(x: any)
91
+ ```
92
+
93
+ Checks if `x` is a construct.
94
+
95
+ Use this method instead of `instanceof` to properly detect `Construct`
96
+ instances, even when the construct library is symlinked.
97
+
98
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
99
+ disk are seen as independent, completely different libraries. As a
100
+ consequence, the class `Construct` in each copy of the `constructs` library
101
+ is seen as a different class, and an instance of one class will not test as
102
+ `instanceof` the other class. `npm install` will not create installations
103
+ like this, but users may manually symlink construct libraries together or
104
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
105
+ library can be accidentally installed, and `instanceof` will behave
106
+ unpredictably. It is safest to avoid using `instanceof`, and using
107
+ this type-testing method instead.
108
+
109
+ ###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-colima.Colima.isConstruct.parameter.x"></a>
110
+
111
+ - *Type:* any
112
+
113
+ Any object.
114
+
115
+ ---
116
+
117
+ ##### `isComponent` <a name="isComponent" id="@nikovirtala/projen-colima.Colima.isComponent"></a>
118
+
119
+ ```typescript
120
+ import { Colima } from '@nikovirtala/projen-colima'
121
+
122
+ Colima.isComponent(x: any)
123
+ ```
124
+
125
+ Test whether the given construct is a component.
126
+
127
+ ###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-colima.Colima.isComponent.parameter.x"></a>
128
+
129
+ - *Type:* any
130
+
131
+ ---
132
+
133
+ #### Properties <a name="Properties" id="Properties"></a>
134
+
135
+ | **Name** | **Type** | **Description** |
136
+ | --- | --- | --- |
137
+ | <code><a href="#@nikovirtala/projen-colima.Colima.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
138
+ | <code><a href="#@nikovirtala/projen-colima.Colima.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
139
+
140
+ ---
141
+
142
+ ##### `node`<sup>Required</sup> <a name="node" id="@nikovirtala/projen-colima.Colima.property.node"></a>
143
+
144
+ ```typescript
145
+ public readonly node: Node;
146
+ ```
147
+
148
+ - *Type:* constructs.Node
149
+
150
+ The tree node.
151
+
152
+ ---
153
+
154
+ ##### `project`<sup>Required</sup> <a name="project" id="@nikovirtala/projen-colima.Colima.property.project"></a>
155
+
156
+ ```typescript
157
+ public readonly project: Project;
158
+ ```
159
+
160
+ - *Type:* projen.Project
161
+
162
+ ---
163
+
164
+
165
+
166
+
167
+
package/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2025 Niko Virtala
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # projen-colima
2
+
3
+ Colima component for projen projects.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @nikovirtala/projen-colima
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Add the Colima component to your projen project:
14
+
15
+ ```typescript
16
+ import { Colima } from "@nikovirtala/projen-colima";
17
+ import { javascript } from "projen";
18
+
19
+ const project = new javascript.NodeProject({
20
+ name: "my-project",
21
+ defaultReleaseBranch: "main",
22
+ });
23
+
24
+ new Colima(project);
25
+
26
+ project.synth();
27
+ ```
28
+
29
+ ## Features
30
+
31
+ - Automatically installs Colima and Docker via Homebrew
32
+ - Creates task to manage Colima
33
+
34
+ ## Tasks
35
+
36
+ The component creates the following task:
37
+
38
+ - `colima` - Starts Colima if not already running
39
+
40
+ ## License
41
+
42
+ MIT
package/lib/index.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ import { Component } from "projen/lib/component";
2
+ import type { NodeProject } from "projen/lib/javascript";
3
+ /**
4
+ * Colima component for projen projects.
5
+ *
6
+ * Adds Colima support to your project with automatic installation and startup.
7
+ */
8
+ export declare class Colima extends Component {
9
+ constructor(project: NodeProject);
10
+ }
package/lib/index.js ADDED
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ var _a;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Colima = void 0;
5
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
6
+ const projen_homebrew_1 = require("@nikovirtala/projen-homebrew");
7
+ const component_1 = require("projen/lib/component");
8
+ /**
9
+ * Colima component for projen projects.
10
+ *
11
+ * Adds Colima support to your project with automatic installation and startup.
12
+ */
13
+ class Colima extends component_1.Component {
14
+ constructor(project) {
15
+ super(project);
16
+ let homebrew = projen_homebrew_1.Homebrew.of(project);
17
+ if (!homebrew) {
18
+ homebrew = new projen_homebrew_1.Homebrew(project);
19
+ }
20
+ homebrew.addPackage("colima");
21
+ homebrew.addPackage("docker");
22
+ project.addTask("colima", {
23
+ exec: "colima status >/dev/null 2>&1 || colima start",
24
+ });
25
+ }
26
+ }
27
+ exports.Colima = Colima;
28
+ _a = JSII_RTTI_SYMBOL_1;
29
+ Colima[_a] = { fqn: "@nikovirtala/projen-colima.Colima", version: "0.0.0" };
30
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxrRUFBd0Q7QUFDeEQsb0RBQWlEO0FBR2pEOzs7O0dBSUc7QUFDSCxNQUFhLE1BQU8sU0FBUSxxQkFBUztJQUNqQyxZQUFZLE9BQW9CO1FBQzVCLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUVmLElBQUksUUFBUSxHQUFHLDBCQUFRLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3BDLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNaLFFBQVEsR0FBRyxJQUFJLDBCQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDckMsQ0FBQztRQUVELFFBQVEsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDOUIsUUFBUSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUU5QixPQUFPLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRTtZQUN0QixJQUFJLEVBQUUsK0NBQStDO1NBQ3hELENBQUMsQ0FBQztJQUNQLENBQUM7O0FBZkwsd0JBZ0JDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSG9tZWJyZXcgfSBmcm9tIFwiQG5pa292aXJ0YWxhL3Byb2plbi1ob21lYnJld1wiO1xuaW1wb3J0IHsgQ29tcG9uZW50IH0gZnJvbSBcInByb2plbi9saWIvY29tcG9uZW50XCI7XG5pbXBvcnQgdHlwZSB7IE5vZGVQcm9qZWN0IH0gZnJvbSBcInByb2plbi9saWIvamF2YXNjcmlwdFwiO1xuXG4vKipcbiAqIENvbGltYSBjb21wb25lbnQgZm9yIHByb2plbiBwcm9qZWN0cy5cbiAqXG4gKiBBZGRzIENvbGltYSBzdXBwb3J0IHRvIHlvdXIgcHJvamVjdCB3aXRoIGF1dG9tYXRpYyBpbnN0YWxsYXRpb24gYW5kIHN0YXJ0dXAuXG4gKi9cbmV4cG9ydCBjbGFzcyBDb2xpbWEgZXh0ZW5kcyBDb21wb25lbnQge1xuICAgIGNvbnN0cnVjdG9yKHByb2plY3Q6IE5vZGVQcm9qZWN0KSB7XG4gICAgICAgIHN1cGVyKHByb2plY3QpO1xuXG4gICAgICAgIGxldCBob21lYnJldyA9IEhvbWVicmV3Lm9mKHByb2plY3QpO1xuICAgICAgICBpZiAoIWhvbWVicmV3KSB7XG4gICAgICAgICAgICBob21lYnJldyA9IG5ldyBIb21lYnJldyhwcm9qZWN0KTtcbiAgICAgICAgfVxuXG4gICAgICAgIGhvbWVicmV3LmFkZFBhY2thZ2UoXCJjb2xpbWFcIik7XG4gICAgICAgIGhvbWVicmV3LmFkZFBhY2thZ2UoXCJkb2NrZXJcIik7XG5cbiAgICAgICAgcHJvamVjdC5hZGRUYXNrKFwiY29saW1hXCIsIHtcbiAgICAgICAgICAgIGV4ZWM6IFwiY29saW1hIHN0YXR1cyA+L2Rldi9udWxsIDI+JjEgfHwgY29saW1hIHN0YXJ0XCIsXG4gICAgICAgIH0pO1xuICAgIH1cbn1cbiJdfQ==
package/package.json ADDED
@@ -0,0 +1,83 @@
1
+ {
2
+ "name": "@nikovirtala/projen-colima",
3
+ "description": "Colima component for projen projects",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "https://github.com/nikovirtala/projen-colima.git"
7
+ },
8
+ "author": {
9
+ "name": "Niko Virtala",
10
+ "email": "niko.virtala@hey.com",
11
+ "organization": false
12
+ },
13
+ "devDependencies": {
14
+ "@biomejs/biome": "^2",
15
+ "@nikovirtala/projen-vitest": "^2.1.1",
16
+ "@types/node": "^22",
17
+ "@vitest/coverage-v8": "^4",
18
+ "commit-and-tag-version": "^12",
19
+ "constructs": "^10.0.0",
20
+ "jsii": "~5.9.3",
21
+ "jsii-diff": "^1.118.0",
22
+ "jsii-docgen": "^10.5.0",
23
+ "jsii-pacmak": "^1.118.0",
24
+ "jsii-rosetta": "~5.9.3",
25
+ "projen": "^0.98.10",
26
+ "ts-node": "^10.9.2",
27
+ "typescript": "5.9.3",
28
+ "vitest": "^4"
29
+ },
30
+ "peerDependencies": {
31
+ "constructs": "^10.4.3",
32
+ "projen": "^0.98.10"
33
+ },
34
+ "dependencies": {
35
+ "@nikovirtala/projen-homebrew": "^1.0.0",
36
+ "projen": "^0.98.10"
37
+ },
38
+ "engines": {
39
+ "node": ">= 22.21.1"
40
+ },
41
+ "main": "lib/index.js",
42
+ "license": "MIT",
43
+ "publishConfig": {
44
+ "access": "public"
45
+ },
46
+ "version": "0.0.0",
47
+ "types": "lib/index.d.ts",
48
+ "stability": "stable",
49
+ "jsii": {
50
+ "outdir": "dist",
51
+ "targets": {},
52
+ "tsc": {
53
+ "outDir": "lib",
54
+ "rootDir": "src"
55
+ }
56
+ },
57
+ "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\".",
58
+ "scripts": {
59
+ "biome": "npx projen biome",
60
+ "build": "npx projen build",
61
+ "bump": "npx projen bump",
62
+ "clobber": "npx projen clobber",
63
+ "compat": "npx projen compat",
64
+ "compile": "npx projen compile",
65
+ "default": "npx projen default",
66
+ "docgen": "npx projen docgen",
67
+ "eject": "npx projen eject",
68
+ "package": "npx projen package",
69
+ "package-all": "npx projen package-all",
70
+ "package:js": "npx projen package:js",
71
+ "post-compile": "npx projen post-compile",
72
+ "post-upgrade": "npx projen post-upgrade",
73
+ "pre-compile": "npx projen pre-compile",
74
+ "release": "npx projen release",
75
+ "test": "npx projen test",
76
+ "test:update": "npx projen test:update",
77
+ "test:watch": "npx projen test:watch",
78
+ "unbump": "npx projen unbump",
79
+ "upgrade": "npx projen upgrade",
80
+ "watch": "npx projen watch",
81
+ "projen": "npx projen"
82
+ }
83
+ }