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

Feature-Request: tag-lines depending on the tag #734

Closed
jens-duttke opened this issue May 15, 2021 · 2 comments · Fixed by #741
Closed

Feature-Request: tag-lines depending on the tag #734

jens-duttke opened this issue May 15, 2021 · 2 comments · Fixed by #741

Comments

@jens-duttke
Copy link
Contributor

Motivation

Be able to make a more granular configuration, depending on the tag type.

Current behavior

There is only one configuration for all tags.

Desired behavior

It would be nice if there would be a by-tag configuration, so that I can use an array or regexp to specify a list of tags, and their behaviour.

e.g. I want that there is an empty line after @file and @example, but not between @params

Alternatives considered

There could be two new optional properties called "always" and "never", which accept an array of tag names, like:

"always": ["file", "example"],
"never": ["params"]

Or an option "inverse", which also accepts an array of tag names, and inverse the configured behaviour for these tags:

"tag-lines": ["error", "never", { "inverse": ["file", "example"] }]
@brettz9
Copy link
Collaborator

brettz9 commented May 15, 2021

No promises to implement, but I would suggest a tags option with each key being a tag and the value an object with lines being set to "always" or "never", and count also being available on that object (to override the default if desired) as well.

brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 17, 2021
…ecific basis (including only applying to tag(s)); fixes gajus#734
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 17, 2021
…ecific basis (including only applying to tag(s)); fixes gajus#734
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 17, 2021
…ecific basis (including only applying to tag(s)); fixes gajus#734
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 18, 2021
…ecific basis (including only applying to tag(s)); fixes gajus#734
brettz9 added a commit that referenced this issue May 19, 2021
…ecific basis (including only applying to tag(s)); fixes #734
@gajus
Copy link
Owner

gajus commented May 19, 2021

🎉 This issue has been resolved in version 34.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging a pull request may close this issue.

3 participants