projen-modules 4.6.0 → 5.0.1

package/.jsii

@@ -3746,50 +3746,6 @@
       ],
       "symbolId": "src/projects/cdk-ts/deployment-environment:DeploymentEnvironment"
     },
-    "projen-modules.ISectionOptions": {
-      "assembly": "projen-modules",
-      "docs": {
-        "stability": "stable"
-      },
-      "fqn": "projen-modules.ISectionOptions",
-      "kind": "interface",
-      "locationInModule": {
-        "filename": "src/components/readme/elements/section.ts",
-        "line": 1
-      },
-      "name": "ISectionOptions",
-      "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable"
-          },
-          "locationInModule": {
-            "filename": "src/components/readme/elements/section.ts",
-            "line": 3
-          },
-          "name": "body",
-          "type": {
-            "primitive": "string"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable"
-          },
-          "locationInModule": {
-            "filename": "src/components/readme/elements/section.ts",
-            "line": 2
-          },
-          "name": "title",
-          "type": {
-            "primitive": "string"
-          }
-        }
-      ],
-      "symbolId": "src/components/readme/elements/section:ISectionOptions"
-    },
     "projen-modules.JsiiProject": {
       "assembly": "projen-modules",
       "base": "projen.cdk.JsiiProject",
@@ -11761,13 +11717,13 @@
         },
         "locationInModule": {
           "filename": "src/components/readme/elements/section.ts",
-          "line": 8
+          "line": 14
         },
         "parameters": [
           {
             "name": "options",
             "type": {
-              "fqn": "projen-modules.ISectionOptions"
+              "fqn": "projen-modules.SectionOptions"
             }
           }
         ]
@@ -11775,7 +11731,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/components/readme/elements/section.ts",
-        "line": 6
+        "line": 12
       },
       "methods": [
         {
@@ -11784,7 +11740,7 @@
           },
           "locationInModule": {
             "filename": "src/components/readme/elements/section.ts",
-            "line": 11
+            "line": 17
           },
           "name": "synth",
           "returns": {
@@ -11803,17 +11759,66 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/readme/elements/section.ts",
-            "line": 7
+            "line": 13
           },
           "name": "options",
           "type": {
-            "fqn": "projen-modules.ISectionOptions"
+            "fqn": "projen-modules.SectionOptions"
           }
         }
       ],
       "symbolId": "src/components/readme/elements/section:Section"
+    },
+    "projen-modules.SectionOptions": {
+      "assembly": "projen-modules",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "projen-modules.SectionOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/readme/elements/section.ts",
+        "line": 1
+      },
+      "name": "SectionOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The markdown content of the section."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/readme/elements/section.ts",
+            "line": 9
+          },
+          "name": "body",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The heading of the section."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/readme/elements/section.ts",
+            "line": 5
+          },
+          "name": "title",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/components/readme/elements/section:SectionOptions"
     }
   },
-  "version": "4.6.0",
-  "fingerprint": "FPqrAwKcURWT1wMe1KftZZZlz1y+mQUCz0KxMFkGumg="
+  "version": "5.0.1",
+  "fingerprint": "SXXZ3uzye4b1NJX46EBbHeEx/lMibLV2RdphXr1hFeU="
 }

package/API.md

@@ -14655,6 +14655,49 @@ The description of the project.
 
 ---
 
+### SectionOptions <a name="SectionOptions" id="projen-modules.SectionOptions"></a>
+
+#### Initializer <a name="Initializer" id="projen-modules.SectionOptions.Initializer"></a>
+
+```typescript
+import { SectionOptions } from 'projen-modules'
+
+const sectionOptions: SectionOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#projen-modules.SectionOptions.property.body">body</a></code> | <code>string</code> | The markdown content of the section. |
+| <code><a href="#projen-modules.SectionOptions.property.title">title</a></code> | <code>string</code> | The heading of the section. |
+
+---
+
+##### `body`<sup>Required</sup> <a name="body" id="projen-modules.SectionOptions.property.body"></a>
+
+```typescript
+public readonly body: string;
+```
+
+- *Type:* string
+
+The markdown content of the section.
+
+---
+
+##### `title`<sup>Required</sup> <a name="title" id="projen-modules.SectionOptions.property.title"></a>
+
+```typescript
+public readonly title: string;
+```
+
+- *Type:* string
+
+The heading of the section.
+
+---
+
 ## Classes <a name="Classes" id="Classes"></a>
 
 ### ReadmeOrder <a name="ReadmeOrder" id="projen-modules.ReadmeOrder"></a>
@@ -14730,18 +14773,18 @@ How to use and operate the project.
 ```typescript
 import { Section } from 'projen-modules'
 
-new Section(options: ISectionOptions)
+new Section(options: SectionOptions)
 ```
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#projen-modules.Section.Initializer.parameter.options">options</a></code> | <code><a href="#projen-modules.ISectionOptions">ISectionOptions</a></code> | *No description.* |
+| <code><a href="#projen-modules.Section.Initializer.parameter.options">options</a></code> | <code><a href="#projen-modules.SectionOptions">SectionOptions</a></code> | *No description.* |
 
 ---
 
 ##### `options`<sup>Required</sup> <a name="options" id="projen-modules.Section.Initializer.parameter.options"></a>
 
-- *Type:* <a href="#projen-modules.ISectionOptions">ISectionOptions</a>
+- *Type:* <a href="#projen-modules.SectionOptions">SectionOptions</a>
 
 ---
 
@@ -14764,54 +14807,19 @@ public synth(): string
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#projen-modules.Section.property.options">options</a></code> | <code><a href="#projen-modules.ISectionOptions">ISectionOptions</a></code> | *No description.* |
+| <code><a href="#projen-modules.Section.property.options">options</a></code> | <code><a href="#projen-modules.SectionOptions">SectionOptions</a></code> | *No description.* |
 
 ---
 
 ##### `options`<sup>Required</sup> <a name="options" id="projen-modules.Section.property.options"></a>
 
 ```typescript
-public readonly options: ISectionOptions;
-```
-
-- *Type:* <a href="#projen-modules.ISectionOptions">ISectionOptions</a>
-
----
-
-
-## Protocols <a name="Protocols" id="Protocols"></a>
-
-### ISectionOptions <a name="ISectionOptions" id="projen-modules.ISectionOptions"></a>
-
-- *Implemented By:* <a href="#projen-modules.ISectionOptions">ISectionOptions</a>
-
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#projen-modules.ISectionOptions.property.body">body</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#projen-modules.ISectionOptions.property.title">title</a></code> | <code>string</code> | *No description.* |
-
----
-
-##### `body`<sup>Required</sup> <a name="body" id="projen-modules.ISectionOptions.property.body"></a>
-
-```typescript
-public readonly body: string;
+public readonly options: SectionOptions;
 ```
 
-- *Type:* string
+- *Type:* <a href="#projen-modules.SectionOptions">SectionOptions</a>
 
 ---
 
-##### `title`<sup>Required</sup> <a name="title" id="projen-modules.ISectionOptions.property.title"></a>
 
-```typescript
-public readonly title: string;
-```
-
-- *Type:* string
-
----
 

package/lib/components/readme/elements/section.d.ts

@@ -1,9 +1,15 @@
-export interface ISectionOptions {
-    title: string;
-    body: string;
+export interface SectionOptions {
+    /**
+     * The heading of the section
+     */
+    readonly title: string;
+    /**
+     * The markdown content of the section
+     */
+    readonly body: string;
 }
 export declare class Section {
-    readonly options: ISectionOptions;
-    constructor(options: ISectionOptions);
+    readonly options: SectionOptions;
+    constructor(options: SectionOptions);
     synth(): string;
 }

package/lib/components/readme/elements/section.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Section = void 0;
 const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
 class Section {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.Section", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.Section", version: "5.0.1" };
     options;
     constructor(options) {
         this.options = options;
@@ -15,4 +15,4 @@ ${this.options.body}`;
     }
 }
 exports.Section = Section;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb21wb25lbnRzL3JlYWRtZS9lbGVtZW50cy9zZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFLQSxNQUFhLE9BQU87O0lBQ1QsT0FBTyxDQUFrQjtJQUNsQyxZQUFZLE9BQXdCO1FBQ2xDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFDRCxLQUFLO1FBQ0gsT0FBTyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSzs7RUFFakMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNwQixDQUFDOztBQVRILDBCQVVDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBJU2VjdGlvbk9wdGlvbnMge1xuICB0aXRsZTogc3RyaW5nO1xuICBib2R5OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBjbGFzcyBTZWN0aW9uIHtcbiAgcmVhZG9ubHkgb3B0aW9uczogSVNlY3Rpb25PcHRpb25zO1xuICBjb25zdHJ1Y3RvcihvcHRpb25zOiBJU2VjdGlvbk9wdGlvbnMpIHtcbiAgICB0aGlzLm9wdGlvbnMgPSBvcHRpb25zO1xuICB9XG4gIHN5bnRoKCkge1xuICAgIHJldHVybiBgIyMgJHt0aGlzLm9wdGlvbnMudGl0bGV9XG5cbiR7dGhpcy5vcHRpb25zLmJvZHl9YDtcbiAgfVxufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb21wb25lbnRzL3JlYWRtZS9lbGVtZW50cy9zZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFXQSxNQUFhLE9BQU87O0lBQ1QsT0FBTyxDQUFpQjtJQUNqQyxZQUFZLE9BQXVCO1FBQ2pDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFDRCxLQUFLO1FBQ0gsT0FBTyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSzs7RUFFakMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNwQixDQUFDOztBQVRILDBCQVVDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBTZWN0aW9uT3B0aW9ucyB7XG4gIC8qKlxuICAgKiBUaGUgaGVhZGluZyBvZiB0aGUgc2VjdGlvblxuICAgKi9cbiAgcmVhZG9ubHkgdGl0bGU6IHN0cmluZztcbiAgLyoqXG4gICAqIFRoZSBtYXJrZG93biBjb250ZW50IG9mIHRoZSBzZWN0aW9uXG4gICAqL1xuICByZWFkb25seSBib2R5OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBjbGFzcyBTZWN0aW9uIHtcbiAgcmVhZG9ubHkgb3B0aW9uczogU2VjdGlvbk9wdGlvbnM7XG4gIGNvbnN0cnVjdG9yKG9wdGlvbnM6IFNlY3Rpb25PcHRpb25zKSB7XG4gICAgdGhpcy5vcHRpb25zID0gb3B0aW9ucztcbiAgfVxuICBzeW50aCgpIHtcbiAgICByZXR1cm4gYCMjICR7dGhpcy5vcHRpb25zLnRpdGxlfVxuXG4ke3RoaXMub3B0aW9ucy5ib2R5fWA7XG4gIH1cbn1cbiJdfQ==

package/lib/components/readme/index.js

@@ -9,7 +9,7 @@ const section_1 = require("./elements/section");
  * in between
  */
 class ReadmeOrder {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.ReadmeOrder", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.ReadmeOrder", version: "5.0.1" };
     /**
      * Sections a reader needs first, such as getting started
      */
@@ -30,7 +30,7 @@ class ReadmeOrder {
 }
 exports.ReadmeOrder = ReadmeOrder;
 class Readme extends projen_1.FileBase {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.Readme", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.Readme", version: "5.0.1" };
     /**
      * The README of a project, if it has one
      */

package/lib/projects/cdk-ts/index.js

@@ -61,7 +61,7 @@ function getOptions(options) {
  * @pjid cdk-typescript-app
  */
 class CdkTypeScriptApp extends awscdk_1.AwsCdkTypeScriptApp {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.CdkTypeScriptApp", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.CdkTypeScriptApp", version: "5.0.1" };
     readme;
     constructor(options) {
         const mergedOptions = getOptions(options);

package/lib/projects/jsii/index.js

@@ -48,7 +48,7 @@ function getOptions(options) {
  * @pjid jsii-project
  */
 class JsiiProject extends projen_1.cdk.JsiiProject {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.JsiiProject", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.JsiiProject", version: "5.0.1" };
     readme;
     constructor(options) {
         const mergedOptions = getOptions(options);

package/lib/projects/npm/index.js

@@ -47,7 +47,7 @@ function getOptions(options) {
  * @pjid npm-package
  */
 class NpmPackage extends projen_1.typescript.TypeScriptProject {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.NpmPackage", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.NpmPackage", version: "5.0.1" };
     readme;
     constructor(options) {
         const mergedOptions = getOptions(options);

package/lib/projects/python/index.js

@@ -43,7 +43,7 @@ function getOptions(options) {
  * @pjid python-package
  */
 class PythonPackage extends python_1.PythonProject {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.PythonPackage", version: "4.6.0" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen-modules.PythonPackage", version: "5.0.1" };
     autoMerge;
     readme;
     constructor(options) {

package/package.json

@@ -83,7 +83,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "4.6.0",
+  "version": "5.0.1",
   "jest": {
     "coverageProvider": "v8",
     "testMatch": [