automatic-semicolon-insertion - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "automatic-semicolon-insertion",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Insert missing semicolons, remove unneeded ones.",
@@ -5,0 +5,0 @@ "main": "dist/automatic-semicolon-insertion.js",

README.md

@@ -11,10 +11,26 @@ # automatic-semicolon-insertion [![Build Status](https://travis-ci.org/decaffeinate/coffee-lex.svg?branch=master)](https://travis-ci.org/decaffeinate/coffee-lex)
 
+If you're using an AST from babel (babylon) you can also install
+`ast-processor-babylon-config` to make it easier. Otherwise you'll have
+to implement the expected methods yourself.
+
 ## Usage
 
-The main `lex` function simply returns a list of tokens:
-
 ```js
 import asi from 'automatic-semicolon-insertion';
+import buildConfig from 'ast-processor-babylon-config';
+import { parse } from 'babylon';
 
+let source = 'let a = class {}'; // should have a semicolon after it
+let ast = parse(source);
+let config = buildConfig(source, ast);
 
+asi(config);
+let { insertions, removals } = config;
+console.log({ insertions, removals });
+
+/*
+prints:
+
+{ insertions: [ { index: 16, content: ';' } ], removals: [] }
+*/
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9700

increased by5.61%

Number of lines in readme file

36

increased by80%

No dependency changes