Add preserveMainDescriptionPostDelimiter option to check-line-alignment rule
#731
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
This new option will preserve the left spacings in the main description when using the `always` option.
renatho
changed the title
preserveMainDescriptionPostDelimiter optionpreserveMainDescriptionPostDelimiter option to check-line-alignment rule
Merged
6 tasks
|
@brettz9, thank you for the super quick merge! =) |
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this pull request
May 13, 2021
This reverts commit 71e03da.
|
🎉 This PR is included in version 34.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
For some reason, when doing squashes and adding the Angular commit format needed for the automated semantic releases, I am not noticing there is a commit summary before it getting applied which negates the auto-release. I will try to be mindful of this in the future. Thanks very much for the feature! |
brettz9
pushed a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this pull request
May 14, 2021
feat(`check-line-alignment`): add `preserveMainDescriptionPostDelimiter` option to preserve left-hand side spacings in the main description when using the `always` option. Co-authored-by: Renatho De Carli Rosa <renatho@automattic.com>
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this pull request
May 14, 2021
This reverts commit 71e03da.
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this pull request
May 15, 2021
* tag-lines: Since the fixer may add asterisks as well as newlines, set `fixable` to `code` rather than `whitespace` docs: Indicate option is actually recommended - docs: minor clarification - Rename `noEndLine` to `noEndLines` since may normally be multiple lines after tags - Docs: Clarify `noEndLine` feat: new rule `tag-line`; fixes gajus#93 chore(`generateRule`): add `line` by default in test errors chore: allow rule generation to put backticks on separate lines (to avoid default linting errors) fix(`check-param-names`): adjusts line numbers to be nearer problematic item fix(`no-missing-syntax`): pass in missing `comment` fix(`require-description`, `require-example`): for missing description, use tag line number docs(`no-bad-blocks`): add clarifying comment to valid example feat(`no-bad-blocks`): add `preventAllMultiasteriskBlocks` boolean option to allow reporting of any multi-asterisked multiline comments feat(`check-line-alignment`): add `preserveMainDescriptionPostDelimiter` option to preserve left-hand side spacings in the main description when using the `always` option. Revert "Add preserveMainDescriptionPostDelimiter option (gajus#731)" docs(`check-line-alignment`): make mention of at least a single space being added by either the "always" or "never" option chore: update devDeps. docs: update README Add preserveMainDescriptionPostDelimiter option (gajus#731) # Conflicts: # README.md # src/iterateJsdoc.js
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 introduces the new option
preserveMainDescriptionPostDelimiterfor thecheck-line-alignmentrule.This new option will preserve the post delimiter (spacings after the
*) in the main description when using thealwaysoption.Notice that it just applies to
alwaysbecause theneveralways preserves the spacing. I thought about doing it as default toalwaystoo, but since we already released it in that way, I added a new option to avoid breaking changes.