Add required behaviors to behavior headers (#951)

Author: D8H

scripts/generate-extensions-registry.js

@@ -15,6 +15,8 @@ const args = require('minimist')(process.argv.slice(2));
 /** @typedef {import('./types').ExtensionHeader} ExtensionHeader */
 /** @typedef {import('./types').ExtensionWithFileInfo} ExtensionWithFileInfo */
 /** @typedef {import('./types').ExtensionTier} ExtensionTier */
+/** @typedef {import('./types').Extension} Extension */
+/** @typedef {import('./types').EventsBasedBehavior} EventsBasedBehavior */
 
 const extensionsBasePath = path.join(__dirname, '..', 'extensions');
 const reviewedExtensionsTier = 'reviewed';
@@ -78,6 +80,50 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
   );
 };
 
+/**
+ * Find all required behaviors including transitive ones.
+ * @param {Extension} extension
+ * @param {EventsBasedBehavior} behavior
+ * @param {Array<string>} requiredBehaviorTypes
+ */
+const findAllRequiredBehaviorTypes = (
+  extension,
+  behavior,
+  requiredBehaviorTypes = []
+) => {
+  for (const propertyDescriptor of behavior.propertyDescriptors) {
+    if (propertyDescriptor.type == 'Behavior') {
+      const requiredBehaviorType = propertyDescriptor.extraInformation[0];
+      const extensionPrefix = extension.name + '::';
+      if (!requiredBehaviorTypes.includes(requiredBehaviorType)) {
+        requiredBehaviorTypes.push(requiredBehaviorType);
+
+        if (requiredBehaviorType.startsWith(extensionPrefix)) {
+          const behaviorName = requiredBehaviorType.substring(
+            extensionPrefix.length
+          );
+          const requiredBehavior = extension.eventsBasedBehaviors.find(
+            (behavior) => behavior.name === behaviorName
+          );
+          if (!requiredBehavior) {
+            throw new Error(
+              'Required behavior: ' +
+                requiredBehaviorTypes +
+                ' is missing in the extension.'
+            );
+          }
+          findAllRequiredBehaviorTypes(
+            extension,
+            requiredBehavior,
+            requiredBehaviorTypes
+          );
+        }
+      }
+    }
+  }
+  return requiredBehaviorTypes;
+};
+
 (async () => {
   try {
     shell.mkdir('-p', distBasePath);
@@ -217,6 +263,10 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
                     fullName: behavior.fullName,
                     description: behavior.description,
                     objectType: behavior.objectType,
+                    allRequiredBehaviorTypes: findAllRequiredBehaviorTypes(
+                      extension,
+                      behavior
+                    ),
                   }
             )
             .filter(Boolean)

scripts/lib/rules/DotsInSentences.js

@@ -1,6 +1,6 @@
 /** @typedef {import("../../types").Extension} Extension */
 /** @typedef {import("../../types").EventsFunction} EventsFunction */
-/** @typedef {import("../../types").EventsBasedBehaviors} EventsBasedBehaviors */
+/** @typedef {import("../../types").EventsBasedBehavior} EventsBasedBehaviors */
 /** @typedef {import("../../types").Parameter} Parameter */
 /** @typedef {import("./rule").ErrorLogger} ErrorLogger */
 

scripts/lib/rules/FilledOutDescriptions.js

@@ -1,6 +1,6 @@
 /** @typedef {import("../../types").Extension} Extension */
 /** @typedef {import("../../types").EventsFunction} EventsFunction */
-/** @typedef {import("../../types").EventsBasedBehaviors} EventsBasedBehaviors */
+/** @typedef {import("../../types").EventsBasedBehavior} EventsBasedBehaviors */
 /** @typedef {import("../../types").EventsBasedObjects} EventsBasedObjects */
 /** @typedef {import("../../types").Parameter} Parameter */
 

scripts/types.d.ts

@@ -52,6 +52,10 @@ export interface BehaviorShortHeader
   extends RegistryItem,
     BehaviorAndShortHeaderFields {
   extensionName: string;
+  /**
+   * All required behaviors including transitive ones.
+   */
+  allRequiredBehaviorTypes: Array<string>;
 }
 
 interface ObjectAndShortHeaderFields {
@@ -148,13 +152,19 @@ export interface EventsFunction {
   objectGroups: string[];
 }
 
-export interface EventsBasedBehaviors {
+export interface PropertyDescriptor {
+  type: 'Number' | 'String' | 'Boolean' | 'Choice' | 'Color' | 'Behavior';
+  extraInformation: string[];
+}
+
+export interface EventsBasedBehavior {
   description: string;
   fullName: string;
   name: string;
   objectType: string;
   private?: boolean;
   eventsFunctions: EventsFunction[];
+  propertyDescriptors: PropertyDescriptor[];
 }
 
 export interface EventsBasedObjects {
@@ -170,7 +180,7 @@ export interface Extension
     ExtensionAndHeaderFields {
   tags: string | string[];
   eventsFunctions: EventsFunction[];
-  eventsBasedBehaviors: EventsBasedBehaviors[];
+  eventsBasedBehaviors: EventsBasedBehavior[];
   eventsBasedObjects?: EventsBasedObjects[];
 }