@graphql-eslint/eslint-plugin 3.8.0-alpha-db02c77.0 → 3.8.0-alpha-2d2b247.0

package/docs/rules/alphabetize.md

@@ -9,8 +9,6 @@
 
 Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.
 
-> Note: autofix will work only for fields without comments (between or around)
-
 ## Usage Examples
 
 ### Incorrect

package/index.js

@@ -692,10 +692,7 @@ const rule = {
         fixable: 'code',
         docs: {
             category: ['Schema', 'Operations'],
-            description: [
-                'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
-                '> Note: autofix will work only for fields without comments (between or around)',
-            ].join('\n\n'),
+            description: `Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.`,
             url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/alphabetize.md',
             examples: [
                 {
@@ -853,8 +850,27 @@ const rule = {
     },
     create(context) {
         var _a, _b, _c, _d, _e;
-        function isOnSameLineNodeAndComment(beforeNode, afterNode) {
-            return beforeNode.loc.end.line === afterNode.loc.start.line;
+        const sourceCode = context.getSourceCode();
+        function isNodeAndCommentOnSameLine(node, comment) {
+            return node.loc.end.line === comment.loc.start.line;
+        }
+        function getBeforeComments(node) {
+            const commentsBefore = sourceCode.getCommentsBefore(node);
+            if (commentsBefore.length === 0) {
+                return [];
+            }
+            const tokenBefore = sourceCode.getTokenBefore(node);
+            if (tokenBefore) {
+                return commentsBefore.filter(comment => !isNodeAndCommentOnSameLine(tokenBefore, comment));
+            }
+            return commentsBefore;
+        }
+        function getRangeWithComments(node) {
+            const [firstBeforeComment] = getBeforeComments(node);
+            const [firstAfterComment] = sourceCode.getCommentsAfter(node);
+            const from = firstBeforeComment || node;
+            const to = firstAfterComment && isNodeAndCommentOnSameLine(node, firstAfterComment) ? firstAfterComment : node;
+            return [from.range[0], to.range[1]];
         }
         function checkNodes(nodes) {
             // Starts from 1, ignore nodes.length <= 1
@@ -863,39 +879,27 @@ const rule = {
                 const currNode = nodes[i];
                 const prevName = prevNode.name.value;
                 const currName = currNode.name.value;
-                if (prevName.localeCompare(currName) === 1) {
-                    const isVariableNode = currNode.kind === graphql.Kind.VARIABLE;
-                    context.report({
-                        loc: getLocation(currNode.loc, currName, { offsetEnd: isVariableNode ? 0 : 1 }),
-                        messageId: ALPHABETIZE,
-                        data: isVariableNode
-                            ? {
-                                currName: `$${currName}`,
-                                prevName: `$${prevName}`,
-                            }
-                            : { currName, prevName },
-                        *fix(fixer) {
-                            const prev = prevNode;
-                            const curr = currNode;
-                            const sourceCode = context.getSourceCode();
-                            const beforeComments = sourceCode.getCommentsBefore(prev);
-                            if (beforeComments.length > 0) {
-                                const tokenBefore = sourceCode.getTokenBefore(prev);
-                                const lastBeforeComment = beforeComments[beforeComments.length - 1];
-                                if (!tokenBefore || !isOnSameLineNodeAndComment(tokenBefore, lastBeforeComment))
-                                    return;
-                            }
-                            const betweenComments = sourceCode.getCommentsBefore(curr);
-                            if (betweenComments.length > 0)
-                                return;
-                            const [firstAfterComment] = sourceCode.getCommentsAfter(curr);
-                            if (firstAfterComment && isOnSameLineNodeAndComment(curr, firstAfterComment))
-                                return;
-                            yield fixer.replaceText(prev, sourceCode.getText(curr));
-                            yield fixer.replaceText(curr, sourceCode.getText(prev));
-                        },
-                    });
+                // Compare with lexicographic order
+                if (prevName.localeCompare(currName) !== 1) {
+                    continue;
                 }
+                const isVariableNode = currNode.kind === graphql.Kind.VARIABLE;
+                context.report({
+                    loc: getLocation(currNode.name.loc, currName, { offsetStart: isVariableNode ? 2 : 1 }),
+                    messageId: ALPHABETIZE,
+                    data: isVariableNode
+                        ? {
+                            currName: `$${currName}`,
+                            prevName: `$${prevName}`,
+                        }
+                        : { currName, prevName },
+                    *fix(fixer) {
+                        const prevRange = getRangeWithComments(prevNode);
+                        const currRange = getRangeWithComments(currNode);
+                        yield fixer.replaceTextRange(prevRange, sourceCode.getText({ range: currRange }));
+                        yield fixer.replaceTextRange(currRange, sourceCode.getText({ range: prevRange }));
+                    },
+                });
             }
         }
         const opts = context.options[0];

package/index.mjs

@@ -686,10 +686,7 @@ const rule = {
         fixable: 'code',
         docs: {
             category: ['Schema', 'Operations'],
-            description: [
-                'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
-                '> Note: autofix will work only for fields without comments (between or around)',
-            ].join('\n\n'),
+            description: `Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.`,
             url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/alphabetize.md',
             examples: [
                 {
@@ -847,8 +844,27 @@ const rule = {
     },
     create(context) {
         var _a, _b, _c, _d, _e;
-        function isOnSameLineNodeAndComment(beforeNode, afterNode) {
-            return beforeNode.loc.end.line === afterNode.loc.start.line;
+        const sourceCode = context.getSourceCode();
+        function isNodeAndCommentOnSameLine(node, comment) {
+            return node.loc.end.line === comment.loc.start.line;
+        }
+        function getBeforeComments(node) {
+            const commentsBefore = sourceCode.getCommentsBefore(node);
+            if (commentsBefore.length === 0) {
+                return [];
+            }
+            const tokenBefore = sourceCode.getTokenBefore(node);
+            if (tokenBefore) {
+                return commentsBefore.filter(comment => !isNodeAndCommentOnSameLine(tokenBefore, comment));
+            }
+            return commentsBefore;
+        }
+        function getRangeWithComments(node) {
+            const [firstBeforeComment] = getBeforeComments(node);
+            const [firstAfterComment] = sourceCode.getCommentsAfter(node);
+            const from = firstBeforeComment || node;
+            const to = firstAfterComment && isNodeAndCommentOnSameLine(node, firstAfterComment) ? firstAfterComment : node;
+            return [from.range[0], to.range[1]];
         }
         function checkNodes(nodes) {
             // Starts from 1, ignore nodes.length <= 1
@@ -857,39 +873,27 @@ const rule = {
                 const currNode = nodes[i];
                 const prevName = prevNode.name.value;
                 const currName = currNode.name.value;
-                if (prevName.localeCompare(currName) === 1) {
-                    const isVariableNode = currNode.kind === Kind.VARIABLE;
-                    context.report({
-                        loc: getLocation(currNode.loc, currName, { offsetEnd: isVariableNode ? 0 : 1 }),
-                        messageId: ALPHABETIZE,
-                        data: isVariableNode
-                            ? {
-                                currName: `$${currName}`,
-                                prevName: `$${prevName}`,
-                            }
-                            : { currName, prevName },
-                        *fix(fixer) {
-                            const prev = prevNode;
-                            const curr = currNode;
-                            const sourceCode = context.getSourceCode();
-                            const beforeComments = sourceCode.getCommentsBefore(prev);
-                            if (beforeComments.length > 0) {
-                                const tokenBefore = sourceCode.getTokenBefore(prev);
-                                const lastBeforeComment = beforeComments[beforeComments.length - 1];
-                                if (!tokenBefore || !isOnSameLineNodeAndComment(tokenBefore, lastBeforeComment))
-                                    return;
-                            }
-                            const betweenComments = sourceCode.getCommentsBefore(curr);
-                            if (betweenComments.length > 0)
-                                return;
-                            const [firstAfterComment] = sourceCode.getCommentsAfter(curr);
-                            if (firstAfterComment && isOnSameLineNodeAndComment(curr, firstAfterComment))
-                                return;
-                            yield fixer.replaceText(prev, sourceCode.getText(curr));
-                            yield fixer.replaceText(curr, sourceCode.getText(prev));
-                        },
-                    });
+                // Compare with lexicographic order
+                if (prevName.localeCompare(currName) !== 1) {
+                    continue;
                 }
+                const isVariableNode = currNode.kind === Kind.VARIABLE;
+                context.report({
+                    loc: getLocation(currNode.name.loc, currName, { offsetStart: isVariableNode ? 2 : 1 }),
+                    messageId: ALPHABETIZE,
+                    data: isVariableNode
+                        ? {
+                            currName: `$${currName}`,
+                            prevName: `$${prevName}`,
+                        }
+                        : { currName, prevName },
+                    *fix(fixer) {
+                        const prevRange = getRangeWithComments(prevNode);
+                        const currRange = getRangeWithComments(currNode);
+                        yield fixer.replaceTextRange(prevRange, sourceCode.getText({ range: currRange }));
+                        yield fixer.replaceTextRange(currRange, sourceCode.getText({ range: prevRange }));
+                    },
+                });
             }
         }
         const opts = context.options[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.8.0-alpha-db02c77.0",
+  "version": "3.8.0-alpha-2d2b247.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {