feat!: add method-signature-style rule #190
Merged
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
achingbrain
changed the title
wemeetagain
force-pushed
the
feat/method-signature-stype
branch
from
63f8638
to
4edfb32
Compare
achingbrain
approved these changes
Sep 29, 2023
github-actions bot
pushed a commit
that referenced
this pull request
Sep 29, 2023
## [6.0.0](v5.0.1...v6.0.0) (2023-09-29) ### ⚠ BREAKING CHANGES * All interfaces now need to use method signature style rather than property function style eg: before ```ts interface Foo { bar: (baz: number) => void } ``` after ```ts interface Foo { bar(baz: number): void } ``` ### Features * add method-signature-style rule ([#190](#190)) ([8823186](8823186))
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
achingbrain
pushed a commit
to ipfs/aegir
that referenced
this pull request
Sep 30, 2023
- See ipfs/eslint-config-ipfs#190 BREAKING CHANGE: All interfaces now need to use method signature style rather than property function style eg: before ```ts interface Foo { bar: (baz: number) => void } ``` after ```ts interface Foo { bar(baz: number): void } ```
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.
This is important for generated docs, which distinguish between methods and properties. Without this rule, functions on an interface/object can appear as properties rather than methods:
I tested this rule against the js-libp2p monorepo, and using this rule results in API docs that now properly distinguish between methods and properties.
BREAKING CHANGE: All interfaces now need to use method signature style rather than property function style
eg:
before
after