quarto-dev / quarto-dev/quarto

ENH: Word count for Quarto VS Code Extension

Open
#717 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
645
Forks
62
Avg merge
17h 42m
Merged PRs (30d)
13

Description

The Microsoft word count extension for VS Code is more of an example extension, despite its large install base and use. Since Quarto is often used for writing documents, it would be nice to have functional and improved word counts available as a standard feature for qmd documents in its extension.

A basic feature list could look like this:

  1. Overall document word count
    • Exclusions: may warrant discussion, but it seems like YAML should be excluded and perhaps code blocks.
    • Includes: references (would need to be calculated or at least approximated). For example, I'm writing a book chapter now, and my specs include a word count for references.
  2. Selection word count.
  3. Section word count. It would be nice to have word counts by section that count everything nested under that section heading. It may be possible to do this in a outline pane or maybe as a popover to the word count in the status bar.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; start by locating the Quarto VS Code extension’s handling of qmd documents and status-bar counts. Define and validate overall, selection, and nested section counts, including agreed treatment of YAML, code blocks, and references.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.