fix: Add support for package json scripts

udemy · Sep 30, 2024 · f918ec4 · f918ec4
1 parent d4163bc
commit f918ec4
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -8,10 +8,12 @@ Stencil modules can be a native and/or template module.  A native module is one
 
 In the `arguments` section of the `manifest.yaml` file, you can specify the following options:
 
-| Option               | Default         | Description                                                    |
-| -------------------- | --------------- | -------------------------------------------------------------- |
-| `description`        | Required        | Friendly-but-short description string for the frontend app     |
-| `owner`              | Required        | Pod or Portfolio ID for the owner of the frontend app          |
-| `nativeModule`       | `false`         | Does this module include native module golang code             |
-| `templateModule`     | `false`         | Does this module include templated code                        |
-| `buildAndTestRunner` | `ubuntu-latest` | The github actions runner to use for the build and test CI job |
+| Option               | Default         | Description                                                                    |
+| -------------------- | --------------- | ------------------------------------------------------------------------------ |
+| `description`        | Required        | Friendly-but-short description string for the frontend app                     |
+| `owner`              | Required        | Pod or Portfolio ID for the owner of the frontend app                          |
+| `nativeModule`       | `false`         | Does this module include native module golang code                             |
+| `templateModule`     | `false`         | Does this module include templated code                                        |
+| `buildAndTestRunner` | `ubuntu-latest` | The github actions runner to use for the build and test CI job                 |
+| `packageJsonDeps`    | `{}`            | package.json dependencies to add to the generated package.json (key/value map) |
+| `packageJsonScripts` | `{}`            | package.json scripts to add to the generated package.json (key/value map)      |
diff --git a/manifest.yaml b/manifest.yaml
@@ -38,7 +38,10 @@ arguments:
       type: string
   packageJsonDeps:
     required: false
-    description: The package.json dependencies to add to the generated package.json
+    description: package.json dependencies to add to the generated package.json (key/value map)
+  packageJsonScripts:
+    required: false
+    description: package.json scripts to add to the generated package.json (key/value map)
   ## <</Stencil::Block>>
 modules:
   - name: github.com/udemy/eng-team-management

diff --git a/templates/package.json.tpl b/templates/package.json.tpl
@@ -1,5 +1,18 @@
 {
   "name": "{{ .Config.Name }}",
+{{- if (stencil.Arg "packageJsonScripts") }}
+  "scripts": {
+{{- $len := len (stencil.Arg "packageJsonScripts") }}
+{{- range $key, $value := (stencil.Arg "packageJsonScripts") }}
+  {{- $len = (add $len -1) }}
+  {{- if ne 0 $len }}
+    "{{ $key }}": {{ $value | printf "%q" }},
+  {{- else }}
+    "{{ $key }}": {{ $value | printf "%q" }}
+  {{- end }}
+{{- end }}
+  },
+{{- end }}
   "devDependencies": {
 {{- range $key, $value := (stencil.Arg "packageJsonDeps") }}
     "{{ $key }}": "{{ $value }}",

diff --git a/tests/template/stencil.yaml b/tests/template/stencil.yaml
@@ -4,6 +4,9 @@ arguments:
   description: Test template module for validating changes to stencil-module-base
   owner: platform
   templateModule: true
+  packageJsonScripts:
+    build: echo "build"
+    test: echo "test"
 modules:
   - name: github.com/udemy/stencil-module-base
 replacements: