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

Add word count for markdown files #21263

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

saahityaedams
Copy link
Contributor

@saahityaedams saahityaedams commented Nov 28, 2024

Release Notes:

  • Added word count for markdown files

@cla-bot cla-bot bot added the cla-signed The user has signed the Contributor License Agreement label Nov 28, 2024
@saahityaedams
Copy link
Contributor Author

saahityaedams commented Nov 28, 2024

I've needed to track essay length when writing certain college applications.

Screenshot 2024-11-28 at 9 31 45 AM

@saahityaedams saahityaedams changed the title add word count for markdown files Add word count for markdown files Nov 28, 2024
Copy link
Contributor

@HarshNarayanJha HarshNarayanJha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be wrong, but...

Comment on lines +71 to +73
.text_for_range(selection.start..selection.end)
.map(|t| t.split_whitespace().count())
.sum::<usize>();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my understanding, this snippet will count the exact words in the markdown file, and not the real amount of words rendered by it.
This may include the markup tags, which might be undesirable.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack, t.split_whitespace() will count markdown elements as words, etc and give a rough word count when markdown elements are involved. On the other hand, I don't think getting the exact word count for markdown files is feasible without some convoluted logic.

If the repo maintainers think the word count needs to be more accurate, I can modify the PR (Off the top of my head, I am thinking I just have to sanitise the text before counting the words)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some way to get the text preview that zed generates and count words in that, if that is performant enough.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the text that ends up actually being rendered might be possible with tree-sitter queries?

@Angelk90
Copy link

@saahityaedams : The number of words seems different, I have tried different online services for each the number of words seems different.

Screenshot 2024-11-28 alle 15 45 28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed The user has signed the Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants