Add typings for configurations (#498)

Add missing configurations property to plugin metadata type
godaddy · Dec 20, 2022 · b863c14 · b863c14
1 parent d522a59
commit b863c14
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/packages/gasket-plugin-metadata/CHANGELOG.md b/packages/gasket-plugin-metadata/CHANGELOG.md
@@ -1,5 +1,7 @@
 # `@gasket/plugin-metadata`
 
+- Add missing `configurations` property to plugin metadata type
+
 ### 6.35.0
 
 - Fix package object type ([#489])

diff --git a/packages/gasket-plugin-metadata/lib/index.d.ts b/packages/gasket-plugin-metadata/lib/index.d.ts
@@ -40,6 +40,9 @@ export interface PluginData extends ModuleData {
   /** App files and directories used by plugin */
   structures?: Array<DetailData>,
 
+  /** Configuration options for gasket.config.js */
+  configurations?: Array<DetailData & { type: 'object' }>
+
   /** Description of lifecycles invoked by plugin */
   lifecycles?: Array<LifecycleData>,
 

diff --git a/packages/gasket-typescript-tests/test/plugin-metadata.spec.ts b/packages/gasket-typescript-tests/test/plugin-metadata.spec.ts
@@ -23,8 +23,8 @@ describe('@gasket/plugin-metadata', () => {
     });
   });
 
-  it('adds a manifest property to Gasket', () => {
-    const metadata: SlimGasket = {
+  it('adds a metadata property to Gasket', () => {
+    const gasket1: SlimGasket = {
       metadata: {
         app: {
           name: 'example',
@@ -34,13 +34,26 @@ describe('@gasket/plugin-metadata', () => {
             name: 'example'
           }
         },
-        plugins: [],
+        plugins: [
+          {
+            module: {},
+            name: '@mock/gasket-plugin-x',
+            configurations: [
+              {
+                name: 'configX',
+                description: 'Configures the X plugin',
+                type: 'object',
+                link: 'https://some.docs.url/'
+              }
+            ]
+          }
+        ],
         presets: [],
         modules: []
       }
     };
 
-    const metadata2: SlimGasket = {
+    const gasket2: SlimGasket = {
       metadata: {
         app: {
           name: 'example',