projen-modules 4.4.1__tar.gz → 4.6.0__tar.gz

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: projen_modules
3
- Version: 4.4.1
3
+ Version: 4.6.0
4
4
  Summary: A collection of projen modules
5
5
  Home-page: https://github.com/daveshepherd/projen-modules.git
6
6
  Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -26,6 +26,8 @@ Requires-Dist: jsii<2.0.0,>=1.141.0
26
26
  Requires-Dist: projen<1.0.0,>=0.104.0
27
27
  Requires-Dist: publication>=0.0.3
28
28
 
29
+ <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
30
+
29
31
  # projen-modules
30
32
 
31
33
  A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
@@ -55,6 +57,33 @@ Types of testing:
55
57
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
56
58
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
57
59
 
60
+ ## Creating a New Project
61
+
62
+ ```
63
+ npx projen new {project} --from projen-modules
64
+ ```
65
+
66
+ Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
67
+
68
+ ### Project Types
69
+
70
+ | Project type | Description |
71
+ | ---------------------------------------------- | -------------------------- |
72
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
73
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
74
+ | [python-package](API.md#pythonpackage-) | A python package |
75
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
76
+
77
+ ## Project Structure
78
+
79
+ All source is located in `src` and is grouped by:
80
+
81
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
82
+ * `projects` - these are projects that can be built from this project (see #something)
83
+ * `utils` - these are helper functions that are often reused
84
+
85
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
86
+
58
87
  ## GitHub Configuration
59
88
 
60
89
  All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
@@ -96,33 +125,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
96
125
 
97
126
  If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
98
127
 
99
- ## Creating a New Project
100
-
101
- ```
102
- npx projen new {project} --from projen-modules
103
- ```
104
-
105
- Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
106
-
107
- ### Project Types
108
-
109
- | Project type | Description |
110
- | ---------------------------------------------- | -------------------------- |
111
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
112
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
113
- | [python-package](API.md#pythonpackage-) | A python package |
114
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
115
-
116
- ## Project Structure
117
-
118
- All source is located in `src` and is grouped by:
119
-
120
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
121
- * `projects` - these are projects that can be built from this project (see #something)
122
- * `utils` - these are helper functions that are often reused
123
-
124
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
125
-
126
128
  ## Known Issues
127
129
 
128
130
  `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
@@ -1,3 +1,5 @@
1
+ <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
2
+
1
3
  # projen-modules
2
4
 
3
5
  A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
@@ -27,6 +29,33 @@ Types of testing:
27
29
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
28
30
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
29
31
 
32
+ ## Creating a New Project
33
+
34
+ ```
35
+ npx projen new {project} --from projen-modules
36
+ ```
37
+
38
+ Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
39
+
40
+ ### Project Types
41
+
42
+ | Project type | Description |
43
+ | ---------------------------------------------- | -------------------------- |
44
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
45
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
46
+ | [python-package](API.md#pythonpackage-) | A python package |
47
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
48
+
49
+ ## Project Structure
50
+
51
+ All source is located in `src` and is grouped by:
52
+
53
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
54
+ * `projects` - these are projects that can be built from this project (see #something)
55
+ * `utils` - these are helper functions that are often reused
56
+
57
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
58
+
30
59
  ## GitHub Configuration
31
60
 
32
61
  All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
@@ -68,33 +97,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
68
97
 
69
98
  If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
70
99
 
71
- ## Creating a New Project
72
-
73
- ```
74
- npx projen new {project} --from projen-modules
75
- ```
76
-
77
- Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
78
-
79
- ### Project Types
80
-
81
- | Project type | Description |
82
- | ---------------------------------------------- | -------------------------- |
83
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
84
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
85
- | [python-package](API.md#pythonpackage-) | A python package |
86
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
87
-
88
- ## Project Structure
89
-
90
- All source is located in `src` and is grouped by:
91
-
92
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
93
- * `projects` - these are projects that can be built from this project (see #something)
94
- * `utils` - these are helper functions that are often reused
95
-
96
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
97
-
98
100
  ## Known Issues
99
101
 
100
102
  `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "projen_modules",
8
- "version": "4.4.1",
8
+ "version": "4.6.0",
9
9
  "description": "A collection of projen modules",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/daveshepherd/projen-modules.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "projen_modules._jsii": [
29
- "projen-modules@4.4.1.jsii.tgz"
29
+ "projen-modules@4.6.0.jsii.tgz"
30
30
  ],
31
31
  "projen_modules": [
32
32
  "py.typed"
@@ -1,4 +1,6 @@
1
1
  r'''
2
+ <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
3
+
2
4
  # projen-modules
3
5
 
4
6
  A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
@@ -28,6 +30,33 @@ Types of testing:
28
30
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
29
31
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
30
32
 
33
+ ## Creating a New Project
34
+
35
+ ```
36
+ npx projen new {project} --from projen-modules
37
+ ```
38
+
39
+ Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
40
+
41
+ ### Project Types
42
+
43
+ | Project type | Description |
44
+ | ---------------------------------------------- | -------------------------- |
45
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
46
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
47
+ | [python-package](API.md#pythonpackage-) | A python package |
48
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
49
+
50
+ ## Project Structure
51
+
52
+ All source is located in `src` and is grouped by:
53
+
54
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
55
+ * `projects` - these are projects that can be built from this project (see #something)
56
+ * `utils` - these are helper functions that are often reused
57
+
58
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
59
+
31
60
  ## GitHub Configuration
32
61
 
33
62
  All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
@@ -69,33 +98,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
69
98
 
70
99
  If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
71
100
 
72
- ## Creating a New Project
73
-
74
- ```
75
- npx projen new {project} --from projen-modules
76
- ```
77
-
78
- Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
79
-
80
- ### Project Types
81
-
82
- | Project type | Description |
83
- | ---------------------------------------------- | -------------------------- |
84
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
85
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
86
- | [python-package](API.md#pythonpackage-) | A python package |
87
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
88
-
89
- ## Project Structure
90
-
91
- All source is located in `src` and is grouped by:
92
-
93
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
94
- * `projects` - these are projects that can be built from this project (see #something)
95
- * `utils` - these are helper functions that are often reused
96
-
97
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
98
-
99
101
  ## Known Issues
100
102
 
101
103
  `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
@@ -158,6 +160,47 @@ else:
158
160
  _projen_typescript_04054675 = _LazyImport("projen.typescript")
159
161
 
160
162
 
163
+ @jsii.data_type(
164
+ jsii_type="projen-modules.AddSectionOptions",
165
+ jsii_struct_bases=[],
166
+ name_mapping={"order": "order"},
167
+ )
168
+ class AddSectionOptions:
169
+ def __init__(self, *, order: typing.Optional[jsii.Number] = None) -> None:
170
+ '''
171
+ :param order: Position of the section in the README, lowest first. Sections with the same order keep the order they were added in. Default: - ``ReadmeOrder.DEFAULT``, or the existing order when replacing a section
172
+ '''
173
+ if __debug__:
174
+ type_hints = cached_type_hints(_typecheckingstub__a1a00b07fa2976ebacf7edc4027139de9005bc000d25f7f70e4fa911a483ed1a)
175
+ check_type(argname="argument order", value=order, expected_type=type_hints["order"])
176
+ self._values: typing.Dict[builtins.str, typing.Any] = {}
177
+ if order is not None:
178
+ self._values["order"] = order
179
+
180
+ @builtins.property
181
+ def order(self) -> typing.Optional[jsii.Number]:
182
+ '''Position of the section in the README, lowest first.
183
+
184
+ Sections with the
185
+ same order keep the order they were added in.
186
+
187
+ :default: - ``ReadmeOrder.DEFAULT``, or the existing order when replacing a section
188
+ '''
189
+ result = self._values.get("order")
190
+ return typing.cast(typing.Optional[jsii.Number], result)
191
+
192
+ def __eq__(self, rhs: typing.Any) -> builtins.bool:
193
+ return isinstance(rhs, self.__class__) and rhs._values == self._values
194
+
195
+ def __ne__(self, rhs: typing.Any) -> builtins.bool:
196
+ return not (rhs == self)
197
+
198
+ def __repr__(self) -> str:
199
+ return "AddSectionOptions(%s)" % ", ".join(
200
+ k + "=" + repr(v) for k, v in self._values.items()
201
+ )
202
+
203
+
161
204
  class CdkTypeScriptApp(
162
205
  _projen_awscdk_04054675.AwsCdkTypeScriptApp,
163
206
  metaclass=jsii.JSIIMeta,
@@ -13205,17 +13248,54 @@ class Readme(
13205
13248
 
13206
13249
  jsii.create(self.__class__, self, [project, options])
13207
13250
 
13208
- @jsii.member(jsii_name="addSection")
13209
- def add_section(self, title: builtins.str, body: builtins.str) -> None:
13251
+ @jsii.member(jsii_name="of")
13252
+ @builtins.classmethod
13253
+ def of(cls, project: "_projen_04054675.Project") -> typing.Optional["Readme"]:
13254
+ '''The README of a project, if it has one.
13255
+
13256
+ :param project: -
13210
13257
  '''
13258
+ if __debug__:
13259
+ type_hints = cached_type_hints(_typecheckingstub__db6ba12d23cb270208fda8f0dd632a700456e3a838947896f5e10d812655589d)
13260
+ check_type(argname="argument project", value=project, expected_type=type_hints["project"])
13261
+ return typing.cast(typing.Optional["Readme"], jsii.sinvoke(cls, "of", [project]))
13262
+
13263
+ @jsii.member(jsii_name="addSection")
13264
+ def add_section(
13265
+ self,
13266
+ title: builtins.str,
13267
+ body: builtins.str,
13268
+ *,
13269
+ order: typing.Optional[jsii.Number] = None,
13270
+ ) -> "Section":
13271
+ '''Adds a section, or replaces the section with the same title.
13272
+
13211
13273
  :param title: -
13212
13274
  :param body: -
13275
+ :param order: Position of the section in the README, lowest first. Sections with the same order keep the order they were added in. Default: - ``ReadmeOrder.DEFAULT``, or the existing order when replacing a section
13276
+
13277
+ :return: the section
13213
13278
  '''
13214
13279
  if __debug__:
13215
13280
  type_hints = cached_type_hints(_typecheckingstub__ea72ea6648af1397d521aa4c3a3e8209831871f002cc5eed0118e644c221ff53)
13216
13281
  check_type(argname="argument title", value=title, expected_type=type_hints["title"])
13217
13282
  check_type(argname="argument body", value=body, expected_type=type_hints["body"])
13218
- return typing.cast(None, jsii.invoke(self, "addSection", [title, body]))
13283
+ options = AddSectionOptions(order=order)
13284
+
13285
+ return typing.cast("Section", jsii.invoke(self, "addSection", [title, body, options]))
13286
+
13287
+ @jsii.member(jsii_name="removeSection")
13288
+ def remove_section(self, title: builtins.str) -> builtins.bool:
13289
+ '''Removes the section with the given title.
13290
+
13291
+ :param title: -
13292
+
13293
+ :return: whether a section was removed
13294
+ '''
13295
+ if __debug__:
13296
+ type_hints = cached_type_hints(_typecheckingstub__1d38666d73c9692382192c60852bdf18210d2625b68e6058263e24af9650787b)
13297
+ check_type(argname="argument title", value=title, expected_type=type_hints["title"])
13298
+ return typing.cast(builtins.bool, jsii.invoke(self, "removeSection", [title]))
13219
13299
 
13220
13300
  @jsii.member(jsii_name="synthesizeContent")
13221
13301
  def _synthesize_content(
@@ -13231,18 +13311,23 @@ class Readme(
13231
13311
  check_type(argname="argument _", value=_, expected_type=type_hints["_"])
13232
13312
  return typing.cast(typing.Optional[builtins.str], jsii.invoke(self, "synthesizeContent", [_]))
13233
13313
 
13314
+ @jsii.member(jsii_name="tryFindSection")
13315
+ def try_find_section(self, title: builtins.str) -> typing.Optional["Section"]:
13316
+ '''The section with the given title, if there is one.
13317
+
13318
+ :param title: -
13319
+ '''
13320
+ if __debug__:
13321
+ type_hints = cached_type_hints(_typecheckingstub__eafd715c84541234b32322144595b6390ec3cf300416610573240ce25fc63867)
13322
+ check_type(argname="argument title", value=title, expected_type=type_hints["title"])
13323
+ return typing.cast(typing.Optional["Section"], jsii.invoke(self, "tryFindSection", [title]))
13324
+
13234
13325
  @builtins.property
13235
13326
  @jsii.member(jsii_name="sections")
13236
13327
  def sections(self) -> typing.List["Section"]:
13328
+ '''The sections, in the order they appear in the README.'''
13237
13329
  return typing.cast(typing.List["Section"], jsii.get(self, "sections"))
13238
13330
 
13239
- @sections.setter
13240
- def sections(self, value: typing.List["Section"]) -> None:
13241
- if __debug__:
13242
- type_hints = cached_type_hints(_typecheckingstub__b866744efc0f7f57d44f27762344fc5d2fc2a11698dc4f0fe4a59965bec00bc0)
13243
- check_type(argname="argument value", value=value, expected_type=type_hints["value"])
13244
- jsii.set(self, "sections", value) # pyright: ignore[reportArgumentType]
13245
-
13246
13331
  @builtins.property
13247
13332
  @jsii.member(jsii_name="description")
13248
13333
  def description(self) -> typing.Optional[builtins.str]:
@@ -13291,6 +13376,34 @@ class ReadmeOptions:
13291
13376
  )
13292
13377
 
13293
13378
 
13379
+ class ReadmeOrder(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.ReadmeOrder"):
13380
+ '''Orders of the bands of sections in the README, leaving room for sections in between.'''
13381
+
13382
+ @jsii.python.classproperty
13383
+ @jsii.member(jsii_name="DEFAULT")
13384
+ def DEFAULT(cls) -> jsii.Number:
13385
+ '''Sections added without an order.'''
13386
+ return typing.cast(jsii.Number, jsii.sget(cls, "DEFAULT"))
13387
+
13388
+ @jsii.python.classproperty
13389
+ @jsii.member(jsii_name="INTRODUCTION")
13390
+ def INTRODUCTION(cls) -> jsii.Number:
13391
+ '''Sections a reader needs first, such as getting started.'''
13392
+ return typing.cast(jsii.Number, jsii.sget(cls, "INTRODUCTION"))
13393
+
13394
+ @jsii.python.classproperty
13395
+ @jsii.member(jsii_name="REFERENCE")
13396
+ def REFERENCE(cls) -> jsii.Number:
13397
+ '''Reference material, such as repository configuration and known issues.'''
13398
+ return typing.cast(jsii.Number, jsii.sget(cls, "REFERENCE"))
13399
+
13400
+ @jsii.python.classproperty
13401
+ @jsii.member(jsii_name="USAGE")
13402
+ def USAGE(cls) -> jsii.Number:
13403
+ '''How to use and operate the project.'''
13404
+ return typing.cast(jsii.Number, jsii.sget(cls, "USAGE"))
13405
+
13406
+
13294
13407
  class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
13295
13408
  def __init__(self, options: "ISectionOptions") -> None:
13296
13409
  '''
@@ -13312,6 +13425,7 @@ class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
13312
13425
 
13313
13426
 
13314
13427
  __all__ = [
13428
+ "AddSectionOptions",
13315
13429
  "CdkTypeScriptApp",
13316
13430
  "CdkTypeScriptAppOptions",
13317
13431
  "DeploymentEnvironment",
@@ -13324,11 +13438,19 @@ __all__ = [
13324
13438
  "PythonPackageOptions",
13325
13439
  "Readme",
13326
13440
  "ReadmeOptions",
13441
+ "ReadmeOrder",
13327
13442
  "Section",
13328
13443
  ]
13329
13444
 
13330
13445
  publication.publish()
13331
13446
 
13447
+ def _typecheckingstub__a1a00b07fa2976ebacf7edc4027139de9005bc000d25f7f70e4fa911a483ed1a(
13448
+ *,
13449
+ order: typing.Optional[jsii.Number] = None,
13450
+ ) -> None:
13451
+ """Type checking stubs"""
13452
+ pass
13453
+
13332
13454
  def _typecheckingstub__a544530c4e440f72065d416ace5f306da46147589bc70a0f44ccba0553de9c78(
13333
13455
  value: Readme,
13334
13456
  ) -> None:
@@ -13978,9 +14100,23 @@ def _typecheckingstub__5cc1200292e645dca3ec7cf2cbf9f2c41def9f24ed1dbb485999955eb
13978
14100
  """Type checking stubs"""
13979
14101
  pass
13980
14102
 
14103
+ def _typecheckingstub__db6ba12d23cb270208fda8f0dd632a700456e3a838947896f5e10d812655589d(
14104
+ project: _projen_04054675.Project,
14105
+ ) -> None:
14106
+ """Type checking stubs"""
14107
+ pass
14108
+
13981
14109
  def _typecheckingstub__ea72ea6648af1397d521aa4c3a3e8209831871f002cc5eed0118e644c221ff53(
13982
14110
  title: builtins.str,
13983
14111
  body: builtins.str,
14112
+ *,
14113
+ order: typing.Optional[jsii.Number] = None,
14114
+ ) -> None:
14115
+ """Type checking stubs"""
14116
+ pass
14117
+
14118
+ def _typecheckingstub__1d38666d73c9692382192c60852bdf18210d2625b68e6058263e24af9650787b(
14119
+ title: builtins.str,
13984
14120
  ) -> None:
13985
14121
  """Type checking stubs"""
13986
14122
  pass
@@ -13991,8 +14127,8 @@ def _typecheckingstub__7f98643f5b00531165345da2ee730415f041f7d8dbd28b8b04ea939ba
13991
14127
  """Type checking stubs"""
13992
14128
  pass
13993
14129
 
13994
- def _typecheckingstub__b866744efc0f7f57d44f27762344fc5d2fc2a11698dc4f0fe4a59965bec00bc0(
13995
- value: typing.List[Section],
14130
+ def _typecheckingstub__eafd715c84541234b32322144595b6390ec3cf300416610573240ce25fc63867(
14131
+ title: builtins.str,
13996
14132
  ) -> None:
13997
14133
  """Type checking stubs"""
13998
14134
  pass
@@ -18,7 +18,7 @@ import constructs._jsii
18
18
  import projen._jsii
19
19
 
20
20
  __jsii_assembly__ = jsii.JSIIAssembly.load(
21
- "projen-modules", "4.4.1", __name__[0:-6], "projen-modules@4.4.1.jsii.tgz"
21
+ "projen-modules", "4.6.0", __name__[0:-6], "projen-modules@4.6.0.jsii.tgz"
22
22
  )
23
23
 
24
24
  __all__ = [
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: projen_modules
3
- Version: 4.4.1
3
+ Version: 4.6.0
4
4
  Summary: A collection of projen modules
5
5
  Home-page: https://github.com/daveshepherd/projen-modules.git
6
6
  Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -26,6 +26,8 @@ Requires-Dist: jsii<2.0.0,>=1.141.0
26
26
  Requires-Dist: projen<1.0.0,>=0.104.0
27
27
  Requires-Dist: publication>=0.0.3
28
28
 
29
+ <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
30
+
29
31
  # projen-modules
30
32
 
31
33
  A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
@@ -55,6 +57,33 @@ Types of testing:
55
57
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
56
58
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
57
59
 
60
+ ## Creating a New Project
61
+
62
+ ```
63
+ npx projen new {project} --from projen-modules
64
+ ```
65
+
66
+ Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
67
+
68
+ ### Project Types
69
+
70
+ | Project type | Description |
71
+ | ---------------------------------------------- | -------------------------- |
72
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
73
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
74
+ | [python-package](API.md#pythonpackage-) | A python package |
75
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
76
+
77
+ ## Project Structure
78
+
79
+ All source is located in `src` and is grouped by:
80
+
81
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
82
+ * `projects` - these are projects that can be built from this project (see #something)
83
+ * `utils` - these are helper functions that are often reused
84
+
85
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
86
+
58
87
  ## GitHub Configuration
59
88
 
60
89
  All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
@@ -96,33 +125,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
96
125
 
97
126
  If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
98
127
 
99
- ## Creating a New Project
100
-
101
- ```
102
- npx projen new {project} --from projen-modules
103
- ```
104
-
105
- Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
106
-
107
- ### Project Types
108
-
109
- | Project type | Description |
110
- | ---------------------------------------------- | -------------------------- |
111
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
112
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
113
- | [python-package](API.md#pythonpackage-) | A python package |
114
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
115
-
116
- ## Project Structure
117
-
118
- All source is located in `src` and is grouped by:
119
-
120
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
121
- * `projects` - these are projects that can be built from this project (see #something)
122
- * `utils` - these are helper functions that are often reused
123
-
124
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
125
-
126
128
  ## Known Issues
127
129
 
128
130
  `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
@@ -11,4 +11,4 @@ src/projen_modules.egg-info/dependency_links.txt
11
11
  src/projen_modules.egg-info/requires.txt
12
12
  src/projen_modules.egg-info/top_level.txt
13
13
  src/projen_modules/_jsii/__init__.py
14
- src/projen_modules/_jsii/projen-modules@4.4.1.jsii.tgz
14
+ src/projen_modules/_jsii/projen-modules@4.6.0.jsii.tgz
File without changes
File without changes