build-firewall-plugin 0.1.2 → 0.2.1

package/build/index.js

@@ -17,16 +17,9 @@ const settings = {
  * empty template of project rules map
  */
 const template = {
-    layers: {
-        ui: settings,
-        lib: settings,
-        hooks: settings,
-        pages: settings,
-        models: settings,
-        widgets: settings,
+    layers: [],
+    rules: {
         services: settings,
-        components: settings,
-        declarations: settings,
     },
     mode: 'warn',
 };
@@ -37,36 +30,34 @@ const exceptions = ['node_modules', 'assets', '.css', '.scss', 'styles', 'style'
 /**
  * @function guard validates received file by path
  */
-const isValidSchema = (value) => {
-    var _a, _b;
-    return (!!value &&
-        typeof value === 'object' &&
-        'mode' in value &&
-        'layers' in value &&
-        typeof value.layers === 'object' &&
-        Object.keys((_a = value.layers) !== null && _a !== void 0 ? _a : {}).length > 0 &&
-        (value.mode === 'warn' || value.mode === 'error') &&
-        Object.entries((_b = value.layers) !== null && _b !== void 0 ? _b : {}).every(([_, layer]) => typeof layer === 'object' && 'allow' in layer && 'deny' in layer
-            && Array.isArray(layer.allow) && Array.isArray(layer.deny)));
+const isValidSchema = (v) => {
+    return (!!v && typeof v === 'object' &&
+        'layers' in v && 'rules' in v && 'mode' in v &&
+        Array.isArray(v.layers) &&
+        v.layers.every((l) => typeof l === 'string') &&
+        !!v.rules && typeof v.rules === 'object' &&
+        Object.values(v.rules).every((r) => !!r &&
+            typeof r === 'object' &&
+            'deny' in r && 'allow' in r &&
+            Array.isArray(r.allow) &&
+            Array.isArray(r.deny)) && (v.mode === 'warn' || v.mode === 'error'));
 };
 /**
  * @function resolveLayer normilizes module resource
  */
 function resolveLayer(resource, layers) {
     const normalized = resource.replace(/\\/g, '/');
-    for (const layer of Object.keys(layers)) {
+    for (const layer of layers) {
         if (normalized.includes(`/src/${layer}/`)) {
             return layer;
         }
     }
     return null;
 }
-;
 /**
  * @function prepareOutput is for object type output
  */
 function prepareOutput(params) {
-    const { total, modules, warnings, layers } = params;
     return {
         plugin: 'Build Firewall Plugin',
         message_type: 'output',
@@ -91,6 +82,7 @@ class BuildFirewallPlugin {
             mode: template.mode,
             outputType: 'default',
             layers: template.layers,
+            rules: template.rules,
             name: 'build-firewall-plugin.rules.json',
         };
         this.shouldRunAgain = false;
@@ -101,7 +93,7 @@ class BuildFirewallPlugin {
         this.shouldRunAgain = false;
         compiler.hooks.thisCompilation.tap('BuildFirewallPluginThisCompilation', (compilation) => {
             compilation.hooks.finishModules.tap('BuildFirewallPluginThisCompilationFinishModules', (modules) => {
-                console.log('[Build Firewall Plugin] Starting... \n');
+                console.log('[Build Firewall Plugin] Starting...');
                 /**
                  * Creating or Validating a rules file
                  */
@@ -111,7 +103,7 @@ class BuildFirewallPlugin {
                         fs_1.default.writeFileSync(pathToFile, JSON.stringify(template));
                         this.shouldRunAgain = true;
                         this.config.path = pathToFile;
-                        console.log(`[Build Firewall Plugin] Created a template of ${this.config.name} file successfully \n`);
+                        console.log(`[Build Firewall Plugin] Created a template of ${this.config.name} file successfully`);
                         console.log(`[Build Firewall Plugin] Check and edit a ${this.config.name} file if it is not passing for your project \n`);
                     }
                     catch (e) {
@@ -145,12 +137,16 @@ class BuildFirewallPlugin {
                         const hasValidSchema = isValidSchema(parsedFile);
                         if (!hasValidSchema) {
                             console.error(`[Build Firewall Plugin] Your ${this.config.name} file value is not valid schema, it has to be like this: \n 
-                                { 
-                                    layers: { 
-                                        [name]: { allow: [], deny: [] },
-                                        mode: 'warn'
-                                    } 
-                                }
+                            ${JSON.stringify({
+                                layers: [],
+                                rules: {
+                                    layer_name: {
+                                        allow: [],
+                                        deny: [],
+                                    },
+                                },
+                                mode: 'warn'
+                            })}
                             \n`);
                             return;
                         }
@@ -203,7 +199,7 @@ class BuildFirewallPlugin {
                         if (selfImport) {
                             continue;
                         }
-                        const rules = this.config.layers[fromLayer];
+                        const rules = this.config.rules[fromLayer];
                         if (!rules)
                             continue;
                         const isDenied = rules.deny.includes(toLayer);
@@ -214,7 +210,7 @@ class BuildFirewallPlugin {
                             seen.add(moduleKey);
                             warningsAmount++;
                             if (this.config.outputType === 'default') {
-                                console.log(`\n [Build Firewall Plugin] Module ${toModuleResource} is not allowed to import in ${fromResource} \n`);
+                                console.log(`\n [Build Firewall Plugin] Module ${fromResource} imports forbidden module ${toModuleResource} \n`);
                             }
                         }
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-firewall-plugin",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "type": "commonjs",
   "license": "MIT",
   "main": "build/index.js",