ci(lint): rule to detect index.ts imports in core #6518
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I could not find a lint rule (or a configuration of a lint rule) to achieve this, so I just made one. I tried some things from eslint-plugin-import (namely no-cycles), but I was not happy with the results. This will prevent you from importing from index.ts files while working in packages/core/, which has been a source of annoying and hard to understand circular dependency issues. It only affects imports in core, and only in src/ dirctories that do not start with test/
|
hayemaxi
force-pushed
the
eslint-import-index
branch
from
c8817f2 to
abe6160
Compare
hayemaxi
force-pushed
the
eslint-import-index
branch
from
abe6160 to
042a307
Compare
Hweinstock
reviewed
Feb 7, 2025
| defaultOptions: [], | ||
| create(context) { | ||
| const filePath = context.physicalFilename | ||
| if (!filePath.match(/packages\/core\/src\/(?!test)/)) { |
Contributor
There was a problem hiding this comment.
Is it possible to configure this at the top level in the .eslintrc.js file?
Contributor
Author
There was a problem hiding this comment.
Not that I have found. If you are referring to no-restricted-imports specifically, no because it only matches on the import string literal.
Hweinstock
reviewed
Feb 7, 2025
plugins/eslint-plugin-aws-toolkits/lib/rules/no-index-import.ts
Outdated
Show resolved
Hide resolved
Hweinstock
reviewed
Feb 7, 2025
| messageId: 'default', | ||
| // TODO: We can add a fixer to resolve the import for us. | ||
| // fix: (fixer) => { | ||
| // // somehow parse the exports of the imported index.ts file to get the actual export path, |
Contributor
There was a problem hiding this comment.
I'm guessing this isn't straightforward? Does ESLint allow you to access this information or would it involve manually reading the file?
Contributor
Author
There was a problem hiding this comment.
Eslint context doesn't seem to offer more than the file it is currently linting. The only thing I can think of is opening the file manually and load it into the ts lib to create an AST.
Hweinstock
approved these changes
Feb 7, 2025
jpinkney-aws
approved these changes
Feb 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I could not find a lint rule (or a configuration of a lint rule) to achieve this, so I just made one. I tried some things from eslint-plugin-import (namely no-cycles), but I was not happy with the results.
This will prevent you from importing from index.ts files while working in packages/core/, which has been a source of annoying and hard to understand circular dependency issues. These files should be reserved for exporting to the subprojects only.
It only affects imports in core, and only in src/ directories that do not start with "test"
feature/xbranches will not be squash-merged at release time.