leasot - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

lib/parsers.js

@@ -27,2 +27,8 @@ 'use strict';
         return require('./parsers/coffeeParser');
+    },
+    '.less': function () {
+        return require('./parsers/defaultParser');
+    },
+    '.jsx': function () {
+        return require('./parsers/defaultParser');
     }
@@ -29,0 +35,0 @@ };

package.json

 {
   "name": "leasot",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Parse and output TODOs and FIXMEs from comments in your files",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -116,14 +116,57 @@ # leasot
 
-### isExtSupported
+### .isExtSupported(extension)
 
-TODO
+Check whether extension is supported by parser.
 
-### parse
+Specify an extension including the prefixing dot, for example:
 
-TODO
+`leasot.isExtSupported('.js'); //-> true`
 
-### reporter
+**Returns**: `Boolean`
 
-TODO
+### .parse(extension, contents, filename)
 
+Parse the contents, using the provided `extension`. `filename` will be attached
+to the return object, so it is recommended to use it if you know it.
+
+`extension` is the extension to parse as, including a prefixing dot.
+
+`contents` is a string containing the contents to parse.
+
+`filename` is an optional string.
+
+**Returns**: `Array` of comments.
+
+```js
+[{
+    file: 'parsedFile.js',
+    text: 'comment text',
+    kind: 'TODO',
+    line: 8
+}]
+```
+
+### .reporter(comments, config)
+
+Use the specified reporter to report the comments.
+
+`comments` is the array of comments received from `leasot.parse()`.
+
+`config` is an object that will also be passed to the reporter itself (allowing custom options for each reporter).
+
+It may also contain the specified reporter:
+
+#### config.reporter
+
+Can be a string indicating the [built-in reporter](#built-in-reporters) to use,
+ or an external library used as a reporter.
+
+Could also be a custom function `(comments, config)`
+
+**Type**: `String|Function`
+
+**Required**: `false`
+
+**Default**: `raw`
+
 ## Built-in Reporters
@@ -159,5 +202,5 @@
 
-**Default**: 2
+**Default**: `2`
 
-**Minimum**: 0
+**Minimum**: `0`
 
@@ -164,0 +207,0 @@ ### transformHeader(kind)

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23909

6.22%

Lines of code

471

1.29%

Number of lines in readme file

299

16.8%

No dependency changes