Neat Paraskavedekatriaphobia's Meaning

npm

Need private packages and team management tools?Check out npm Orgs. »

leasot

9.1.0 • Public • Published



Leasot


Leasot

Intelligently parse and output TODOs and FIXMEs from comments in your files

npm npm downloads Travis (.org) code style: prettier

Easily extract, collect and report TODOs and FIXMEs in your code. This project uses regex in order to extract your todos from comments.

Basic output example of leasot

Comment format

TODO: add some info

  • Spaces are optional.
  • Colon is optional.
  • Must be in a comment (line or block) in its' own line (some code(); //TODO: do something is not supported).
  • Can be prefixed with a @ (i.e @TODO).
  • Spaces are trimmed around comment text.
  • Supported default types are TODO and FIXME - case insensitive.
  • Additional types can be added (using tags in cli and customTags in leasot.parse)
  • New extensions can be associated with bundled parsers as many languages have overlapping syntax
  • Supports both leading and trailing references. Examples:
    • // TODO(tregusti): Make this better
    • // TODO: Text /tregusti

Supported languages

Filetype Extension Notes Parser Name
C# .cs Supports // and /* */ comments. defaultParser
C++/C .cpp .c .h Supports // and /* */ comments. defaultParser
Coffee-React .cjsx Supports # comments. coffeeParser
Coffeescript .coffee Supports # comments. coffeeParser
Crystal .cr Supports # comments. coffeeParser
CSon .cson Supports # comments. coffeeParser
CSS .css Supports /* */ comments. defaultParser
EJS .ejs Supports <!-- --> and <%# %> ejsParser
Erb .erb Supports <!-- --> and <%# %> ejsParser
Erlang .erl .hrl Supports % comments. erlangParser
Go .go Supports // and /* */ comments. defaultParser
Haml .haml Supports / -# <!-- --> and <%# %> twigParser
Handlebars .hbs .handlebars Supports {{! }} and {{!-- --}} hbsParser
Haskell .hs Supports -- haskellParser
Hogan .hgn .hogan Supports {{! }} and {{!-- --}} hbsParser
HTML .html .htm Supports <!-- --> twigParser
Jade .jade .pug Supports // and //- comments. jadeParser
Java .java Supports // and /* */ comments defaultParser
Javascript .js .es .es6 Supports // and /* */ comments defaultParser
Jsx .jsx Supports // and /* */ comments. defaultParser
Kotlin .kt Supports // and /* */ comments. defaultParser
Latex .tex Supports \begin{comment} and % comments latexParser
Less .less Supports // and /* */ comments. defaultParser
Markdown .markdown, .md Supports <!-- --> twigParser
Mustache .mustache Supports {{! }} and {{!-- --}} hbsParser
Nunjucks .njk Supports {# #} and <!-- --> twigParser
Objective-C .m Supports // and /* */ comments defaultParser
Objective-C++ .mm Supports // and /* */ comments defaultParser
Pascal .pas Supports // and { } comments. pascalParser
Perl .pl, .pm Supports # comments. coffeeParser
PHP .php Supports // and /* */ comments. defaultParser
Protocol Buffer .proto Supports // and /* */ comments. defaultParser
Python .py Supports """ and # comments. pythonParser
Ruby .rb Supports # comments. coffeeParser
Rust .rs Supports // and /* */ comments. defaultParser
Sass .sass .scss Supports // and /* */ comments. defaultParser
Scala .scala Supports // and /* */ comments. defaultParser
Shell .sh .zsh .bash Supports # comments. coffeeParser
SilverStripe .ss Supports <%-- --%> comments. ssParser
SQL .sql Supports -- and /* */ comments defaultParser & haskellParser
Stylus .styl Supports // and /* */ comments. defaultParser
Swift .swift Supports // and /* */ comments. defaultParser
Svelte .svelte Supports // /* */ <!-- --> comments. twigParser
Twig .twig Supports {# #} and <!-- --> twigParser
Typescript .ts, .tsx Supports // and /* */ comments. defaultParser
Vue .vue Supports // /* */ <!-- --> comments. twigParser
Yaml .yaml .yml Supports # comments. coffeeParser

Javascript is the default parser. PRs for additional filetypes is most welcomed!!

Usage in command line

npm install --global leasot

Command line help

$ leasot --help
 
Usage: leasot [options] <file ...>
 
Parse and output TODOs and FIXMEs from comments in your files
 
Options:
  -V, --version                        output the version number
  -A, --associate-parser [ext,parser]  associate unknown extensions with bundled parsers (parser optional / default: defaultParser) (default: {})
  -i, --ignore <patterns>              add ignore patterns (default: [])
  -I, --inline-files                   parse possible inline files (default: false)
  -r, --reporter [reporter]            use reporter (table|json|xml|markdown|vscode|raw) (default: table) (default: "table")
  -S, --skip-unsupported               skip unsupported filetypes (default: false)
  -t, --filetype [filetype]            force the filetype to parse. Useful for streams (default: .js)
  -T, --tags <tags>                    add additional comment types to find (alongside todo & fixme) (default: [])
  -x, --exit-nicely                    exit with exit code 0 even if todos/fixmes are found (default: false)
  -h, --help                           output usage information
 
Examples:
    # Check a specific file 
    $ leasot index.js
 
    # Check php files with glob 
    $ leasot '**/*.php'
 
    # Check multiple different filetypes 
    $ leasot 'app/**/*.js' test.rb
 
    # Use the json reporter 
    $ leasot --reporter json index.js
 
    # Search for REVIEW comments as well 
    $ leasot --tags review index.js
 
    # Add ignore pattern to filter matches 
    $ leasot 'app/**/*.js' --ignore '**/custom.js'
 
    # Search for REVIEW comments as well 
    $ leasot --tags review index.js
 
    # Check a stream specifying the filetype as coffee 
    $ cat index.coffee | leasot --filetype .coffee
 
    # Report from leasot parsing and filter todos using `jq` 
    $ leasot 'tests/**/*.styl' --reporter json | jq 'map(select(.tag == "TODO"))' | leasot-reporter
 
    # Associate a parser for an unknown extension` 
    $ leasot -A '.svelte,twigParser' -A '.svelte,defaultParser' 'frontend/*.svelte'

Usage in NPM scripts

Use leasot -x in order to prevent exiting with a non-zero exit code. This is a good solution if you plan to run leasot in a CI tool to generate todos.

{
    "scripts": {
        "todo": "leasot 'src/**/*.js'",
        "todo-ci": "leasot -x --reporter markdown 'src/**/*.js' > TODO.md"
    },
    "devDependencies": {
        "leasot": "^7.0.0"
    }
}

Programmatic Installation

npm install --save-dev leasot

Programmatic Examples

const fs = require('fs');
const leasot = require('leasot');
 
const contents = fs.readFileSync('./contents.js', 'utf8');
// get the filetype of the file, or force a special parser
const filetype = path.extname('./contents.js');
// add file for better reporting
const file = 'contents.js';
const todos = leasot.parse(content, { extension: filetype, filename: file });
 
// -> todos now contains the array of todos/fixme parsed
 
const output = leasot.reporter(todos, 'json', { spacing: 2 });
 
console.log(output);
// -> json output of the todos

Leasot with build tools

API

const leasot = require('leasot');

See main exported functions

Mainly, you should be using 2 functions:

  • parse for parsing file contents
  • report for reporting the todos

Type documentation

Built-in Reporters

See built-in reporters

License

MIT © Gilad Peleg

install

npm i leasot

Downloadsweekly downloads

12,835

version

9.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability