Add experimental typeScopedContexts flag

Author: rubensworks

README.md

@@ -101,6 +101,9 @@ Usage:
        -e jsonld               Extension for components files (without .), defaults to 'jsonld'
        -i ignore-classes.json  Relative path to an optional file with class names to ignore
        --help                  Show information about this command
+
+  Experimental options:
+       --typeScopedContexts    If a type-scoped context for each component is to be generated with parameter name aliases
 ```
 
 **Note:** This generator will read `.d.ts` files,

bin/componentsjs-generator.ts

@@ -17,6 +17,9 @@ Usage:
        -i ignore-classes.json  Relative path to an optional file with class names to ignore
        -l info                 The logger level
        --help                  Show information about this command
+
+  Experimental options:
+       --typeScopedContexts    If a type-scoped context for each component is to be generated with parameter name aliases
 `);
   process.exit(1);
 }
@@ -34,6 +37,7 @@ if (args.help) {
       replacementPath: Path.posix.join(packageRootDirectory, args.c || 'components'),
     },
     fileExtension: args.e || 'jsonld',
+    typeScopedContexts: args.typeScopedContexts,
     logLevel: args.l || 'info',
     ignoreClasses: args.i ?
       // eslint-disable-next-line no-sync

lib/generate/Generator.ts

@@ -22,13 +22,15 @@ export class Generator {
   private readonly pathDestination: PathDestinationDefinition;
   private readonly fileExtension: string;
   private readonly ignoreClasses: Record<string, boolean>;
+  private readonly typeScopedContexts: boolean;
   private readonly logLevel: LogLevel;
 
   public constructor(args: GeneratorArgs) {
     this.resolutionContext = args.resolutionContext;
     this.pathDestination = args.pathDestination;
     this.fileExtension = args.fileExtension;
     this.ignoreClasses = args.ignoreClasses;
+    this.typeScopedContexts = args.typeScopedContexts;
     this.logLevel = args.logLevel;
   }
 
@@ -51,7 +53,10 @@ export class Generator {
       .resolveAllConstructorParameters(constructorsUnresolved, classIndex);
 
     // Create components
-    const contextConstructor = new ContextConstructor({ packageMetadata });
+    const contextConstructor = new ContextConstructor({
+      packageMetadata,
+      typeScopedContexts: this.typeScopedContexts,
+    });
     const componentConstructor = new ComponentConstructor({
       packageMetadata,
       contextConstructor,
@@ -89,5 +94,6 @@ export interface GeneratorArgs {
   pathDestination: PathDestinationDefinition;
   fileExtension: string;
   ignoreClasses: Record<string, boolean>;
+  typeScopedContexts: boolean;
   logLevel: LogLevel;
 }

lib/serialize/ContextConstructor.ts

@@ -8,9 +8,11 @@ import type { ComponentDefinitions } from './ComponentDefinitions';
  */
 export class ContextConstructor {
   private readonly packageMetadata: PackageMetadata;
+  private readonly typeScopedContexts: boolean;
 
-  public constructor(args: ContextSerializerArgs) {
+  public constructor(args: ContextConstructorArgs) {
     this.packageMetadata = args.packageMetadata;
+    this.typeScopedContexts = args.typeScopedContexts;
   }
 
   /**
@@ -65,14 +67,24 @@ export class ContextConstructor {
           '@id': component['@id'],
           '@prefix': true,
         };
+
+        // Generate type-scoped context when enabled
+        if (this.typeScopedContexts) {
+          const typeScopedContext: Record<string, string> = {};
+          for (const parameter of component.parameters) {
+            typeScopedContext[parameter['@id'].slice(Math.max(0, component['@id'].length + 1))] = parameter['@id'];
+          }
+          (<any> shortcuts[match[0]])['@context'] = typeScopedContext;
+        }
       }
     }
     return shortcuts;
   }
 }
 
-export interface ContextSerializerArgs {
+export interface ContextConstructorArgs {
   packageMetadata: PackageMetadata;
+  typeScopedContexts: boolean;
 }
 
 export interface ContextRaw {

test/serialize/ComponentConstructor.test.ts

@@ -33,7 +33,7 @@ describe('ComponentConstructor', () => {
       },
       typesPath: '',
     };
-    const contextConstructor = new ContextConstructorMocked({ packageMetadata });
+    const contextConstructor = new ContextConstructorMocked({ packageMetadata, typeScopedContexts: false });
     ctor = new ComponentConstructor({
       packageMetadata,
       contextConstructor,

test/serialize/ContextConstructor.test.ts

@@ -1,19 +1,23 @@
+import type { PackageMetadata } from '../../lib/parse/PackageMetadataLoader';
 import { ContextConstructor } from '../../lib/serialize/ContextConstructor';
 
 describe('ContextConstructor', () => {
   let ctor: ContextConstructor;
+  let packageMetadata: PackageMetadata;
 
   beforeEach(async() => {
+    packageMetadata = {
+      name: 'my-package',
+      version: '2.3.4',
+      moduleIri: 'https://linkedsoftwaredependencies.org/bundles/npm/my-package/',
+      componentsPath: 'components',
+      contexts: {},
+      importPaths: {},
+      typesPath: '',
+    };
     ctor = new ContextConstructor({
-      packageMetadata: {
-        name: 'my-package',
-        version: '2.3.4',
-        moduleIri: 'https://linkedsoftwaredependencies.org/bundles/npm/my-package/',
-        componentsPath: 'components',
-        contexts: {},
-        importPaths: {},
-        typesPath: '',
-      },
+      packageMetadata,
+      typeScopedContexts: false,
     });
   });
 
@@ -150,5 +154,65 @@ describe('ContextConstructor', () => {
         },
       });
     });
+
+    it('should handle non-empty component definitions when typeScopedContexts is true', () => {
+      ctor = new ContextConstructor({
+        packageMetadata,
+        typeScopedContexts: true,
+      });
+      expect(ctor.constructComponentShortcuts({
+        '/docs/package/components/file1': {
+          '@context': [
+            'https://linkedsoftwaredependencies.org/bundles/npm/my-package/context.jsonld',
+          ],
+          '@id': 'npmd:my-package',
+          components: [
+            {
+              '@id': 'mp:file1#MyClass1',
+              '@type': 'Class',
+              constructorArguments: [],
+              parameters: [
+                {
+                  '@id': 'mp:file1#MyClass1_param1',
+                },
+                {
+                  '@id': 'mp:file1#MyClass1_param2',
+                },
+              ],
+              requireElement: 'MyClass1',
+            },
+          ],
+        },
+        '/docs/package/components/b/file2': {
+          '@context': [
+            'https://linkedsoftwaredependencies.org/bundles/npm/my-package/context.jsonld',
+          ],
+          '@id': 'npmd:my-package',
+          components: [
+            {
+              '@id': 'mp:b/file2#MyClass2',
+              '@type': 'Class',
+              requireElement: 'MyClass2',
+              constructorArguments: [],
+              parameters: [],
+            },
+          ],
+        },
+      })).toEqual({
+        MyClass1: {
+          '@id': 'mp:file1#MyClass1',
+          '@prefix': true,
+          '@context': {
+            param1: 'mp:file1#MyClass1_param1',
+            param2: 'mp:file1#MyClass1_param2',
+          },
+        },
+        MyClass2: {
+          '@id': 'mp:b/file2#MyClass2',
+          '@prefix': true,
+          '@context': {},
+        },
+      });
+    });
   });
 });