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

harper-ls doesn't check lines that start with JSDoc tags #265

Open
mcecode opened this issue Nov 4, 2024 · 3 comments
Open

harper-ls doesn't check lines that start with JSDoc tags #265

mcecode opened this issue Nov 4, 2024 · 3 comments
Assignees
Labels
bug Something isn't working harper-comments harper-ls

Comments

@mcecode
Copy link
Collaborator

mcecode commented Nov 4, 2024

When harper-ls checks JSDoc comments, it seems to ignore lines that start with JSDoc tags so some descriptions won't be linted. For example, in the snippet below, harper-ls doesn't indicate that "zpelling" is wrong.

/**
 * @param {string} message - Wrong zpelling
 */
function print(message) {
  console.log(message);
}

It works when the description is moved to the next line, like so:

/**
 * @param {string} message
 *   Wrong zpelling
 */
function print(message) {
  console.log(message);
}
@elijah-potter
Copy link
Collaborator

@mcecode, sorry it took so long to get back to you on this. I won't have time this week to get the ball rolling on this. Given your recent forays into the Rust code, might you be interested in tackling thing yourself?

If so, I'd be happy to answer any questions you have on how this stuff works. The problematic code is here.

@mcecode
Copy link
Collaborator Author

mcecode commented Jan 14, 2025

No worries. And sure, I'd be glad to give this a try, thanks for giving me a starting point. I'll drop any questions here if I have any.

@elijah-potter
Copy link
Collaborator

I'll drop any questions here if I have any.

Sounds good! Godspeed.

@mcecode mcecode self-assigned this Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working harper-comments harper-ls
Projects
None yet
Development

No branches or pull requests

2 participants