projen-modules 4.4.0__tar.gz → 4.5.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.
- {projen_modules-4.4.0/src/projen_modules.egg-info → projen_modules-4.5.0}/PKG-INFO +28 -28
- {projen_modules-4.4.0 → projen_modules-4.5.0}/setup.py +2 -2
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules/__init__.py +171 -39
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules/_jsii/__init__.py +1 -1
- projen_modules-4.5.0/src/projen_modules/_jsii/projen-modules@4.5.0.jsii.tgz +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0/src/projen_modules.egg-info}/PKG-INFO +28 -28
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules.egg-info/SOURCES.txt +1 -1
- projen_modules-4.4.0/src/projen_modules/_jsii/projen-modules@4.4.0.jsii.tgz +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/LICENSE +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/MANIFEST.in +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/README.md +27 -27
- {projen_modules-4.4.0 → projen_modules-4.5.0}/pyproject.toml +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/setup.cfg +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules/py.typed +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules.egg-info/dependency_links.txt +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules.egg-info/requires.txt +0 -0
- {projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: projen_modules
|
|
3
|
-
Version: 4.
|
|
3
|
+
Version: 4.5.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>
|
|
@@ -55,6 +55,33 @@ Types of testing:
|
|
|
55
55
|
* 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
56
|
* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
|
|
57
57
|
|
|
58
|
+
## Creating a New Project
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
npx projen new {project} --from projen-modules
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
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.
|
|
65
|
+
|
|
66
|
+
### Project Types
|
|
67
|
+
|
|
68
|
+
| Project type | Description |
|
|
69
|
+
| ---------------------------------------------- | -------------------------- |
|
|
70
|
+
| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
|
|
71
|
+
| [npm-package](API.md#npmpackage-) | A typescript npm package |
|
|
72
|
+
| [python-package](API.md#pythonpackage-) | A python package |
|
|
73
|
+
| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
|
|
74
|
+
|
|
75
|
+
## Project Structure
|
|
76
|
+
|
|
77
|
+
All source is located in `src` and is grouped by:
|
|
78
|
+
|
|
79
|
+
* `components` - these are common building blocks that can be used by projects to implement specific project functionality.
|
|
80
|
+
* `projects` - these are projects that can be built from this project (see #something)
|
|
81
|
+
* `utils` - these are helper functions that are often reused
|
|
82
|
+
|
|
83
|
+
`test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
|
|
84
|
+
|
|
58
85
|
## GitHub Configuration
|
|
59
86
|
|
|
60
87
|
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 +123,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
|
|
|
96
123
|
|
|
97
124
|
If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
|
|
98
125
|
|
|
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
126
|
## Known Issues
|
|
127
127
|
|
|
128
128
|
`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.
|
|
8
|
+
"version": "4.5.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.
|
|
29
|
+
"projen-modules@4.5.0.jsii.tgz"
|
|
30
30
|
],
|
|
31
31
|
"projen_modules": [
|
|
32
32
|
"py.typed"
|
|
@@ -28,6 +28,33 @@ Types of testing:
|
|
|
28
28
|
* 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
29
|
* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
|
|
30
30
|
|
|
31
|
+
## Creating a New Project
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
npx projen new {project} --from projen-modules
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
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.
|
|
38
|
+
|
|
39
|
+
### Project Types
|
|
40
|
+
|
|
41
|
+
| Project type | Description |
|
|
42
|
+
| ---------------------------------------------- | -------------------------- |
|
|
43
|
+
| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
|
|
44
|
+
| [npm-package](API.md#npmpackage-) | A typescript npm package |
|
|
45
|
+
| [python-package](API.md#pythonpackage-) | A python package |
|
|
46
|
+
| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
|
|
47
|
+
|
|
48
|
+
## Project Structure
|
|
49
|
+
|
|
50
|
+
All source is located in `src` and is grouped by:
|
|
51
|
+
|
|
52
|
+
* `components` - these are common building blocks that can be used by projects to implement specific project functionality.
|
|
53
|
+
* `projects` - these are projects that can be built from this project (see #something)
|
|
54
|
+
* `utils` - these are helper functions that are often reused
|
|
55
|
+
|
|
56
|
+
`test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
|
|
57
|
+
|
|
31
58
|
## GitHub Configuration
|
|
32
59
|
|
|
33
60
|
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 +96,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
|
|
|
69
96
|
|
|
70
97
|
If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
|
|
71
98
|
|
|
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
99
|
## Known Issues
|
|
100
100
|
|
|
101
101
|
`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 +158,47 @@ else:
|
|
|
158
158
|
_projen_typescript_04054675 = _LazyImport("projen.typescript")
|
|
159
159
|
|
|
160
160
|
|
|
161
|
+
@jsii.data_type(
|
|
162
|
+
jsii_type="projen-modules.AddSectionOptions",
|
|
163
|
+
jsii_struct_bases=[],
|
|
164
|
+
name_mapping={"order": "order"},
|
|
165
|
+
)
|
|
166
|
+
class AddSectionOptions:
|
|
167
|
+
def __init__(self, *, order: typing.Optional[jsii.Number] = None) -> None:
|
|
168
|
+
'''
|
|
169
|
+
: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
|
|
170
|
+
'''
|
|
171
|
+
if __debug__:
|
|
172
|
+
type_hints = cached_type_hints(_typecheckingstub__a1a00b07fa2976ebacf7edc4027139de9005bc000d25f7f70e4fa911a483ed1a)
|
|
173
|
+
check_type(argname="argument order", value=order, expected_type=type_hints["order"])
|
|
174
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
175
|
+
if order is not None:
|
|
176
|
+
self._values["order"] = order
|
|
177
|
+
|
|
178
|
+
@builtins.property
|
|
179
|
+
def order(self) -> typing.Optional[jsii.Number]:
|
|
180
|
+
'''Position of the section in the README, lowest first.
|
|
181
|
+
|
|
182
|
+
Sections with the
|
|
183
|
+
same order keep the order they were added in.
|
|
184
|
+
|
|
185
|
+
:default: - ``ReadmeOrder.DEFAULT``, or the existing order when replacing a section
|
|
186
|
+
'''
|
|
187
|
+
result = self._values.get("order")
|
|
188
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
|
189
|
+
|
|
190
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
191
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
192
|
+
|
|
193
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
194
|
+
return not (rhs == self)
|
|
195
|
+
|
|
196
|
+
def __repr__(self) -> str:
|
|
197
|
+
return "AddSectionOptions(%s)" % ", ".join(
|
|
198
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
199
|
+
)
|
|
200
|
+
|
|
201
|
+
|
|
161
202
|
class CdkTypeScriptApp(
|
|
162
203
|
_projen_awscdk_04054675.AwsCdkTypeScriptApp,
|
|
163
204
|
metaclass=jsii.JSIIMeta,
|
|
@@ -13205,17 +13246,52 @@ class Readme(
|
|
|
13205
13246
|
|
|
13206
13247
|
jsii.create(self.__class__, self, [project, options])
|
|
13207
13248
|
|
|
13208
|
-
@jsii.member(jsii_name="
|
|
13209
|
-
|
|
13249
|
+
@jsii.member(jsii_name="of")
|
|
13250
|
+
@builtins.classmethod
|
|
13251
|
+
def of(cls, project: "_projen_04054675.Project") -> typing.Optional["Readme"]:
|
|
13252
|
+
'''The README of a project, if it has one.
|
|
13253
|
+
|
|
13254
|
+
:param project: -
|
|
13210
13255
|
'''
|
|
13256
|
+
if __debug__:
|
|
13257
|
+
type_hints = cached_type_hints(_typecheckingstub__db6ba12d23cb270208fda8f0dd632a700456e3a838947896f5e10d812655589d)
|
|
13258
|
+
check_type(argname="argument project", value=project, expected_type=type_hints["project"])
|
|
13259
|
+
return typing.cast(typing.Optional["Readme"], jsii.sinvoke(cls, "of", [project]))
|
|
13260
|
+
|
|
13261
|
+
@jsii.member(jsii_name="addSection")
|
|
13262
|
+
def add_section(
|
|
13263
|
+
self,
|
|
13264
|
+
title: builtins.str,
|
|
13265
|
+
body: builtins.str,
|
|
13266
|
+
*,
|
|
13267
|
+
order: typing.Optional[jsii.Number] = None,
|
|
13268
|
+
) -> None:
|
|
13269
|
+
'''Adds a section, or replaces the section with the same title.
|
|
13270
|
+
|
|
13211
13271
|
:param title: -
|
|
13212
13272
|
:param body: -
|
|
13273
|
+
: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
|
|
13213
13274
|
'''
|
|
13214
13275
|
if __debug__:
|
|
13215
13276
|
type_hints = cached_type_hints(_typecheckingstub__ea72ea6648af1397d521aa4c3a3e8209831871f002cc5eed0118e644c221ff53)
|
|
13216
13277
|
check_type(argname="argument title", value=title, expected_type=type_hints["title"])
|
|
13217
13278
|
check_type(argname="argument body", value=body, expected_type=type_hints["body"])
|
|
13218
|
-
|
|
13279
|
+
options = AddSectionOptions(order=order)
|
|
13280
|
+
|
|
13281
|
+
return typing.cast(None, jsii.invoke(self, "addSection", [title, body, options]))
|
|
13282
|
+
|
|
13283
|
+
@jsii.member(jsii_name="removeSection")
|
|
13284
|
+
def remove_section(self, title: builtins.str) -> builtins.bool:
|
|
13285
|
+
'''Removes the section with the given title.
|
|
13286
|
+
|
|
13287
|
+
:param title: -
|
|
13288
|
+
|
|
13289
|
+
:return: whether a section was removed
|
|
13290
|
+
'''
|
|
13291
|
+
if __debug__:
|
|
13292
|
+
type_hints = cached_type_hints(_typecheckingstub__1d38666d73c9692382192c60852bdf18210d2625b68e6058263e24af9650787b)
|
|
13293
|
+
check_type(argname="argument title", value=title, expected_type=type_hints["title"])
|
|
13294
|
+
return typing.cast(builtins.bool, jsii.invoke(self, "removeSection", [title]))
|
|
13219
13295
|
|
|
13220
13296
|
@jsii.member(jsii_name="synthesizeContent")
|
|
13221
13297
|
def _synthesize_content(
|
|
@@ -13231,18 +13307,23 @@ class Readme(
|
|
|
13231
13307
|
check_type(argname="argument _", value=_, expected_type=type_hints["_"])
|
|
13232
13308
|
return typing.cast(typing.Optional[builtins.str], jsii.invoke(self, "synthesizeContent", [_]))
|
|
13233
13309
|
|
|
13310
|
+
@jsii.member(jsii_name="tryFindSection")
|
|
13311
|
+
def try_find_section(self, title: builtins.str) -> typing.Optional["Section"]:
|
|
13312
|
+
'''The section with the given title, if there is one.
|
|
13313
|
+
|
|
13314
|
+
:param title: -
|
|
13315
|
+
'''
|
|
13316
|
+
if __debug__:
|
|
13317
|
+
type_hints = cached_type_hints(_typecheckingstub__eafd715c84541234b32322144595b6390ec3cf300416610573240ce25fc63867)
|
|
13318
|
+
check_type(argname="argument title", value=title, expected_type=type_hints["title"])
|
|
13319
|
+
return typing.cast(typing.Optional["Section"], jsii.invoke(self, "tryFindSection", [title]))
|
|
13320
|
+
|
|
13234
13321
|
@builtins.property
|
|
13235
13322
|
@jsii.member(jsii_name="sections")
|
|
13236
13323
|
def sections(self) -> typing.List["Section"]:
|
|
13324
|
+
'''The sections, in the order they appear in the README.'''
|
|
13237
13325
|
return typing.cast(typing.List["Section"], jsii.get(self, "sections"))
|
|
13238
13326
|
|
|
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
13327
|
@builtins.property
|
|
13247
13328
|
@jsii.member(jsii_name="description")
|
|
13248
13329
|
def description(self) -> typing.Optional[builtins.str]:
|
|
@@ -13291,6 +13372,34 @@ class ReadmeOptions:
|
|
|
13291
13372
|
)
|
|
13292
13373
|
|
|
13293
13374
|
|
|
13375
|
+
class ReadmeOrder(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.ReadmeOrder"):
|
|
13376
|
+
'''Orders of the bands of sections in the README, leaving room for sections in between.'''
|
|
13377
|
+
|
|
13378
|
+
@jsii.python.classproperty
|
|
13379
|
+
@jsii.member(jsii_name="DEFAULT")
|
|
13380
|
+
def DEFAULT(cls) -> jsii.Number:
|
|
13381
|
+
'''Sections added without an order.'''
|
|
13382
|
+
return typing.cast(jsii.Number, jsii.sget(cls, "DEFAULT"))
|
|
13383
|
+
|
|
13384
|
+
@jsii.python.classproperty
|
|
13385
|
+
@jsii.member(jsii_name="INTRODUCTION")
|
|
13386
|
+
def INTRODUCTION(cls) -> jsii.Number:
|
|
13387
|
+
'''Sections a reader needs first, such as getting started.'''
|
|
13388
|
+
return typing.cast(jsii.Number, jsii.sget(cls, "INTRODUCTION"))
|
|
13389
|
+
|
|
13390
|
+
@jsii.python.classproperty
|
|
13391
|
+
@jsii.member(jsii_name="REFERENCE")
|
|
13392
|
+
def REFERENCE(cls) -> jsii.Number:
|
|
13393
|
+
'''Reference material, such as repository configuration and known issues.'''
|
|
13394
|
+
return typing.cast(jsii.Number, jsii.sget(cls, "REFERENCE"))
|
|
13395
|
+
|
|
13396
|
+
@jsii.python.classproperty
|
|
13397
|
+
@jsii.member(jsii_name="USAGE")
|
|
13398
|
+
def USAGE(cls) -> jsii.Number:
|
|
13399
|
+
'''How to use and operate the project.'''
|
|
13400
|
+
return typing.cast(jsii.Number, jsii.sget(cls, "USAGE"))
|
|
13401
|
+
|
|
13402
|
+
|
|
13294
13403
|
class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
|
|
13295
13404
|
def __init__(self, options: "ISectionOptions") -> None:
|
|
13296
13405
|
'''
|
|
@@ -13312,6 +13421,7 @@ class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
|
|
|
13312
13421
|
|
|
13313
13422
|
|
|
13314
13423
|
__all__ = [
|
|
13424
|
+
"AddSectionOptions",
|
|
13315
13425
|
"CdkTypeScriptApp",
|
|
13316
13426
|
"CdkTypeScriptAppOptions",
|
|
13317
13427
|
"DeploymentEnvironment",
|
|
@@ -13324,11 +13434,19 @@ __all__ = [
|
|
|
13324
13434
|
"PythonPackageOptions",
|
|
13325
13435
|
"Readme",
|
|
13326
13436
|
"ReadmeOptions",
|
|
13437
|
+
"ReadmeOrder",
|
|
13327
13438
|
"Section",
|
|
13328
13439
|
]
|
|
13329
13440
|
|
|
13330
13441
|
publication.publish()
|
|
13331
13442
|
|
|
13443
|
+
def _typecheckingstub__a1a00b07fa2976ebacf7edc4027139de9005bc000d25f7f70e4fa911a483ed1a(
|
|
13444
|
+
*,
|
|
13445
|
+
order: typing.Optional[jsii.Number] = None,
|
|
13446
|
+
) -> None:
|
|
13447
|
+
"""Type checking stubs"""
|
|
13448
|
+
pass
|
|
13449
|
+
|
|
13332
13450
|
def _typecheckingstub__a544530c4e440f72065d416ace5f306da46147589bc70a0f44ccba0553de9c78(
|
|
13333
13451
|
value: Readme,
|
|
13334
13452
|
) -> None:
|
|
@@ -13978,9 +14096,23 @@ def _typecheckingstub__5cc1200292e645dca3ec7cf2cbf9f2c41def9f24ed1dbb485999955eb
|
|
|
13978
14096
|
"""Type checking stubs"""
|
|
13979
14097
|
pass
|
|
13980
14098
|
|
|
14099
|
+
def _typecheckingstub__db6ba12d23cb270208fda8f0dd632a700456e3a838947896f5e10d812655589d(
|
|
14100
|
+
project: _projen_04054675.Project,
|
|
14101
|
+
) -> None:
|
|
14102
|
+
"""Type checking stubs"""
|
|
14103
|
+
pass
|
|
14104
|
+
|
|
13981
14105
|
def _typecheckingstub__ea72ea6648af1397d521aa4c3a3e8209831871f002cc5eed0118e644c221ff53(
|
|
13982
14106
|
title: builtins.str,
|
|
13983
14107
|
body: builtins.str,
|
|
14108
|
+
*,
|
|
14109
|
+
order: typing.Optional[jsii.Number] = None,
|
|
14110
|
+
) -> None:
|
|
14111
|
+
"""Type checking stubs"""
|
|
14112
|
+
pass
|
|
14113
|
+
|
|
14114
|
+
def _typecheckingstub__1d38666d73c9692382192c60852bdf18210d2625b68e6058263e24af9650787b(
|
|
14115
|
+
title: builtins.str,
|
|
13984
14116
|
) -> None:
|
|
13985
14117
|
"""Type checking stubs"""
|
|
13986
14118
|
pass
|
|
@@ -13991,8 +14123,8 @@ def _typecheckingstub__7f98643f5b00531165345da2ee730415f041f7d8dbd28b8b04ea939ba
|
|
|
13991
14123
|
"""Type checking stubs"""
|
|
13992
14124
|
pass
|
|
13993
14125
|
|
|
13994
|
-
def
|
|
13995
|
-
|
|
14126
|
+
def _typecheckingstub__eafd715c84541234b32322144595b6390ec3cf300416610573240ce25fc63867(
|
|
14127
|
+
title: builtins.str,
|
|
13996
14128
|
) -> None:
|
|
13997
14129
|
"""Type checking stubs"""
|
|
13998
14130
|
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.
|
|
21
|
+
"projen-modules", "4.5.0", __name__[0:-6], "projen-modules@4.5.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.
|
|
3
|
+
Version: 4.5.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>
|
|
@@ -55,6 +55,33 @@ Types of testing:
|
|
|
55
55
|
* 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
56
|
* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
|
|
57
57
|
|
|
58
|
+
## Creating a New Project
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
npx projen new {project} --from projen-modules
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
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.
|
|
65
|
+
|
|
66
|
+
### Project Types
|
|
67
|
+
|
|
68
|
+
| Project type | Description |
|
|
69
|
+
| ---------------------------------------------- | -------------------------- |
|
|
70
|
+
| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
|
|
71
|
+
| [npm-package](API.md#npmpackage-) | A typescript npm package |
|
|
72
|
+
| [python-package](API.md#pythonpackage-) | A python package |
|
|
73
|
+
| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
|
|
74
|
+
|
|
75
|
+
## Project Structure
|
|
76
|
+
|
|
77
|
+
All source is located in `src` and is grouped by:
|
|
78
|
+
|
|
79
|
+
* `components` - these are common building blocks that can be used by projects to implement specific project functionality.
|
|
80
|
+
* `projects` - these are projects that can be built from this project (see #something)
|
|
81
|
+
* `utils` - these are helper functions that are often reused
|
|
82
|
+
|
|
83
|
+
`test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
|
|
84
|
+
|
|
58
85
|
## GitHub Configuration
|
|
59
86
|
|
|
60
87
|
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 +123,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
|
|
|
96
123
|
|
|
97
124
|
If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
|
|
98
125
|
|
|
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
126
|
## Known Issues
|
|
127
127
|
|
|
128
128
|
`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.
|
|
14
|
+
src/projen_modules/_jsii/projen-modules@4.5.0.jsii.tgz
|
|
Binary file
|
|
File without changes
|
|
File without changes
|
|
@@ -27,6 +27,33 @@ Types of testing:
|
|
|
27
27
|
* 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
28
|
* Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
|
|
29
29
|
|
|
30
|
+
## Creating a New Project
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
npx projen new {project} --from projen-modules
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
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.
|
|
37
|
+
|
|
38
|
+
### Project Types
|
|
39
|
+
|
|
40
|
+
| Project type | Description |
|
|
41
|
+
| ---------------------------------------------- | -------------------------- |
|
|
42
|
+
| [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
|
|
43
|
+
| [npm-package](API.md#npmpackage-) | A typescript npm package |
|
|
44
|
+
| [python-package](API.md#pythonpackage-) | A python package |
|
|
45
|
+
| [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
|
|
46
|
+
|
|
47
|
+
## Project Structure
|
|
48
|
+
|
|
49
|
+
All source is located in `src` and is grouped by:
|
|
50
|
+
|
|
51
|
+
* `components` - these are common building blocks that can be used by projects to implement specific project functionality.
|
|
52
|
+
* `projects` - these are projects that can be built from this project (see #something)
|
|
53
|
+
* `utils` - these are helper functions that are often reused
|
|
54
|
+
|
|
55
|
+
`test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
|
|
56
|
+
|
|
30
57
|
## GitHub Configuration
|
|
31
58
|
|
|
32
59
|
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 +95,6 @@ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mer
|
|
|
68
95
|
|
|
69
96
|
If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
|
|
70
97
|
|
|
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
98
|
## Known Issues
|
|
99
99
|
|
|
100
100
|
`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:
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{projen_modules-4.4.0 → projen_modules-4.5.0}/src/projen_modules.egg-info/dependency_links.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|