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.

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

Repo: (ast-utils) Mention behavior around symbols in JSDoc for getStaticValue #8392

Closed
kirkwaiblinger opened this issue Feb 6, 2024 · 0 comments · Fixed by #8625
Closed

Repo: (ast-utils) Mention behavior around symbols in JSDoc for getStaticValue #8392

kirkwaiblinger opened this issue Feb 6, 2024 · 0 comments · Fixed by #8625
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating good first issue Good for newcomers repo maintenance things to do with maintenance of the repo, and not with code/docs

Comments

@kirkwaiblinger
Copy link
Member

Suggestion

I discovered in #8390 that getStaticValue considers Symbol.for('static value') a static value, but does not consider Symbol('not static') a static value.

That makes sense if you think about it, but it's not obvious. I think it would be helpful to call that out explicitly in the JSDoc.

Note, looking at the JSDoc, though, it seems to be more or less copied from https://eslint-community.github.io/eslint-utils/api/ast-utils.html#getstaticvalue, which makes sense. so I've opened an issue in that repo as well, eslint-community/eslint-utils#196.
@kirkwaiblinger kirkwaiblinger added repo maintenance things to do with maintenance of the repo, and not with code/docs triage Waiting for maintainers to take a look labels Feb 6, 2024
@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers documentation Documentation ("docs") that needs adding/updating accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Feb 8, 2024
@developer-bandi developer-bandi mentioned this issue Mar 8, 2024
Merged
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating good first issue Good for newcomers repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(utils): edit getStaticValue function JSDoc description developer-bandi/typescript-eslint
2 participants
@JoshuaKGoldberg @kirkwaiblinger