Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

symbol-description: allow feature identifier tagging

See original GitHub issue

What rule do you want to change? symbol-description

Does this change cause the rule to produce more or fewer warnings? Fewer, if the empty symbol is a key of an object and it’s value is another symbol, for example, used to tag an object by its provider id (the module providing the feature).

It can provide a way, for developers, to easily identify where the features on an object come from, for debugging purpose, without any conflict risks.

How will the change be implemented? (New option, new default behavior, etc.)? new default behavior

Please provide some example code that this change will affect:

export default {
  [Symbol()]: Symbol(myModuleId)

What does the rule currently do for this code? Triggers an error.

What will the rule do after it’s changed? Ignore in case of.

Are you willing to submit a pull request to implement this change? If needed.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:1
  • Comments:18 (7 by maintainers)

github_iconTop GitHub Comments

platinumazurecommented, Nov 7, 2019

I think at the very least, this shouldn’t be a new default behavior and would need to be an option.

Personally, the proposal feels very specific and as @ljharb notes, is not a universal convention by any means. So I think making any modification to this rule in ESLint core would just confuse other users.

You could use eslint-rule-composer to create a custom rule based off of this rule, and use the filterReports method to remove lint messages that correspond to property keys which have a Symbol with description as the property value.

eslint-deprecated[bot]commented, Dec 9, 2019

Unfortunately, it looks like there wasn’t enough interest from the team or community to implement this change. While we wish we’d be able to accommodate everyone’s requests, we do need to prioritize. We’ve found that issues failing to reach accepted status after 21 days tend to never be accepted, and as such, we close those issues. This doesn’t mean the idea isn’t interesting or useful, just that it’s not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.

Read more comments on GitHub >

github_iconTop Results From Across the Web

GTK-Doc Format Primer - GObject Introspection
For example, putting a tag part before the symbol description part is ... the start of a GTK-Doc comment block on line 1;...
Read more >
Symbol type - The Modern JavaScript Tutorial
id is a symbol with the description "id" let id = Symbol("id"); ... Or get symbol.description property to show the description only: let...
Read more >
Projects/GObjectIntrospection/Annotations - GNOME Wiki!
For example, putting a tag part before the symbol description part ... the start of a GTK-Doc comment block on line 1; the...
Read more >
About auto-tagging - Google Ads Help
Auto-tagging is a required feature, which when used with Google Ads conversion tracking or Google Analytics, allows you to see how effectively your...
Read more >
Language Server Protocol Specification - 3.17
All new 3.17 features are tagged with a corresponding since version 3.17 text or in ... The token is different than the request...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found