add definitions for rule to check for absolute imports from the src folder

This commit is contained in:
Jacob Overgaard
2023-01-23 11:01:51 +01:00
parent e4d2d691a6
commit 264fc9c910

View File

@@ -64,5 +64,30 @@ module.exports = {
};
},
}
},
/** @type {import('eslint').Rule.RuleModule} */
'prefer-import-aliases': {
meta: {
type: 'suggestion',
docs: {
description: 'Ensures that the application does not rely on file system paths for imports. Instead, use import aliases or relative imports. This also solves a problem where GitHub fails on the test runner step.',
category: 'Best Practices',
recommended: true
},
schema: [],
},
create: function (context) {
return {
ImportDeclaration: function (node) {
if (node.source.value.startsWith('src/')) {
context.report({
node,
message: 'Prefer using import aliases or relative imports instead of absolute imports. Example: `import { MyComponent } from "src/components/MyComponent";` should be `import { MyComponent } from "@components/MyComponent";`'
});
}
},
};
}
},
};