support plugins with dots in their npm scope (#3687)

gtalusan · web-flow · commit 59e08934806b · 2024-09-01T16:15:40.000+01:00
diff --git a/src/pluginManager.spec.ts b/src/pluginManager.spec.ts
@@ -9,6 +9,10 @@ describe("PluginManager", () => {
     it("should match scoped plugin names", () => {
       expect(PluginManager.isQualifiedPluginIdentifier("@organisation/homebridge-dummy-plugin")).toBeTruthy();
     });
+
+    it("should match scoped plugin names with dots", () => {
+      expect(PluginManager.isQualifiedPluginIdentifier("@organisation.com/homebridge-dummy-plugin")).toBeTruthy();
+    });
   });
 
   describe("PluginManager.extractPluginName", () => {
@@ -19,6 +23,10 @@ describe("PluginManager", () => {
     it("should extract scoped plugin names", function() {
       expect(PluginManager.extractPluginName("@organisation/homebridge-dummy-plugin")).toBe("homebridge-dummy-plugin");
     });
+
+    it("should extract scoped plugin names with scopes with dots in their name", function() {
+      expect(PluginManager.extractPluginName("@organisation.com/homebridge-dummy-plugin")).toBe("homebridge-dummy-plugin");
+    });
   });
 
   describe("PluginManager.extractPluginScope", () => {
@@ -29,6 +37,10 @@ describe("PluginManager", () => {
     it("should extract scope for scoped plugin names", function() {
       expect(PluginManager.extractPluginScope("@organisation/homebridge-dummy-plugin")).toBe("@organisation");
     });
+
+    it("should extract scope for scoped plugin names with dots in their name", function() {
+      expect(PluginManager.extractPluginScope("@organisation.com/homebridge-dummy-plugin")).toBe("@organisation.com");
+    });
   });
 
   describe("...Name", () => {
diff --git a/src/pluginManager.ts b/src/pluginManager.ts
@@ -64,7 +64,7 @@ export interface PluginManagerOptions {
 export class PluginManager {
 
   // name must be prefixed with 'homebridge-' or '@scope/homebridge-'
-  private static readonly PLUGIN_IDENTIFIER_PATTERN = /^((@[\w-]*)\/)?(homebridge-[\w-]*)$/;
+  private static readonly PLUGIN_IDENTIFIER_PATTERN = /^((@[\w-]+(\.[\w-]+)*)\/)?(homebridge-[\w-]+)$/;
 
   private readonly api: HomebridgeAPI;
 
@@ -104,7 +104,7 @@ export class PluginManager {
   }
 
   public static extractPluginName(name: string): PluginName { // extract plugin name without @scope/ prefix
-    return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)![3];
+    return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)![4];
   }
 
   public static extractPluginScope(name: string): string { // extract the "@scope" of a npm module name

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ export interface PluginManagerOptions {`
`64`	`64`	`export class PluginManager {`
`65`	`65`
`66`	`66`	`// name must be prefixed with 'homebridge-' or '@scope/homebridge-'`
`67`		`- private static readonly PLUGIN_IDENTIFIER_PATTERN = /^((@[\w-])\/)?(homebridge-[\w-])$/;`
	`67`	`+ private static readonly PLUGIN_IDENTIFIER_PATTERN = /^((@[\w-]+(\.[\w-]+)*)\/)?(homebridge-[\w-]+)$/;`
`68`	`68`
`69`	`69`	`private readonly api: HomebridgeAPI;`
`70`	`70`
`@@ -104,7 +104,7 @@ export class PluginManager {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`public static extractPluginName(name: string): PluginName { // extract plugin name without @scope/ prefix`
`107`		`- return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)![3];`
	`107`	`+ return name.match(PluginManager.PLUGIN_IDENTIFIER_PATTERN)![4];`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`public static extractPluginScope(name: string): string { // extract the "@scope" of a npm module name`