Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

broccoli-leasot

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

broccoli-leasot

A broccoli plugin which wraps around the leasot module to parse and output TODOs and FIXMEs from comments in your files

  • 1.6.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
decreased by-20%
Maintainers
1
Weekly downloads
 
Created
Source

broccoli-leasot

A broccoli plugin for the leasot module to parse and output markers like TODOs and FIXMEs from comments

Repo health & stats

Build Status Build status Code Climate Test Coverage Ember Observer Score

Dependency Status devDependency Status

Installation

npm install --save-dev broccoli-leasot

Screenshot

Ember inspector's markers

Usage

var broccoliLeasot = require('broccoli-leasot');
var tree = broccoliLeasot(someTree, options);

As a Ember CLI Addon, simply npm install --save-dev broccoli-leasot and supply the options you would like:

var app = new EmberApp({
  markers: {
    enabled: true,
    kinds: [ 'TODO', 'FIXME', 'CUSTOM']
  }
});

Documentation

broccoliLeasot(inputTree, options)


options.enabled {true|false}

This will eliminate processing altogether.

Default: false


options.extensions Array of file types to scan

This indicates the files with specific extensions to be scanned. The complete list can be seen at the leasot repo

Default: ['js', 'css', 'less', 'scss', 'hbs', 'handlebars']


options.kinds Array of markers

These are the markers looked up in the comments of the files which are scanned.

Default: ['TODO', 'FIXME']


options.groupBy file|kind

The broccoli plugin prints the analysis of leasot on the console. Users can choose between grouping markers by file name or kind of marker.

Default: file


Development

This plugin is all about productivity so its written in es6/2015 with the help of babel.js. The plugin code is at src/index.js. To see the compiled code run npm run compile and look at the content of lib\index.js

Interested in using babel for your next npm module, read this excellent article on this.

Tests

Running the tests:

npm install
npm test

Keywords

FAQs

Package last updated on 02 Feb 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc