Vscode-annotations is an extension for Visual Studio Code that will help you to add annotations in your Javascript projects
JavaScript
Permalink
Failed to load latest commit information.
.vscode retrieved the annotations from a list of file, missing the output pan… Jan 30, 2017
examples
images added logo to the extension Jan 31, 2017
src update filename in Markdwon output Jan 31, 2017
test first commit Jan 15, 2017
.eslintrc.json first commit Jan 15, 2017
.gitignore first commit Jan 15, 2017
.vscodeignore first commit Jan 15, 2017
CHANGELOG.md
README.md update keyworks and release version Jan 31, 2017
extension.js fix on output markdown file Jan 31, 2017
jsconfig.json first commit Jan 15, 2017
npm-debug.log.2892081654 avoiding search in node_modules folder fix Jan 31, 2017
package.json update keyworks and release version Jan 31, 2017

README.md

vscode-annotations

Vscode-annotations is an extension for Visual Studio Code that will help you to add annotations in your Javascript projects for identifying:
. Code to refactor
. Code to fix
. To-do activities

Features

In order to add an annotation in your code you just need to add the following comments:

//refactor: here I need to refactor some code
//fixme: this is an annotation for fixing some code!
//todo: adding stuff to do

therefore you can add to your javascript code the following annotations:

//refactor:
//fixme:
//todo:

The annotation are recognised if are in a single line and written as above (e.g. //fixme: not // fixme:). This is the output that you will see inside the panel

In order to list all the annotations in a specific file or in all the files of the projects you will need to follow these instructions:

  1. open your Javascript project or javascript file with Visual Studio Code
  2. CMD + SHIFT + P will open the Command Palette (you can also open via the menu View > Command Palette)
  3. search for ANNOTATION and choose the action you want to perform

At the moment you can perform the following things:

. retrieve annotations for a single javascript file
. retrieve annotations for the entire project
. export annotations to a markdown file

Requirements

Please install the annotations extension via the extensions panel in Visual Studio Code

Release Notes

0.1.6

. fix bug on check project folder
. fix bug on export markdown file
. improve markdown file readability

0.1.0

Initial release of vscode-annotations.
. adding following annotations: FIXME, REFACTOR or TODO
. the extension will allow you to list the annotations in the "Annotations panel"

Next Features

. adding fileswatcher API in order to run the check on files automatically . exporting annotations directly to README file

Suggestion

For a better readability I suggest to install, in combination with vscode-annotations, the IBM output panel colorful extension: https://marketplace.visualstudio.com/items?itemName=IBM.output-colorizer