It would be nice if the average read time were output in addition to the word count. A wordsReadPerMinute setting could be exposed to configure it (defaulting to 200).

Typically in a Markdown writing scenario word count and average read time go hand in hand.

Is the /(< ([^>]+)<)/g regex trying to delete HTML tags so they are not counted as words? Or its it doing something else I don't see?

Also: .replace(/^\s\s*/, '').replace(/\s\s*$/, '') does the same as .trim()

Hello 👋 I'm from the VS Code team.

Recently, we have been exploring a security feature we refer to as Workspace Trust. This feature is intended to centralize and unify a security conscious decision required by a variety of VS Code features. With workspace trust, the user will be able to declare whether or not they trust the folder that is opened in VS Code before these features are executed.

Why you should care

Your extension is incredibly popular with VS Code users! We want to make sure that those users have a delightful experience with workspace trust and that includes extension authors deciding how much of their extension is supported in an untrusted workspace.

Workspace Trust experience

You can enable the feature with the following setting security.workspace.trust.enabled. Once enabled, you will see the following dialog when opening folders in VS Code.

This dialog is important for allowing the user to make a decision early and understand the impact of their decision. Once you understand the feature, you may want to customize when to display the dialog using the setting security.workspace.trust.startupPrompt.

You can follow the development of Workspace Trust and provide feedback in issue #106488.

Workspace trust API

First off, all of what I am about to say can be found in issue #120251. That issue will include discussion of the feature and any updates to the feature.

The Workspace Trust extension API is now in stable. This allowed us to release the first cut of our guide for onboarding your extension to Workspace Trust. The API is small, so here is a quick look.

You can declare your extension to provide complete, partial or no support in untrusted workspaces using the untrustedWorkspaces capability in package.json.

The following example declares that the extension is supported completely in untrusted workspaces. In this case, the extension is enabled in untrusted workspaces.

"capabilities": {
  "untrustedWorkspaces": {
    "supported": true
  }
}

The next example declares that the extension is not supported in untrusted workspaces. In this case, the extension is disabled in untrusted workspaces.

"capabilities": {
  "untrustedWorkspaces": {
    "supported": false
  }
}

The third option is to declared limited support. There are three tools provided to you when you select the limited option.

First, if you have a setting that can be configured in the workspace but requires the workspace to be trusted in order to apply the workspace value, then you can include the setting using restrictedConfigurations array property in untrustedWorkspaces object. Doing so, VS Code will ignore the workspace value of these restricted settings when your extension reads these settings values using the VS Code Workspace Configuration API.

The following example declares the settings that are restricted in untrusted workspaces.

"capabilities": {
  "untrustedWorkspaces": {
    "supported": "limited",
    "restrictedConfigurations": [
      "markdown.styles"
    ]
  }
}

Next, you can also check and listen if the current workspace is trusted or not programmatically using the following API:

export namespace workspace {
  /**
   * When true, the user has explicitly trusted the contents of the workspace.
   */
  export const isTrusted: boolean;
  /**
   * Event that fires when the current workspace has been trusted.
   */
  export const onDidGrantWorkspaceTrust: Event<void>;
}

Lastly, you can hide commands or views declaratively with the isWorkspaceTrusted context key in your when clauses.

A far more detailed guide on how to onboard which will be updated as we receive feedback can be found in issue #120251.

Rollout plan

Workspace Trust will remain disabled for the month of May, but we are planning on enabling this by default in the future. To prepare for that day, we would love for you to try it out and provide feedback.

We'd love your feedback

Since this issue was created in an automated fashion, we won't be monitoring the responses in this issue (our notifications would explode!). Instead we ask you to drop questions, and feedback in issue #120251 as we've mentioned above.

We're excited to see what you do with workspace trust!

Hi,

I was trying to run the testing with command

mocha out/test

but got this error

