Skip to content

Unrecognized JSDoc tag: hideconstructor #96

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.

Sign up for GitHub

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

Jump to bottom
Closed
jugglinmike opened this issue Oct 8, 2018 · 3 comments
Closed

Unrecognized JSDoc tag: hideconstructor #96

jugglinmike opened this issue Oct 8, 2018 · 3 comments
Labels
enhancement released

Comments

@jugglinmike
Copy link

JSDoc defines a tag named hideconstructor, but the tag is not recognized by this plugin, e.g.

/home/mike/projects/oss/cheerio/cheerio/lib/cheerio.js
  28:1  error  Invalid JSDoc tag name "hideconstructor"  jsdoc/check-tag-names

✖ 1 problem (1 error, 0 warnings)

It may be omitted because it's relatively new, having been introduced in July of last year.

For folks looking to work around this in the short term: use the plugin's additionalTagNames configuration:

"settings": {
  "jsdoc": {
    "additionalTagNames": {
      "customTags": ["hideconstructor"]
    }
  }
}
jugglinmike added a commit to jugglinmike/cheerio that referenced this issue Oct 8, 2018
@jugglinmike
Correct structure of generated documentation
1d47397 
Reformat the project source to ensure proper organization of the
procedurally-generated API documentation. This includes documenting
aliased methods independently (e.g. `cheerio.html` and `$.html`) and
accurately communicating the distinction between the Cheerio module and
the Cheerio class.

This change uses the `hideconstructor` JSDoc "tag" name in order to
discourage the use of a low-level function. The linting rules do not
currently recognize the tag, so this patch also adds explicit
configuration to allow it. This may be removed if the linting tool is
patched with support [1].

JSDoc does not currently allow the identified `exports` to be used to
define a so-called "mixin." This is problematic because the mixin is the
most appropriate type for describing the relationship between Cheerio's
internal modules and the Cheerio object. A fix has been implemented and
submitted upstream [2]; update this project's dependencies to rely on
the patched version.

[1] gajus/eslint-plugin-jsdoc#96
[2] jsdoc/jsdoc#1575
@gajus
Copy link
Owner

gajus commented Oct 9, 2018

Can you raise a PR?

jugglinmike added a commit to jugglinmike/cheerio that referenced this issue Oct 14, 2018
@jugglinmike
Correct structure of generated documentation
3bfe9f2 
Reformat the project source to ensure proper organization of the
procedurally-generated API documentation. This includes documenting
aliased methods independently (e.g. `cheerio.html` and `$.html`) and
accurately communicating the distinction between the Cheerio module and
the Cheerio class.

This change uses the `hideconstructor` JSDoc "tag" name in order to
discourage the use of a low-level function. The linting rules do not
currently recognize the tag, so this patch also adds explicit
configuration to allow it. This may be removed if the linting tool is
patched with support [1].

JSDoc does not currently allow the identified `exports` to be used to
define a so-called "mixin." This is problematic because the mixin is the
most appropriate type for describing the relationship between Cheerio's
internal modules and the Cheerio object. A fix has been implemented and
submitted upstream [2]; update this project's dependencies to rely on
the patched version.

[1] gajus/eslint-plugin-jsdoc#96
[2] jsdoc/jsdoc#1575
jugglinmike added a commit to jugglinmike/cheerio that referenced this issue Oct 21, 2018
@jugglinmike
Correct structure of generated documentation
7455713 
Reformat the project source to ensure proper organization of the
procedurally-generated API documentation. This includes documenting
aliased methods independently (e.g. `cheerio.html` and `$.html`) and
accurately communicating the distinction between the Cheerio module and
the Cheerio class.

This change uses the `hideconstructor` JSDoc "tag" name in order to
discourage the use of a low-level function. The linting rules do not
currently recognize the tag, so this patch also adds explicit
configuration to allow it. This may be removed if the linting tool is
patched with support [1].

JSDoc does not currently allow the identified `exports` to be used to
define a so-called "mixin." This is problematic because the mixin is the
most appropriate type for describing the relationship between Cheerio's
internal modules and the Cheerio object. A fix has been implemented and
submitted upstream [2]; update this project's dependencies to rely on
the patched version.

[1] gajus/eslint-plugin-jsdoc#96
[2] jsdoc/jsdoc#1575
fb55 pushed a commit to cheeriojs/cheerio that referenced this issue Nov 1, 2018
@jugglinmike @fb55
Correct structure of generated documentation
dbe3320 
Reformat the project source to ensure proper organization of the
procedurally-generated API documentation. This includes documenting
aliased methods independently (e.g. `cheerio.html` and `$.html`) and
accurately communicating the distinction between the Cheerio module and
the Cheerio class.

This change uses the `hideconstructor` JSDoc "tag" name in order to
discourage the use of a low-level function. The linting rules do not
currently recognize the tag, so this patch also adds explicit
configuration to allow it. This may be removed if the linting tool is
patched with support [1].

JSDoc does not currently allow the identified `exports` to be used to
define a so-called "mixin." This is problematic because the mixin is the
most appropriate type for describing the relationship between Cheerio's
internal modules and the Cheerio object. A fix has been implemented and
submitted upstream [2]; update this project's dependencies to rely on
the patched version.

[1] gajus/eslint-plugin-jsdoc#96
[2] jsdoc/jsdoc#1575
@gajus gajus closed this as completed in 68093e3 Mar 14, 2019
gajus added a commit that referenced this issue Mar 14, 2019
@gajus
feat: add support for @hideconstructor tag (fixes #96)
692d4b9 
feat: add support for @hideconstructor tag (fixes #96)
@gajus
Copy link
Owner

gajus commented Mar 14, 2019

🎉 This issue has been resolved in version 4.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Mar 14, 2019
@jugglinmike
Copy link
Author

Thanks!

fb55 pushed a commit to cheeriojs/cheerio that referenced this issue Sep 10, 2020
@jugglinmike @fb55
Correct structure of generated documentation
d38dd85 
Reformat the project source to ensure proper organization of the
procedurally-generated API documentation. This includes documenting
aliased methods independently (e.g. `cheerio.html` and `$.html`) and
accurately communicating the distinction between the Cheerio module and
the Cheerio class.

This change uses the `hideconstructor` JSDoc "tag" name in order to
discourage the use of a low-level function. The linting rules do not
currently recognize the tag, so this patch also adds explicit
configuration to allow it. This may be removed if the linting tool is
patched with support [1].

JSDoc does not currently allow the identified `exports` to be used to
define a so-called "mixin." This is problematic because the mixin is the
most appropriate type for describing the relationship between Cheerio's
internal modules and the Cheerio object. A fix has been implemented and
submitted upstream [2]; update this project's dependencies to rely on
the patched version.

[1] gajus/eslint-plugin-jsdoc#96
[2] jsdoc/jsdoc#1575
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement released
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jugglinmike @gajus