feat(extract): adds recognition of jsdoc @import type imports #965
Conversation
This file contains 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
|
Test driving it, seems to work great already. |
Thanks! Good to hear it works 🎉 There will be small changes over time. E.g. since yesterday I've changed the names of dependencyTypes a bit (for regular cli use shouldn't matter) and I'll add a feature switch to (1) prevent this being a breaking change (2) auto-switch the javascript parser to |
…en true extract code will attempt jsdoc import detection
…g an *ss on the ci
sverweij
commented
Nov 17, 2024
sverweij
commented
Nov 17, 2024
|
Code Climate has analyzed commit 2daf3d3 and detected 0 issues on this pull request. View more on Code Climate. |
12 tasks
sverweij
added a commit
that referenced
this pull request
Dec 1, 2024
## Description - adds recognition for the 'older' bracket style imports in jsdoc (so things like `/** @type {import('thing')} */`, `/** @typedef {import('thing')} Thing */`, `/** @param {import('thing')} pParameter blablabla */`, ...) - updates documentation to reflect that it isn't a 'future feature' anymore - 🏕️ drive-by: updates jsdoc type references in dependency-cruiser's own sources TODO - [x] Add support for more exotic ways to import (e.g. `/** @type {Partial<import('bla')>} */`, `/** @type{boolean|import('bla')|import('ble')} */`, `/** {Set<string,Partial<import('bla')>} */`, ...) - [x] Verify with [the list of jsdoc tag types typescript supports](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) there's no other corner cases that can bite us. - [x] so... we currently seem to occasionally resolve these type only imports to the real implementation. Is that an issue? > [!NOTE] > an iteration of this pull request has been published [as a beta on npmjs](https://www.npmjs.com/package/dependency-cruiser/v/16.7.0-beta-2) ## Motivation and Context - necessary to be more complete than just `@import` tags (see #964 and #965) - needs to be introduced at the same time as those to prevent a breaking change ## How Has This Been Tested? - [x] green ci - [x] additional unit tests ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] Documentation only change - [ ] Refactor (non-breaking change which fixes an issue without changing functionality) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
jsdoc,jsdoc-import-tagdependency types@importjsdoc tagparserset totscparserattribute set totsc)Future work:
/** @type {import('yadda').bla} */) statements in other jsdoc tags - see typescript jsdoc reference for a list => likely better in a separate PR.Motivation and Context
Addresses #964
How Has This Been Tested?
Types of changes
Checklist
📖
⚖️