Error: Cannot find module 'vscode'
    at Function.Module._resolveFilename (module.js:336:15)
    at Function.Module._load (module.js:286:25)
    at Module.require (module.js:365:17)
    at require (module.js:384:17)
    at Object.<anonymous> (/Users/deerawan/Work/Sites/opensource/vscode-wordcount/out/test/extension.test.js:10:14)
    at Module._compile (module.js:434:26)
    at Object.Module._extensions..js (module.js:452:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Module.require (module.js:365:17)
    at require (module.js:384:17)
    at /usr/local/lib/node_modules/mocha/lib/mocha.js:216:27
    at Array.forEach (native)
    at Mocha.loadFiles (/usr/local/lib/node_modules/mocha/lib/mocha.js:213:14)
    at Mocha.run (/usr/local/lib/node_modules/mocha/lib/mocha.js:453:10)
    at Object.<anonymous> (/usr/local/lib/node_modules/mocha/bin/_mocha:393:18)
    at Module._compile (module.js:434:26)
    at Object.Module._extensions..js (module.js:452:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Function.Module.runMain (module.js:475:10)
    at startup (node.js:118:18)
    at node.js:952:3

This works perfectly fine but I'd love for it to have MDX support or Markdown React type association.

The extension description in the VSCode marketplace has a typo:

"Markdown Word Count Example - a status bar contribution that reports out the number of works in a Markdown document as you interact with it."

I assume works should be words :)

It doesn't work well with Chinese

vscode: 1.3.0 - insider
os: win10 build 14367

This would be very much appreciated, as headings often don't count toward length requirements.

It would be nice if we had the option to ignore frontmatter when doing a wordcount.

Are you planning to add support of TeX in the extension?
Thanks in advance.

Hello,

I would love to see the ability to select a couple of paragraphs and have the word count reflect the number of words contained in the selection.

Thanks,
Michael.

path.join(__dirname, '..', '..', 'vsc-extension-quickstart2.md')).

The filename in the word count project is vsc-extension-quickstart.md without the number 2.

I am a technical writer, and even when I'm not doing technical writing, I use VSCode for my writing, so a good word count is pretty essential to me.

If you search for word count, this is the first extension that shows. But it is missing some features that make it accurate, such as the ability to include/exclude code, comments, etc… And there are issues and PRs open that have never been acted on. I guess because this is mostly just an example repo.

I've wanted to update this for some time and make a really usable word count for VS Code. So I made a fork here (https://github.com/ChrisChinchilla/vscode-wordcount) that I intend to maintain and release properly. If anyone wants to move their contributions there, please do, and if this issue ends up bringing life back into this extension instead, then great!

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Markdown Word Count Example - a status bar contribution that reports out the number of works in a Markdown document as you interact with it.

I presume it should be words...

• Yep seems like it was fixed in 950ccf9 but the market version is an older one (at least <2015)

It would be great if you could highlight a section and automatically get a wordcount for only that section.

It would also be awesome if it automatically ignored comments (currently, it will actually count the <!-- and --> as individual words).

It would be great if when selecting an area of text within a larger document, Word Count updated to show the count inside the user text selection. Removing the selection would revert the display back to the count for the entire document.

Languages like Spanish use diacritcs regularly. They are (wrongly) counted as word separators.

I am following documentation below;
https://code.visualstudio.com/docs/extensions/example-word-count#_update-the-status-bar

If I use code snippet at the page, or here I am getting following error:

message: 'Property '_statusBarItem' has no initializer and is not definitely assigned in the constructor.'

VS Code configured to use TypeScript 2.7.2.

Am I missing something here?

Error SS:

👋 Hi there, Martin here, from the VS Code team.

Recently we've announced the Remote Repository feature that lets you browse and edit files and folders directly on GitHub.

Open Remote Repository... opens VSCode on a folder or workspace located on a virtual file system. We call this a virtual workspace. We observed that not all extension support this well, either because they can not, or they haven't thought about it.

It would be fantastic if you could test whether your extension can handle virtual workspaces:

Check out the Virtual Workspaces Extension Author Guide on how to do that.

When done, set the new virtualWorkspaces capability in your 'package.json'.

{
  "capabilities": {
    "virtualWorkspaces": true | false
  }
}

• Use "virtualWorkspaces": true if your extension is prepared for virtual workspaces
• Use "virtualWorkspaces": false if your extension should be disabled when a virtual workspace is opened

For questions and comments please use the Virtual Workspaces Tracking Issue.

Thanks for the support and the great work! ❤️

How to reproduce:

• Start a line with a number
• Select this number
• Increment it by one

Expected result:
The selected number is incremented by one

Effective result:
The extension failed