Skip to content

Instantly share code, notes, and snippets.

@mikeerickson

mikeerickson/leasot.md

Last active September 30, 2018 16:52
Show Gist options
  • Save mikeerickson/a8f4c5a59fb9687c73f888dea6625dad to your computer and use it in GitHub Desktop.
Save mikeerickson/a8f4c5a59fb9687c73f888dea6625dad to your computer and use it in GitHub Desktop.
Download ZIP
Leasot Integration
Raw
leasot.md

Leasot Workflow

Overview

The following workflow outlines how I use Leasot in my daily workflow w/ VSCode.

Installation

There are two unique parts that I use

  1. Install Leasot

  2. One of the features of Leasot is the ability to generate a formatted markdown file. I use a tool which displays markdown in the terminal called Terminal Markdown Viewer

  3. Next step is to setup an npm task in my package.json or simple terminal script

leasot -x './src/**/*.*s*' --tags review -r vscode > TODO.md && mdv -c 120 TODO.md
  1. If you wish to add custom tags you can do something like (adding idea tag)
leasot -x './src/**/*.*s*' --tags idea review -r vscode > TODO.md && mdv -c 120 TODO.md

This will add idea to the output (TODO and FIXME will always be there)

NOTE: When displaying the source files which contain your tags, you can Command-Click on the source file and it will be opened within VSCode Editor

VSCode Integration

There is a VSCode extension which can be used to help display TODO items, etc.

TODO Highlight will display your desired tags in various colors. I use this in conjunction with the above workflow so I can better identify the tags within my code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment