@nikovirtala/projen-localstack 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,252 @@
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-dependencies": "^1.0.4",
11
+ "constructs": "^10.4.3",
12
+ "projen": "^0.98.10"
13
+ },
14
+ "dependencyClosure": {
15
+ "@nikovirtala/projen-homebrew-dependencies": {
16
+ "targets": {
17
+ "js": {
18
+ "npm": "@nikovirtala/projen-homebrew-dependencies"
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": "LocalStack component for projen projects",
89
+ "docs": {
90
+ "stability": "stable"
91
+ },
92
+ "homepage": "https://github.com/nikovirtala/projen-localstack.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-localstack",
104
+ "readme": {
105
+ "markdown": "# projen-localstack\n\nLocalStack component for projen projects.\n\n## Installation\n\n```bash\nnpm install @nikovirtala/projen-localstack\n```\n\n## Usage\n\nAdd the LocalStack component to your projen project:\n\n```typescript\nimport { LocalStack } from \"@nikovirtala/projen-localstack\";\nimport { javascript } from \"projen\";\n\nconst project = new javascript.NodeProject({\n name: \"my-project\",\n defaultReleaseBranch: \"main\",\n});\n\nnew LocalStack(project);\n\nproject.synth();\n```\n\n## Configuration\n\nThe LocalStack component accepts the following options:\n\n```typescript\nnew LocalStack(project, {\n services: \"s3,lambda,dynamodb\", // Specific services to enable\n port: 4566, // LocalStack gateway port (default: 4566)\n debug: true, // Enable debug mode (default: false)\n imageTag: \"latest\", // Docker image tag (default: \"latest\")\n});\n```\n\n## Features\n\n- Automatically installs LocalStack via Homebrew\n- Checks for Docker and installs Colima if needed\n- Creates tasks to manage Colima and LocalStack\n- Adds `aws-cdk-local` to devDependencies\n- Integrates with test task to start LocalStack before tests\n\n## Tasks\n\nThe component creates the following tasks:\n\n- `colima` - Starts Colima if not already running\n- `localstack` - Starts LocalStack if not already running\n\n## License\n\nMIT\n"
106
+ },
107
+ "repository": {
108
+ "type": "git",
109
+ "url": "https://github.com/nikovirtala/projen-localstack.git"
110
+ },
111
+ "schema": "jsii/0.10.0",
112
+ "targets": {
113
+ "js": {
114
+ "npm": "@nikovirtala/projen-localstack"
115
+ }
116
+ },
117
+ "types": {
118
+ "@nikovirtala/projen-localstack.LocalStack": {
119
+ "assembly": "@nikovirtala/projen-localstack",
120
+ "base": "projen.Component",
121
+ "docs": {
122
+ "remarks": "Adds LocalStack support to your project with automatic Docker/Colima setup.",
123
+ "stability": "stable",
124
+ "summary": "LocalStack component for projen projects."
125
+ },
126
+ "fqn": "@nikovirtala/projen-localstack.LocalStack",
127
+ "initializer": {
128
+ "docs": {
129
+ "stability": "stable"
130
+ },
131
+ "locationInModule": {
132
+ "filename": "src/index.ts",
133
+ "line": 40
134
+ },
135
+ "parameters": [
136
+ {
137
+ "name": "project",
138
+ "type": {
139
+ "fqn": "projen.javascript.NodeProject"
140
+ }
141
+ },
142
+ {
143
+ "name": "options",
144
+ "optional": true,
145
+ "type": {
146
+ "fqn": "@nikovirtala/projen-localstack.LocalStackOptions"
147
+ }
148
+ }
149
+ ]
150
+ },
151
+ "kind": "class",
152
+ "locationInModule": {
153
+ "filename": "src/index.ts",
154
+ "line": 39
155
+ },
156
+ "name": "LocalStack",
157
+ "symbolId": "src/index:LocalStack"
158
+ },
159
+ "@nikovirtala/projen-localstack.LocalStackOptions": {
160
+ "assembly": "@nikovirtala/projen-localstack",
161
+ "datatype": true,
162
+ "docs": {
163
+ "stability": "stable",
164
+ "summary": "Options for LocalStack component."
165
+ },
166
+ "fqn": "@nikovirtala/projen-localstack.LocalStackOptions",
167
+ "kind": "interface",
168
+ "locationInModule": {
169
+ "filename": "src/index.ts",
170
+ "line": 8
171
+ },
172
+ "name": "LocalStackOptions",
173
+ "properties": [
174
+ {
175
+ "abstract": true,
176
+ "docs": {
177
+ "default": "false",
178
+ "stability": "stable",
179
+ "summary": "Enable LocalStack debug mode."
180
+ },
181
+ "immutable": true,
182
+ "locationInModule": {
183
+ "filename": "src/index.ts",
184
+ "line": 25
185
+ },
186
+ "name": "debug",
187
+ "optional": true,
188
+ "type": {
189
+ "primitive": "boolean"
190
+ }
191
+ },
192
+ {
193
+ "abstract": true,
194
+ "docs": {
195
+ "default": "\"latest\"",
196
+ "stability": "stable",
197
+ "summary": "LocalStack Docker image tag."
198
+ },
199
+ "immutable": true,
200
+ "locationInModule": {
201
+ "filename": "src/index.ts",
202
+ "line": 31
203
+ },
204
+ "name": "imageTag",
205
+ "optional": true,
206
+ "type": {
207
+ "primitive": "string"
208
+ }
209
+ },
210
+ {
211
+ "abstract": true,
212
+ "docs": {
213
+ "default": "4566",
214
+ "stability": "stable",
215
+ "summary": "LocalStack gateway port."
216
+ },
217
+ "immutable": true,
218
+ "locationInModule": {
219
+ "filename": "src/index.ts",
220
+ "line": 19
221
+ },
222
+ "name": "port",
223
+ "optional": true,
224
+ "type": {
225
+ "primitive": "number"
226
+ }
227
+ },
228
+ {
229
+ "abstract": true,
230
+ "docs": {
231
+ "default": "- all services enabled",
232
+ "stability": "stable",
233
+ "summary": "LocalStack services to enable."
234
+ },
235
+ "immutable": true,
236
+ "locationInModule": {
237
+ "filename": "src/index.ts",
238
+ "line": 13
239
+ },
240
+ "name": "services",
241
+ "optional": true,
242
+ "type": {
243
+ "primitive": "string"
244
+ }
245
+ }
246
+ ],
247
+ "symbolId": "src/index:LocalStackOptions"
248
+ }
249
+ },
250
+ "version": "0.0.0",
251
+ "fingerprint": "AU8ZSoFtLBg6FhfUa3gywfaGdPRpWP3U7xqNbgJoUQU="
252
+ }
package/API.md ADDED
@@ -0,0 +1,250 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### LocalStack <a name="LocalStack" id="@nikovirtala/projen-localstack.LocalStack"></a>
6
+
7
+ LocalStack component for projen projects.
8
+
9
+ Adds LocalStack support to your project with automatic Docker/Colima setup.
10
+
11
+ #### Initializers <a name="Initializers" id="@nikovirtala/projen-localstack.LocalStack.Initializer"></a>
12
+
13
+ ```typescript
14
+ import { LocalStack } from '@nikovirtala/projen-localstack'
15
+
16
+ new LocalStack(project: NodeProject, options?: LocalStackOptions)
17
+ ```
18
+
19
+ | **Name** | **Type** | **Description** |
20
+ | --- | --- | --- |
21
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.Initializer.parameter.project">project</a></code> | <code>projen.javascript.NodeProject</code> | *No description.* |
22
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.Initializer.parameter.options">options</a></code> | <code><a href="#@nikovirtala/projen-localstack.LocalStackOptions">LocalStackOptions</a></code> | *No description.* |
23
+
24
+ ---
25
+
26
+ ##### `project`<sup>Required</sup> <a name="project" id="@nikovirtala/projen-localstack.LocalStack.Initializer.parameter.project"></a>
27
+
28
+ - *Type:* projen.javascript.NodeProject
29
+
30
+ ---
31
+
32
+ ##### `options`<sup>Optional</sup> <a name="options" id="@nikovirtala/projen-localstack.LocalStack.Initializer.parameter.options"></a>
33
+
34
+ - *Type:* <a href="#@nikovirtala/projen-localstack.LocalStackOptions">LocalStackOptions</a>
35
+
36
+ ---
37
+
38
+ #### Methods <a name="Methods" id="Methods"></a>
39
+
40
+ | **Name** | **Description** |
41
+ | --- | --- |
42
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.toString">toString</a></code> | Returns a string representation of this construct. |
43
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
44
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
45
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
46
+
47
+ ---
48
+
49
+ ##### `toString` <a name="toString" id="@nikovirtala/projen-localstack.LocalStack.toString"></a>
50
+
51
+ ```typescript
52
+ public toString(): string
53
+ ```
54
+
55
+ Returns a string representation of this construct.
56
+
57
+ ##### `postSynthesize` <a name="postSynthesize" id="@nikovirtala/projen-localstack.LocalStack.postSynthesize"></a>
58
+
59
+ ```typescript
60
+ public postSynthesize(): void
61
+ ```
62
+
63
+ Called after synthesis.
64
+
65
+ Order is *not* guaranteed.
66
+
67
+ ##### `preSynthesize` <a name="preSynthesize" id="@nikovirtala/projen-localstack.LocalStack.preSynthesize"></a>
68
+
69
+ ```typescript
70
+ public preSynthesize(): void
71
+ ```
72
+
73
+ Called before synthesis.
74
+
75
+ ##### `synthesize` <a name="synthesize" id="@nikovirtala/projen-localstack.LocalStack.synthesize"></a>
76
+
77
+ ```typescript
78
+ public synthesize(): void
79
+ ```
80
+
81
+ Synthesizes files to the project output directory.
82
+
83
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
84
+
85
+ | **Name** | **Description** |
86
+ | --- | --- |
87
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
88
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
89
+
90
+ ---
91
+
92
+ ##### `isConstruct` <a name="isConstruct" id="@nikovirtala/projen-localstack.LocalStack.isConstruct"></a>
93
+
94
+ ```typescript
95
+ import { LocalStack } from '@nikovirtala/projen-localstack'
96
+
97
+ LocalStack.isConstruct(x: any)
98
+ ```
99
+
100
+ Checks if `x` is a construct.
101
+
102
+ Use this method instead of `instanceof` to properly detect `Construct`
103
+ instances, even when the construct library is symlinked.
104
+
105
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
106
+ disk are seen as independent, completely different libraries. As a
107
+ consequence, the class `Construct` in each copy of the `constructs` library
108
+ is seen as a different class, and an instance of one class will not test as
109
+ `instanceof` the other class. `npm install` will not create installations
110
+ like this, but users may manually symlink construct libraries together or
111
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
112
+ library can be accidentally installed, and `instanceof` will behave
113
+ unpredictably. It is safest to avoid using `instanceof`, and using
114
+ this type-testing method instead.
115
+
116
+ ###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-localstack.LocalStack.isConstruct.parameter.x"></a>
117
+
118
+ - *Type:* any
119
+
120
+ Any object.
121
+
122
+ ---
123
+
124
+ ##### `isComponent` <a name="isComponent" id="@nikovirtala/projen-localstack.LocalStack.isComponent"></a>
125
+
126
+ ```typescript
127
+ import { LocalStack } from '@nikovirtala/projen-localstack'
128
+
129
+ LocalStack.isComponent(x: any)
130
+ ```
131
+
132
+ Test whether the given construct is a component.
133
+
134
+ ###### `x`<sup>Required</sup> <a name="x" id="@nikovirtala/projen-localstack.LocalStack.isComponent.parameter.x"></a>
135
+
136
+ - *Type:* any
137
+
138
+ ---
139
+
140
+ #### Properties <a name="Properties" id="Properties"></a>
141
+
142
+ | **Name** | **Type** | **Description** |
143
+ | --- | --- | --- |
144
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
145
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStack.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
146
+
147
+ ---
148
+
149
+ ##### `node`<sup>Required</sup> <a name="node" id="@nikovirtala/projen-localstack.LocalStack.property.node"></a>
150
+
151
+ ```typescript
152
+ public readonly node: Node;
153
+ ```
154
+
155
+ - *Type:* constructs.Node
156
+
157
+ The tree node.
158
+
159
+ ---
160
+
161
+ ##### `project`<sup>Required</sup> <a name="project" id="@nikovirtala/projen-localstack.LocalStack.property.project"></a>
162
+
163
+ ```typescript
164
+ public readonly project: Project;
165
+ ```
166
+
167
+ - *Type:* projen.Project
168
+
169
+ ---
170
+
171
+
172
+ ## Structs <a name="Structs" id="Structs"></a>
173
+
174
+ ### LocalStackOptions <a name="LocalStackOptions" id="@nikovirtala/projen-localstack.LocalStackOptions"></a>
175
+
176
+ Options for LocalStack component.
177
+
178
+ #### Initializer <a name="Initializer" id="@nikovirtala/projen-localstack.LocalStackOptions.Initializer"></a>
179
+
180
+ ```typescript
181
+ import { LocalStackOptions } from '@nikovirtala/projen-localstack'
182
+
183
+ const localStackOptions: LocalStackOptions = { ... }
184
+ ```
185
+
186
+ #### Properties <a name="Properties" id="Properties"></a>
187
+
188
+ | **Name** | **Type** | **Description** |
189
+ | --- | --- | --- |
190
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStackOptions.property.debug">debug</a></code> | <code>boolean</code> | Enable LocalStack debug mode. |
191
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStackOptions.property.imageTag">imageTag</a></code> | <code>string</code> | LocalStack Docker image tag. |
192
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStackOptions.property.port">port</a></code> | <code>number</code> | LocalStack gateway port. |
193
+ | <code><a href="#@nikovirtala/projen-localstack.LocalStackOptions.property.services">services</a></code> | <code>string</code> | LocalStack services to enable. |
194
+
195
+ ---
196
+
197
+ ##### `debug`<sup>Optional</sup> <a name="debug" id="@nikovirtala/projen-localstack.LocalStackOptions.property.debug"></a>
198
+
199
+ ```typescript
200
+ public readonly debug: boolean;
201
+ ```
202
+
203
+ - *Type:* boolean
204
+ - *Default:* false
205
+
206
+ Enable LocalStack debug mode.
207
+
208
+ ---
209
+
210
+ ##### `imageTag`<sup>Optional</sup> <a name="imageTag" id="@nikovirtala/projen-localstack.LocalStackOptions.property.imageTag"></a>
211
+
212
+ ```typescript
213
+ public readonly imageTag: string;
214
+ ```
215
+
216
+ - *Type:* string
217
+ - *Default:* "latest"
218
+
219
+ LocalStack Docker image tag.
220
+
221
+ ---
222
+
223
+ ##### `port`<sup>Optional</sup> <a name="port" id="@nikovirtala/projen-localstack.LocalStackOptions.property.port"></a>
224
+
225
+ ```typescript
226
+ public readonly port: number;
227
+ ```
228
+
229
+ - *Type:* number
230
+ - *Default:* 4566
231
+
232
+ LocalStack gateway port.
233
+
234
+ ---
235
+
236
+ ##### `services`<sup>Optional</sup> <a name="services" id="@nikovirtala/projen-localstack.LocalStackOptions.property.services"></a>
237
+
238
+ ```typescript
239
+ public readonly services: string;
240
+ ```
241
+
242
+ - *Type:* string
243
+ - *Default:* all services enabled
244
+
245
+ LocalStack services to enable.
246
+
247
+ ---
248
+
249
+
250
+
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,59 @@
1
+ # projen-localstack
2
+
3
+ LocalStack component for projen projects.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @nikovirtala/projen-localstack
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Add the LocalStack component to your projen project:
14
+
15
+ ```typescript
16
+ import { LocalStack } from "@nikovirtala/projen-localstack";
17
+ import { javascript } from "projen";
18
+
19
+ const project = new javascript.NodeProject({
20
+ name: "my-project",
21
+ defaultReleaseBranch: "main",
22
+ });
23
+
24
+ new LocalStack(project);
25
+
26
+ project.synth();
27
+ ```
28
+
29
+ ## Configuration
30
+
31
+ The LocalStack component accepts the following options:
32
+
33
+ ```typescript
34
+ new LocalStack(project, {
35
+ services: "s3,lambda,dynamodb", // Specific services to enable
36
+ port: 4566, // LocalStack gateway port (default: 4566)
37
+ debug: true, // Enable debug mode (default: false)
38
+ imageTag: "latest", // Docker image tag (default: "latest")
39
+ });
40
+ ```
41
+
42
+ ## Features
43
+
44
+ - Automatically installs LocalStack via Homebrew
45
+ - Checks for Docker and installs Colima if needed
46
+ - Creates tasks to manage Colima and LocalStack
47
+ - Adds `aws-cdk-local` to devDependencies
48
+ - Integrates with test task to start LocalStack before tests
49
+
50
+ ## Tasks
51
+
52
+ The component creates the following tasks:
53
+
54
+ - `colima` - Starts Colima if not already running
55
+ - `localstack` - Starts LocalStack if not already running
56
+
57
+ ## License
58
+
59
+ MIT
package/biome.jsonc ADDED
@@ -0,0 +1,59 @@
1
+ // biome-ignore-all format: ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
2
+ {
3
+ "assist": {
4
+ "actions": {
5
+ "recommended": true
6
+ },
7
+ "enabled": true
8
+ },
9
+ "files": {
10
+ "ignoreUnknown": false,
11
+ "includes": [
12
+ "src/**",
13
+ "test/**",
14
+ ".projenrc.ts",
15
+ "projenrc/**",
16
+ "!.gitattributes",
17
+ "!.github/workflows/auto-approve.yml",
18
+ "!.github/workflows/build.yml",
19
+ "!.github/workflows/pull-request-lint.yml",
20
+ "!.github/workflows/release.yml",
21
+ "!.github/workflows/upgrade-main.yml",
22
+ "!.gitignore",
23
+ "!.mergify.yml",
24
+ "!.npmrc",
25
+ "!.projen/deps.json",
26
+ "!.projen/files.json",
27
+ "!.projen/tasks.json",
28
+ "!.vscode/extensions.json",
29
+ "!.vscode/settings.json",
30
+ "!mise.toml",
31
+ "!tsconfig.dev.json",
32
+ "!vitest.config.ts"
33
+ ]
34
+ },
35
+ "formatter": {
36
+ "enabled": true,
37
+ "indentStyle": "space",
38
+ "indentWidth": 4,
39
+ "lineWidth": 120,
40
+ "useEditorconfig": false
41
+ },
42
+ "javascript": {
43
+ "formatter": {
44
+ "quoteStyle": "double"
45
+ }
46
+ },
47
+ "linter": {
48
+ "enabled": true,
49
+ "rules": {
50
+ "recommended": true
51
+ }
52
+ },
53
+ "vcs": {
54
+ "clientKind": "git",
55
+ "enabled": true,
56
+ "useIgnoreFile": true
57
+ },
58
+ "$schema": "node_modules/@biomejs/biome/configuration_schema.json"
59
+ }
package/lib/index.d.ts ADDED
@@ -0,0 +1,35 @@
1
+ import { Component } from "projen/lib/component";
2
+ import type { NodeProject } from "projen/lib/javascript";
3
+ /**
4
+ * Options for LocalStack component.
5
+ */
6
+ export interface LocalStackOptions {
7
+ /**
8
+ * LocalStack services to enable.
9
+ * @default - all services enabled
10
+ */
11
+ readonly services?: string;
12
+ /**
13
+ * LocalStack gateway port.
14
+ * @default 4566
15
+ */
16
+ readonly port?: number;
17
+ /**
18
+ * Enable LocalStack debug mode.
19
+ * @default false
20
+ */
21
+ readonly debug?: boolean;
22
+ /**
23
+ * LocalStack Docker image tag.
24
+ * @default "latest"
25
+ */
26
+ readonly imageTag?: string;
27
+ }
28
+ /**
29
+ * LocalStack component for projen projects.
30
+ *
31
+ * Adds LocalStack support to your project with automatic Docker/Colima setup.
32
+ */
33
+ export declare class LocalStack extends Component {
34
+ constructor(project: NodeProject, options?: LocalStackOptions);
35
+ }
package/lib/index.js ADDED
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ var _a;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.LocalStack = void 0;
5
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
6
+ const projen_homebrew_dependencies_1 = require("@nikovirtala/projen-homebrew-dependencies");
7
+ const component_1 = require("projen/lib/component");
8
+ /**
9
+ * LocalStack component for projen projects.
10
+ *
11
+ * Adds LocalStack support to your project with automatic Docker/Colima setup.
12
+ */
13
+ class LocalStack extends component_1.Component {
14
+ constructor(project, options = {}) {
15
+ super(project);
16
+ const port = options.port ?? 4566;
17
+ const debug = options.debug ?? false;
18
+ let homebrew = projen_homebrew_dependencies_1.HomebrewDependencies.of(project);
19
+ if (!homebrew) {
20
+ homebrew = new projen_homebrew_dependencies_1.HomebrewDependencies(project);
21
+ }
22
+ homebrew.addPackage("colima");
23
+ homebrew.addPackage("docker");
24
+ homebrew.addPackage("localstack");
25
+ const colimaTask = project.addTask("colima", {
26
+ exec: "colima status >/dev/null 2>&1 || colima start",
27
+ });
28
+ const envVars = [`LOCALSTACK_PORT=${port}`, `LOCALSTACK_DEBUG=${debug ? "1" : "0"}`];
29
+ if (options.services) {
30
+ envVars.push(`SERVICES=${options.services}`);
31
+ }
32
+ const localstackTask = project.addTask("localstack", {
33
+ exec: `localstack status || (${envVars.join(" ")} localstack start -d)`,
34
+ });
35
+ localstackTask.prependSpawn(colimaTask);
36
+ project.addDevDeps("aws-cdk-local");
37
+ const testTask = project.tasks.tryFind("test");
38
+ if (testTask) {
39
+ testTask.prependSpawn(localstackTask);
40
+ }
41
+ }
42
+ }
43
+ exports.LocalStack = LocalStack;
44
+ _a = JSII_RTTI_SYMBOL_1;
45
+ LocalStack[_a] = { fqn: "@nikovirtala/projen-localstack.LocalStack", version: "0.0.0" };
46
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw0RkFBaUY7QUFDakYsb0RBQWlEO0FBZ0NqRDs7OztHQUlHO0FBQ0gsTUFBYSxVQUFXLFNBQVEscUJBQVM7SUFDckMsWUFBWSxPQUFvQixFQUFFLFVBQTZCLEVBQUU7UUFDN0QsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBRWYsTUFBTSxJQUFJLEdBQUcsT0FBTyxDQUFDLElBQUksSUFBSSxJQUFJLENBQUM7UUFDbEMsTUFBTSxLQUFLLEdBQUcsT0FBTyxDQUFDLEtBQUssSUFBSSxLQUFLLENBQUM7UUFFckMsSUFBSSxRQUFRLEdBQUcsbURBQW9CLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2hELElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNaLFFBQVEsR0FBRyxJQUFJLG1EQUFvQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2pELENBQUM7UUFFRCxRQUFRLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQzlCLFFBQVEsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDOUIsUUFBUSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUVsQyxNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRTtZQUN6QyxJQUFJLEVBQUUsK0NBQStDO1NBQ3hELENBQUMsQ0FBQztRQUVILE1BQU0sT0FBTyxHQUFHLENBQUMsbUJBQW1CLElBQUksRUFBRSxFQUFFLG9CQUFvQixLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNyRixJQUFJLE9BQU8sQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNuQixPQUFPLENBQUMsSUFBSSxDQUFDLFlBQVksT0FBTyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDakQsQ0FBQztRQUVELE1BQU0sY0FBYyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsWUFBWSxFQUFFO1lBQ2pELElBQUksRUFBRSx5QkFBeUIsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsdUJBQXVCO1NBQzFFLENBQUMsQ0FBQztRQUVILGNBQWMsQ0FBQyxZQUFZLENBQUMsVUFBVSxDQUFDLENBQUM7UUFFeEMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUVwQyxNQUFNLFFBQVEsR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUMvQyxJQUFJLFFBQVEsRUFBRSxDQUFDO1lBQ1gsUUFBUSxDQUFDLFlBQVksQ0FBQyxjQUFjLENBQUMsQ0FBQztRQUMxQyxDQUFDO0lBQ0wsQ0FBQzs7QUFyQ0wsZ0NBc0NDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSG9tZWJyZXdEZXBlbmRlbmNpZXMgfSBmcm9tIFwiQG5pa292aXJ0YWxhL3Byb2plbi1ob21lYnJldy1kZXBlbmRlbmNpZXNcIjtcbmltcG9ydCB7IENvbXBvbmVudCB9IGZyb20gXCJwcm9qZW4vbGliL2NvbXBvbmVudFwiO1xuaW1wb3J0IHR5cGUgeyBOb2RlUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL2phdmFzY3JpcHRcIjtcblxuLyoqXG4gKiBPcHRpb25zIGZvciBMb2NhbFN0YWNrIGNvbXBvbmVudC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBMb2NhbFN0YWNrT3B0aW9ucyB7XG4gICAgLyoqXG4gICAgICogTG9jYWxTdGFjayBzZXJ2aWNlcyB0byBlbmFibGUuXG4gICAgICogQGRlZmF1bHQgLSBhbGwgc2VydmljZXMgZW5hYmxlZFxuICAgICAqL1xuICAgIHJlYWRvbmx5IHNlcnZpY2VzPzogc3RyaW5nO1xuXG4gICAgLyoqXG4gICAgICogTG9jYWxTdGFjayBnYXRld2F5IHBvcnQuXG4gICAgICogQGRlZmF1bHQgNDU2NlxuICAgICAqL1xuICAgIHJlYWRvbmx5IHBvcnQ/OiBudW1iZXI7XG5cbiAgICAvKipcbiAgICAgKiBFbmFibGUgTG9jYWxTdGFjayBkZWJ1ZyBtb2RlLlxuICAgICAqIEBkZWZhdWx0IGZhbHNlXG4gICAgICovXG4gICAgcmVhZG9ubHkgZGVidWc/OiBib29sZWFuO1xuXG4gICAgLyoqXG4gICAgICogTG9jYWxTdGFjayBEb2NrZXIgaW1hZ2UgdGFnLlxuICAgICAqIEBkZWZhdWx0IFwibGF0ZXN0XCJcbiAgICAgKi9cbiAgICByZWFkb25seSBpbWFnZVRhZz86IHN0cmluZztcbn1cblxuLyoqXG4gKiBMb2NhbFN0YWNrIGNvbXBvbmVudCBmb3IgcHJvamVuIHByb2plY3RzLlxuICpcbiAqIEFkZHMgTG9jYWxTdGFjayBzdXBwb3J0IHRvIHlvdXIgcHJvamVjdCB3aXRoIGF1dG9tYXRpYyBEb2NrZXIvQ29saW1hIHNldHVwLlxuICovXG5leHBvcnQgY2xhc3MgTG9jYWxTdGFjayBleHRlbmRzIENvbXBvbmVudCB7XG4gICAgY29uc3RydWN0b3IocHJvamVjdDogTm9kZVByb2plY3QsIG9wdGlvbnM6IExvY2FsU3RhY2tPcHRpb25zID0ge30pIHtcbiAgICAgICAgc3VwZXIocHJvamVjdCk7XG5cbiAgICAgICAgY29uc3QgcG9ydCA9IG9wdGlvbnMucG9ydCA/PyA0NTY2O1xuICAgICAgICBjb25zdCBkZWJ1ZyA9IG9wdGlvbnMuZGVidWcgPz8gZmFsc2U7XG5cbiAgICAgICAgbGV0IGhvbWVicmV3ID0gSG9tZWJyZXdEZXBlbmRlbmNpZXMub2YocHJvamVjdCk7XG4gICAgICAgIGlmICghaG9tZWJyZXcpIHtcbiAgICAgICAgICAgIGhvbWVicmV3ID0gbmV3IEhvbWVicmV3RGVwZW5kZW5jaWVzKHByb2plY3QpO1xuICAgICAgICB9XG5cbiAgICAgICAgaG9tZWJyZXcuYWRkUGFja2FnZShcImNvbGltYVwiKTtcbiAgICAgICAgaG9tZWJyZXcuYWRkUGFja2FnZShcImRvY2tlclwiKTtcbiAgICAgICAgaG9tZWJyZXcuYWRkUGFja2FnZShcImxvY2Fsc3RhY2tcIik7XG5cbiAgICAgICAgY29uc3QgY29saW1hVGFzayA9IHByb2plY3QuYWRkVGFzayhcImNvbGltYVwiLCB7XG4gICAgICAgICAgICBleGVjOiBcImNvbGltYSBzdGF0dXMgPi9kZXYvbnVsbCAyPiYxIHx8IGNvbGltYSBzdGFydFwiLFxuICAgICAgICB9KTtcblxuICAgICAgICBjb25zdCBlbnZWYXJzID0gW2BMT0NBTFNUQUNLX1BPUlQ9JHtwb3J0fWAsIGBMT0NBTFNUQUNLX0RFQlVHPSR7ZGVidWcgPyBcIjFcIiA6IFwiMFwifWBdO1xuICAgICAgICBpZiAob3B0aW9ucy5zZXJ2aWNlcykge1xuICAgICAgICAgICAgZW52VmFycy5wdXNoKGBTRVJWSUNFUz0ke29wdGlvbnMuc2VydmljZXN9YCk7XG4gICAgICAgIH1cblxuICAgICAgICBjb25zdCBsb2NhbHN0YWNrVGFzayA9IHByb2plY3QuYWRkVGFzayhcImxvY2Fsc3RhY2tcIiwge1xuICAgICAgICAgICAgZXhlYzogYGxvY2Fsc3RhY2sgc3RhdHVzIHx8ICgke2VudlZhcnMuam9pbihcIiBcIil9IGxvY2Fsc3RhY2sgc3RhcnQgLWQpYCxcbiAgICAgICAgfSk7XG5cbiAgICAgICAgbG9jYWxzdGFja1Rhc2sucHJlcGVuZFNwYXduKGNvbGltYVRhc2spO1xuXG4gICAgICAgIHByb2plY3QuYWRkRGV2RGVwcyhcImF3cy1jZGstbG9jYWxcIik7XG5cbiAgICAgICAgY29uc3QgdGVzdFRhc2sgPSBwcm9qZWN0LnRhc2tzLnRyeUZpbmQoXCJ0ZXN0XCIpO1xuICAgICAgICBpZiAodGVzdFRhc2spIHtcbiAgICAgICAgICAgIHRlc3RUYXNrLnByZXBlbmRTcGF3bihsb2NhbHN0YWNrVGFzayk7XG4gICAgICAgIH1cbiAgICB9XG59XG4iXX0=
package/mise.toml ADDED
@@ -0,0 +1,2 @@
1
+ [tools]
2
+ node = "22.21.1"
package/package.json ADDED
@@ -0,0 +1,83 @@
1
+ {
2
+ "name": "@nikovirtala/projen-localstack",
3
+ "description": "LocalStack component for projen projects",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "https://github.com/nikovirtala/projen-localstack.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-dependencies": "^1.0.4",
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
+ }
@@ -0,0 +1,28 @@
1
+ import { defineConfig } from "@nikovirtala/projen-vitest/lib/bundled-define-config";
2
+
3
+ export default defineConfig({
4
+ test: {
5
+ bail: 0,
6
+ coverage: {
7
+ enabled: true,
8
+ provider: "v8",
9
+ reporter: ["text","lcov"],
10
+ reportsDirectory: "coverage",
11
+ },
12
+ environment: "node",
13
+ exclude: ["**/node_modules/**","**/dist/**","**/cypress/**","**/.{idea,git,cache,output,temp}/**","**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*"],
14
+ globals: false,
15
+ include: ["**/*.{test,spec}.?(c|m)[jt]s?(x)"],
16
+ isolate: true,
17
+ passWithNoTests: true,
18
+ printConsoleTrace: true,
19
+ pool: "forks",
20
+ slowTestThreshold: 300,
21
+ typecheck: {
22
+ enabled: true,
23
+ checker: "tsc --noEmit",
24
+ tsconfig: "tsconfig.dev.json",
25
+ },
26
+ update: true,
27
+ },
28
+ });