@scandipwa/eslint-plugin-scandipwa-guidelines - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

lib/rules/derived-class-names.js

 /**
  * @fileoverview Class name must match the name of the file it is declared in.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
 function capitalize(word) {
@@ -11,0 +7,0 @@ return word.charAt(0).toUpperCase() + word.slice(1);

lib/rules/file-structure.js

 /**
  * @fileoverview File structure must comply to the strict guidelines of ScandiPWA
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
 /* eslint-disable max-len */
@@ -49,3 +45,3 @@ /* eslint-disable no-magic-numbers */
     case 'route':
-        if (!(['component', 'container', 'style'].includes(postfix))) {
+        if (!(['component', 'container', 'style', 'config', 'unstated'].includes(postfix))) {
             return exploded[0];
@@ -52,0 +48,0 @@ }

lib/rules/no-non-extensible-components.js

 /**
  * @fileoverview Non-extensible components are not allowed.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
 function keepOrDeleteNode(context, node) {
@@ -66,36 +62,4 @@ const { name } = node.specifiers[0].local;
             }
-        },
-        VariableDeclaration(node) {
-            const { parent, declarations: [{ id: { loc, name } }] } = node;
-            const { type } = parent || {};
-
-            if (parent.type !== 'Program') {
-                return;
-            }
-
-            if (type !== 'ExportNamedDeclaration') {
-                context.report({
-                    loc,
-                    message: `Variable ${name} must be exported (as non default) to allow proper extension.`,
-                    fix: fixer => fixer.insertTextBefore(node, 'export ')
-                });
-            }
-        },
-        ClassDeclaration(node) {
-            const { parent, id: { loc, name } } = node;
-            const { type } = parent || {};
-
-            if (type !== 'ExportNamedDeclaration') {
-                context.report({
-                    loc,
-                    message: `Class ${name} must be exported (as non default) to allow proper extension.`,
-                    fix: fixer => {
-                        if (parent.type === 'Program') {
-                            fixer.insertTextBefore(node, 'export ')
-                        }
-                    }
-                });
-            }
-          }
+        }
     })
 };

lib/rules/only-one-class.js

 /**
  * @fileoverview There should be only one class per file
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
 // eslint-disable-next-line fp/no-let, scandipwa-extensibility/no-non-extensible-components
@@ -11,0 +7,0 @@ let classCount;

lib/rules/use-extensible-base.js

 /**
  * @fileoverview All components should be extensible.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 "use strict";
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
 module.exports = {
@@ -24,3 +20,3 @@ meta: {
             const { superClass } = node;
-            const { name, loc: superClassLoc } = superClass || {};
+            const { name } = superClass || {};
             const { id: declaration } = node;
@@ -39,3 +35,3 @@ const { loc } = declaration;
                 context.report({
-                    superClassLoc,
+                    loc,
                     message: `${name} is not allowed. Use 'Extensible${name}' instead`,
@@ -42,0 +38,0 @@ fix: fixer => fixer.replaceText(superClass, `Extensible${name}`)

lib/rules/use-middleware.js

 /**
  * @fileoverview Wrap default export classes in middleware function
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
 "use strict";
 
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
+function checkCall(context, callee) {
+    const { type, name } = callee;
+    if (type === 'Identifier' && name === 'middleware') {
+        return true;
+    }
+    if (type === 'CallExpression' || type === 'NewExpression') {
+        const { callee: nextCallee, arguments: args } = callee;
+        if (checkCall(context, nextCallee)) {
+            return true;
+        }
 
+        // eslint-disable-next-line fp/no-loops, no-restricted-syntax
+        for (const arg of args) {
+            if (checkCall(context, arg)) {
+                return true;
+            }
+        }
+    }
+
+    return false;
+}
+
+let classExists = false;
+
 module.exports = {
@@ -18,28 +38,50 @@ meta: {
         },
-        fixable: null,  // or "code" or "whitespace"
-        schema: [
-            // fill in your schema
-        ]
+        fixable: 'code',
     },
 
-    create: function(context) {
+    create: context => ({
+        Program() {
+            classExists = false;
+        },
+        ClassDeclaration() {
+            classExists = true;
+        },
+        ExportDefaultDeclaration(node) {
+            if (!classExists && node.declaration.type !== 'ClassDeclaration') {
+                return;
+            }
 
-        // variables should be defined here
+            if (node.declaration.type === 'ClassDeclaration') {
+                context.report({
+                    node,
+                    message: 'Use middleware function when exporting extensible class. Declare it separately.'
+                });
+            }
 
-        //----------------------------------------------------------------------
-        // Helpers
-        //----------------------------------------------------------------------
+            if (node.declaration.type === 'Identifier') {
+                context.report({
+                    node,
+                    message: 'Use middleware function when exporting class',
+                    fix: (fixer) => {
+                        const { declaration } = node;
 
-        // any helper functions should go here or else delete this section
+                        return [
+                            fixer.insertTextBefore(declaration, 'middleware('),
+                            fixer.insertTextAfter(declaration, ", 'NAMESPACE')")
+                        ];
+                    }
+                });
+            }
 
-        //----------------------------------------------------------------------
-        // Public
-        //----------------------------------------------------------------------
-
-        return {
-
-            // give me methods
-
-        };
-    }
+            if (node.declaration.type === 'CallExpression' || node.declaration.type === 'NewExpression') {
+                const { declaration } = node;
+                if (!checkCall(context, declaration)) {
+                    context.report({
+                        node,
+                        message: 'Use middleware function when wrapping exporting value in other functions'
+                    });
+                }
+            }
+        }
+    })
 };

package.json

 {
   "name": "@scandipwa/eslint-plugin-scandipwa-guidelines",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Eslint rules for ScandiPWA",
@@ -5,0 +5,0 @@ "keywords": [

tests/lib/rules/derived-class-names.js

@@ -6,3 +6,3 @@ /* eslint-disable import/no-extraneous-dependencies */
  * @fileoverview Class name must match the name of the file it is declared in.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -9,0 +9,0 @@

tests/lib/rules/file-structure.js

 /**
  * @fileoverview File structure must comply to the strict guidelines of ScandiPWA
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -5,0 +5,0 @@ "use strict";

tests/lib/rules/no-non-extensible-components.js

 /**
  * @fileoverview Non-extensible components are not allowed.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -5,0 +5,0 @@ "use strict";

tests/lib/rules/only-one-class.js

 /**
  * @fileoverview There should be only one class per file
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -5,0 +5,0 @@ "use strict";

tests/lib/rules/use-extensible-base.js

 /**
  * @fileoverview All components should be extensible.
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -5,0 +5,0 @@ "use strict";

tests/lib/rules/use-middleware.js

 /**
  * @fileoverview Wrap default export classes in middleware function
- * @author Alfreds Genkins
+ * @author Jegors Batovs
  */
@@ -5,0 +5,0 @@ "use strict";

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25747

increased by3.34%

Number of package files

22

increased by4.76%

Lines of code

604

increased by7.66%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes