Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

check-types: Distinguish .<> from <>; support []; check/fix nested array/object types #270

Merged
merged 1 commit into from
Jun 11, 2019

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Jun 1, 2019

BREAKING CHANGE: change <> to no longer apply to SomeType.<> but instead to now support SomeType<>
feat: pseudo-type [] to catch parent array types of form string[], number[], etc.
feat: support .<> as separate type
fix: ensure working with nested type arrays/objects
fix: ensure fixer preserves angle-bracket-dot or square bracket notation for arrays/objects
chore: Update husky, semantic-release devDeps; add typescript devDep for type-fest peer dep. (used indirectly by husky and semantic-release)

Breaking change through jsdoctypeparser update.


Also includes a minor adjustment to no-undefined-types to be able to recognize types suffixed with the pseudo-types (e.g., <>).

This is currently being blocked by jsdoctypeparser/jsdoctypeparser#60 but once that may be merged and released, this PR should only need to target the new version as its dependency. (And tests failing here should be due to this need.) Now incorporated

@brettz9 brettz9 force-pushed the parent-types branch 2 times, most recently from cba9b01 to 5998592 Compare June 10, 2019 23:50
@brettz9 brettz9 requested a review from gajus June 10, 2019 23:56
@brettz9
Copy link
Collaborator Author

brettz9 commented Jun 10, 2019

Not sure if semantic release can handle multiple angular-type statements in a single commit... I didn't see docs about this...

…instead to now support `SomeType<>`

feat: pseudo-type `[]` to catch parent array types of form `string[]`, `number[]`, etc.
feat: support `.<>` as separate type
fix: ensure working with nested type arrays/objects
fix: ensure fixer preserves angle-bracket-dot or square bracket notation for arrays/objects
chore: Update husky, semantic-release devDeps; add `typescript` devDep for `type-fest` peer dep. (used indirectly by husky and semantic-release)

Breaking change through `jsdoctypeparser` update.
@gajus
Copy link
Owner

gajus commented Jun 11, 2019

Not sure if semantic release can handle multiple angular-type statements in a single commit... I didn't see docs about this...

It will just use whichever has the greatest power. In this case, the BREAKING CHANGE will just force a new major version (if I understand the question correctly).

@brettz9 brettz9 merged commit 805017c into gajus:master Jun 11, 2019
@brettz9 brettz9 deleted the parent-types branch June 11, 2019 07:39
@gajus
Copy link
Owner

gajus commented Jun 11, 2019

🎉 This PR is included in version 8.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Jun 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants