filter parameter becomes a regex

Author: Damien Guerin

README.md

@@ -125,8 +125,8 @@ Global Options
 
   -c, --config string                Configuration file in JSON or YAML format where specifications are defined, default
                                      is config.json
-  -f, --filter string                Manage only one specification defined by its name (`api.info.title`) rather use the
-                                     whole of enabled specifications declared
+  -f, --filter string                Manage some specifications defined by its name (`api.info.title`) and which match
+                                     with this regex filter rather use the whole of enabled specifications declared
                                      into configuration file
   -v, --verbose                      Verbose mode, default is false
   -a, --urlDownloadTemplate string   Rather to use specs from local FS, you can specify remote specs (using 'artifact'
@@ -177,8 +177,8 @@ Global Options
 
   -c, --config string                Configuration file in JSON or YAML format where specifications are defined, default
                                      is config.json
-  -f, --filter string                Manage only one specification defined by its name (`api.info.title`) rather use the
-                                     whole of enabled specifications declared
+  -f, --filter string                Manage some specifications defined by its name (`api.info.title`) and which match
+                                     with this regex filter rather use the whole of enabled specifications declared
                                      into configuration file
   -v, --verbose                      Verbose mode, default is false
   -a, --urlDownloadTemplate string   Rather to use specs from local FS, you can specify remote specs (using 'artifact'
@@ -216,8 +216,8 @@ Global Options
 
   -c, --config string                Configuration file in JSON or YAML format where specifications are defined, default
                                      is config.json
-  -f, --filter string                Manage only one specification defined by its name (`api.info.title`) rather use the
-                                     whole of enabled specifications declared
+  -f, --filter string                Manage some specifications defined by its name (`api.info.title`) and which match
+                                     with this regex filter rather use the whole of enabled specifications declared
                                      into configuration file
   -v, --verbose                      Verbose mode, default is false
   -a, --urlDownloadTemplate string   Rather to use specs from local FS, you can specify remote specs (using 'artifact'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lyra-network/openapi-dev-tool",
-  "version": "9.10.0",
+  "version": "9.10.1",
   "description": "OpenAPI Development tool",
   "main": "src/lib.js",
   "scripts": {

src/commands/merge.js

@@ -31,10 +31,13 @@ export function merge(config = { config: { specs: [] } }) {
             const api = await bundleSpec(config, spec);
 
             // Apply filter if it is defined
-            if (config.filter && api.info.title !== config.filter) {
-              console.log("\tspec '%s': ignored by filter", api.info.title);
-              resolve();
-              return;
+            if (config.filter) {
+              const regex = new RegExp(config.filter);
+              if (!regex.test(api.info.title)) {
+                console.log("\tspec '%s': ignored by filter", api.info.title);
+                resolve();
+                return;
+              }
             }
 
             const outputDir = getOutputDirFromConfig(config);

src/commands/publish-local.js

@@ -31,10 +31,13 @@ export function publishLocal(config = { config: { specs: [] } }) {
             const api = await bundleSpec(config, spec);
 
             // Apply filter if it is defined
-            if (config.filter && api.info.title !== config.filter) {
-              console.log("\tspec '%s': ignored by filter", api.info.title);
-              resolve();
-              return;
+            if (config.filter) {
+              const regex = new RegExp(config.filter);
+              if (!regex.test(api.info.title)) {
+                console.log("\tspec '%s': ignored by filter", api.info.title);
+                resolve();
+                return;
+              }
             }
 
             let fileToArchive = spec.file;

src/commands/publish.js

@@ -30,10 +30,13 @@ export function publish(config = { config: { specs: [] } }) {
             const api = await bundleSpec(config, spec);
 
             // Apply filter if it is defined
-            if (config.filter && api.info.title !== config.filter) {
-              console.log("\tspec '%s': ignored by filter", api.info.title);
-              resolve();
-              return;
+            if (config.filter) {
+              const regex = new RegExp(config.filter);
+              if (!regex.test(api.info.title)) {
+                console.log("\tspec '%s': ignored by filter", api.info.title);
+                resolve();
+                return;
+              }
             }
 
             const tempDir = getTempDir();

src/lib/config-definitions.js

@@ -46,7 +46,7 @@ const globalOptionsDefinitions = [
     alias: 'f',
     type: String,
     description:
-      'Manage only one specification defined by its name (`api.info.title`) rather use the whole of enabled specifications declared into configuration file',
+      'Manage some specifications defined by its name (`api.info.title`) and which match with this regex filter rather use the whole of enabled specifications declared into configuration file',
   },
   {
     name: 'verbose',

src/lib/specs.js

@@ -32,9 +32,13 @@ export function loadSpecs(config) {
       } else {
         api = YAML.parse(raw);
       }
-      if (config.filter && api.info.title !== config.filter) {
-        console.log("\tspec '%s': ignored by filter", api.info.title);
-        return false;
+      // Apply filter if it is defined
+      if (config.filter) {
+        const regex = new RegExp(config.filter);
+        if (!regex.test(api.info.title)) {
+          console.log("\tspec '%s': ignored by filter", api.info.title);
+          return;
+        }
       }
       spec.api = api;
       return true;