Code Monkey home page Code Monkey logo

vscode-todo-list's Introduction

TODO List

List all of your TODO-type comments in an easy-to-read tree view panel. Syntax Highlighting and Trello Integration included.

https://marketplace.visualstudio.com/items?itemName=TzachOvadia.todo-list

Usage Example

Table of Contents

Features

Convenient way to view tagged comments

Preview

Remove, Copy & Edit comments easily

Context Menu

Usage

Right-Click a comment in Action Comments -> Remove/Copy/Edit

Insert comment quickly

Press Ctrl + Shift + T to insert a comment in current cursor position.

Comment formatting

Comment Format

Trello Integration - Create Trello card directly from your IDE

Trello Card

Usage

  • Right-Click a comment in Action Comments list -> Create Trello Card.

    On first use, you'll have to supply a token. If you don't have a token, just press Esc and follow the notification instructions.

    Next, you'll need to select a Trello list to create cards in.

  • That's it. The card is created in the list you selected on first use.

Gmail Integration - Send comment to mail recipient

Gmail Integration

Usage

  • Right-Click a comment in Action Comments list -> Send using Gmail.

Supported Comments

TODO List supports any comment written in the next formats:

// <ACTION>: <message>
/* <ACTION>: <message> */
// <ACTION>(NAME): <message>

Examples:

// TODO: Refactor everything
/* FIXME: Please please please */
// HACK(tzach): This is a workaround

Common tags/types:

  • TODO – something to be done.
  • FIXME – should be corrected.
  • HACK – a workaround.
  • BUG – a known bug that should be corrected.
  • UNDONE – a reversal or "roll back" of previous code.

Settings

  • Expression

    RegExp to use for extracting comments (first group must be type, last must be text). We recommend capturing only all-uppercase types to avoid capturing tslint: and commented properties.

    Default: (?:\/\/|\/\*)[ ]?([A-Z]+)(?:\:|\(([A-Za-z\/\d ]+)\)\:)[ ]?(.*)

  • Scan On Save

    Scan comments when saving a file.

    Default: true

  • Exclude

    Glob pattern to exclude from scans.

    Default: {**/node_modules/**,**/bower_components/**,**/dist/**,**/build/**,**/.vscode/**,**/_output/**,**/*.min.*,**/*.map}

  • Name

    Name to use as Created by.

    Default: empty

  • Enable Comment Formatting

    Enable comment formatting (Set color for comment type and make text italic)

    Default: true

  • Trello:Token

    In order to create Trello cards, this extension requires read and write permissions.

    Click here to generate token.

  • Trello:Default List

    List ID to create cards in (will be automatically set on first use)

Supported Languages

This extension currently supports Javascript and Typescript. We'll add support for other languages in the near future.

vscode-todo-list's People

Contributors

calvin-ll avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.