Add CLI parameter to set prefix of package

Author: pheyvaer

.DS_Store

@@ -100,6 +100,7 @@ Usage:
        -c components           Relative path to directory that will contain components files, defaults to 'components'
        -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
+       -r prefix               Optional custom JSON-LD module prefix
        --help                  Show information about this command
 
   Experimental options:

README.md

@@ -16,6 +16,7 @@ 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
        -l info                 The logger level
+       -r prefix               Optional custom JSON-LD module prefix
        --help                  Show information about this command
 
   Experimental options:
@@ -39,6 +40,7 @@ if (args.help) {
     fileExtension: args.e || 'jsonld',
     typeScopedContexts: args.typeScopedContexts,
     logLevel: args.l || 'info',
+    prefix: args.r,
     ignoreClasses: args.i ?
       // eslint-disable-next-line no-sync
       JSON.parse(fs.readFileSync(args.i, 'utf8')).reduce((acc: Record<string, boolean>, entry: string) => {

bin/componentsjs-generator.ts

@@ -25,6 +25,7 @@ export class Generator {
   private readonly ignoreClasses: Record<string, boolean>;
   private readonly typeScopedContexts: boolean;
   private readonly logLevel: LogLevel;
+  private readonly prefix?: string;
 
   public constructor(args: GeneratorArgs) {
     this.resolutionContext = args.resolutionContext;
@@ -33,13 +34,15 @@ export class Generator {
     this.ignoreClasses = args.ignoreClasses;
     this.typeScopedContexts = args.typeScopedContexts;
     this.logLevel = args.logLevel;
+    this.prefix = args.prefix;
   }
 
   public async generateComponents(): Promise<void> {
     const logger = ComponentsManagerBuilder.createLogger(this.logLevel);
 
     // Load package metadata
-    const packageMetadata = await new PackageMetadataLoader({ resolutionContext: this.resolutionContext })
+    const packageMetadata = await new PackageMetadataLoader({ resolutionContext: this.resolutionContext,
+      prefix: this.prefix })
       .load(this.pathDestination.packageRootDirectory);
 
     const classLoader = new ClassLoader({ resolutionContext: this.resolutionContext, logger });
@@ -110,4 +113,5 @@ export interface GeneratorArgs {
   ignoreClasses: Record<string, boolean>;
   typeScopedContexts: boolean;
   logLevel: LogLevel;
+  prefix?: string;
 }

lib/generate/Generator.ts

@@ -7,9 +7,11 @@ import type { ResolutionContext } from '../resolution/ResolutionContext';
  */
 export class PackageMetadataLoader {
   private readonly resolutionContext: ResolutionContext;
+  private readonly prefix?: string;
 
   public constructor(args: PackageMetadataLoaderArgs) {
     this.resolutionContext = args.resolutionContext;
+    this.prefix = args.prefix;
   }
 
   /**
@@ -78,12 +80,14 @@ export class PackageMetadataLoader {
       contexts,
       importPaths,
       typesPath,
+      prefix: this.prefix,
     };
   }
 }
 
 export interface PackageMetadataLoaderArgs {
   resolutionContext: ResolutionContext;
+  prefix?: string;
 }
 
 export interface PackageMetadata {
@@ -94,4 +98,5 @@ export interface PackageMetadata {
   contexts: Record<string, string>;
   importPaths: Record<string, string>;
   typesPath: string;
+  prefix?: string;
 }

lib/parse/PackageMetadataLoader.ts

@@ -34,7 +34,7 @@ export class ContextConstructor {
    */
   public constructContext(components?: ComponentDefinitions): ContextRaw {
     // Determine a compact prefix to represent this package.
-    const prefix = ContextConstructor.getPackageNamePrefix(this.packageMetadata.name);
+    const prefix = this.packageMetadata.prefix ?? ContextConstructor.getPackageNamePrefix(this.packageMetadata.name);
 
     // Determine component shortcuts if provided.
     const componentShortcuts = components ? this.constructComponentShortcuts(components) : {};