So I wanna create my own import order convention and followed this tutorial https://dev.to/spukas/how-to-write-your-first-eslint-plugin-145
This is the rule that I created:
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "enforce sorted import declarations within modules",
category: "ECMAScript 6",
recommended: false
},
schema: [
{
type: "object",
properties: {
ignoreCase: {
type: "boolean",
default: false,
},
memberSyntaxSortOrder: {
type: "array",
items: {
enum: ["none", "all", "named", "default"],
},
uniqueItems: true,
minItems: 4,
maxItems: 4,
},
ignoreDeclarationSort: {
type: "boolean",
default: false,
},
ignoreMemberSort: {
type: "boolean",
default: false,
},
allowSeparatedGroups: {
type: "boolean",
default: false,
},
},
additionalProperties: false,
},
],
fixable: "code",
messages: {
sortImportsAlphabetically: "Imports should be sorted alphabetically.",
sortMembersAlphabetically:
"Member '{{memberName}}' of the import declaration should be sorted alphabetically.",
unexpectedSyntaxOrder:
"Expected '{{syntaxA}}' syntax before '{{syntaxB}}' syntax.",
},
},
create(context) {
console.log({context})
const configuration = context.options[0] || {},
ignoreCase = configuration.ignoreCase || false,
ignoreDeclarationSort = configuration.ignoreDeclarationSort || false,
ignoreMemberSort = configuration.ignoreMemberSort || false,
memberSyntaxSortOrder = configuration.memberSyntaxSortOrder || [
"none",
"all",
"default",
"named"
],
allowSeparatedGroups = configuration.allowSeparatedGroups || false,
sourceCode = context.getSourceCode();
let previousDeclaration = null;
/**
* Gets the used member syntax style.
*
* import "my-module.js" --> none
* import * as myModule from "my-module.js" --> all
* import {myMember} from "my-module.js" --> default
* import {foo, bar} from "my-module.js" --> named
* @param {ASTNode} node the ImportDeclaration node.
* @returns {string} used member parameter style, ["all", "named", "default"]
*/
function usedMemberSyntax(node) {
if (node.specifiers.length === 0) {
return "none";
}
if (node.specifiers[0].type === "ImportNamespaceSpecifier") {
return "all";
}
if (node.specifiers[0].type === "ImportDefaultSpecifier") {
return "default";
}
return "named";
}
/**
* Gets the group by member parameter index for given declaration.
* @param {ASTNode} node the ImportDeclaration node.
* @returns {number} the declaration group by member index.
*/
function getMemberParameterGroupIndex(node) {
return memberSyntaxSortOrder.indexOf(usedMemberSyntax(node));
}
/**
* Gets the local name of the first imported module.
* @param {ASTNode} node the ImportDeclaration node.
* @returns {?string} the local name of the first imported module.
*/
function getFirstLocalMemberName(node) {
if (node.specifiers[0]) {
return node.specifiers[0].local.name;
}
return null;
}
/**
* Calculates number of lines between two nodes. It is assumed that the given `left` node appears before
* the given `right` node in the source code. Lines are counted from the end of the `left` node till the
* start of the `right` node. If the given nodes are on the same line, it returns `0`, same as if they were
* on two consecutive lines.
* @param {ASTNode} left node that appears before the given `right` node.
* @param {ASTNode} right node that appears after the given `left` node.
* @returns {number} number of lines between nodes.
*/
function getNumberOfLinesBetween(left, right) {
return Math.max(right.loc.start.line - left.loc.end.line - 1, 0);
}
return {
ImportDeclaration(node) {
if (!ignoreDeclarationSort) {
if (
previousDeclaration &&
allowSeparatedGroups &&
getNumberOfLinesBetween(previousDeclaration, node) > 0
) {
// reset declaration sort
previousDeclaration = null;
}
if (previousDeclaration) {
const currentMemberSyntaxGroupIndex = getMemberParameterGroupIndex(
node
),
previousMemberSyntaxGroupIndex = getMemberParameterGroupIndex(
previousDeclaration
);
let currentLocalMemberName = getFirstLocalMemberName(node),
previousLocalMemberName = getFirstLocalMemberName(
previousDeclaration
);
if (ignoreCase) {
previousLocalMemberName =
previousLocalMemberName &&
previousLocalMemberName.toLowerCase();
currentLocalMemberName =
currentLocalMemberName && currentLocalMemberName.toLowerCase();
}
/*
* When the current declaration uses a different member syntax,
* then check if the ordering is correct.
* Otherwise, make a default string compare (like rule sort-vars to be consistent) of the first used local member name.
*/
if (
currentMemberSyntaxGroupIndex !== previousMemberSyntaxGroupIndex
) {
if (
currentMemberSyntaxGroupIndex < previousMemberSyntaxGroupIndex
) {
context.report({
node,
messageId: "unexpectedSyntaxOrder",
data: {
syntaxA:
memberSyntaxSortOrder[currentMemberSyntaxGroupIndex],
syntaxB:
memberSyntaxSortOrder[previousMemberSyntaxGroupIndex],
},
});
}
} else {
if (
previousLocalMemberName &&
currentLocalMemberName &&
currentLocalMemberName < previousLocalMemberName
) {
context.report({
node,
messageId: "sortImportsAlphabetically",
});
}
}
}
previousDeclaration = node;
}
if (!ignoreMemberSort) {
const importSpecifiers = node.specifiers.filter(
(specifier) => specifier.type === "ImportSpecifier"
);
const getSortableName = ignoreCase
? (specifier) => specifier.local.name.toLowerCase()
: (specifier) => specifier.local.name;
const firstUnsortedIndex = importSpecifiers
.map(getSortableName)
.findIndex((name, index, array) => array[index - 1] > name);
if (firstUnsortedIndex !== -1) {
context.report({
node: importSpecifiers[firstUnsortedIndex],
messageId: "sortMembersAlphabetically",
data: {
memberName: importSpecifiers[firstUnsortedIndex].local.name,
},
fix(fixer) {
if (
importSpecifiers.some(
(specifier) =>
sourceCode.getCommentsBefore(specifier).length ||
sourceCode.getCommentsAfter(specifier).length
)
) {
// If there are comments in the ImportSpecifier list, don't rearrange the specifiers.
return null;
}
return fixer.replaceTextRange(
[
importSpecifiers[0].range[0],
importSpecifiers[importSpecifiers.length - 1].range[1],
],
importSpecifiers
// Clone the importSpecifiers array to avoid mutating it
.slice()
// Sort the array into the desired order
.sort((specifierA, specifierB) => {
const aName = getSortableName(specifierA);
const bName = getSortableName(specifierB);
return aName > bName ? 1 : -1;
})
// Build a string out of the sorted list of import specifiers and the text between the originals
.reduce((sourceText, specifier, index) => {
const textAfterSpecifier =
index === importSpecifiers.length - 1
? ""
: sourceCode
.getText()
.slice(
importSpecifiers[index].range[1],
importSpecifiers[index + 1].range[0]
);
return (
sourceText +
sourceCode.getText(specifier) +
textAfterSpecifier
);
}, "")
);
},
});
}
}
},
};
},
};
I have tested this rule to astexplorer.net and works fine. But when I implement it on my custom plugin it doesn't detect the errors. I've tried both manual creation and using yo plus generator-eslint. Both doesn't work