babel-plugin-syntax-trailing-function-commas - npm Package Compare versions

Comparing version 6.13.0 to 6.20.0

package.json

 {
   "name": "babel-plugin-syntax-trailing-function-commas",
-  "version": "6.13.0",
+  "version": "6.20.0",
   "description": "Compile trailing function commas to ES5",
@@ -5,0 +5,0 @@ "repository": "https://github.com/babel/babel/tree/master/packages/babel-plugin-syntax-trailing-function-commas",

README.md

@@ -5,6 +5,88 @@ # babel-plugin-syntax-trailing-function-commas
 
+
+```js
+function clownPuppiesEverywhere(
+  param1,
+  param2,
+) { /* ... */ }
+
+clownPuppiesEverywhere(
+  'foo',
+  'bar',
+);
+```
+[Try in REPL](http://babeljs.io/repl/#?evaluate=true&presets=es2015%2Cstage-0&code=function%20clownPuppiesEverywhere(%0A%20%20param1%2C%0A%20%20param2%2C%0A)%20%7B%20%2F*%20...%20*%2F%20%7D%0A%0AclownPuppiesEverywhere(%0A%20%20'foo'%2C%0A%20%20'bar'%2C%0A)%3B)
+
+## Example
+
+### Basic
+This is an example from the [Proposal](https://github.com/jeffmo/es-trailing-function-commas).
+
+Let's say you have this function:
+
+```js
+function clownPuppiesEverywhere(
+  param1,
+  param2
+) { /* ... */ }
+
+clownPuppiesEverywhere(
+  'foo',
+  'bar'
+);
+```
+
+If you want to have a new parameter called `param3`, the diff output would be like that:
+
+```diff
+function clownPuppiesEverywhere(
+  param1,
+- param2
++ param2, // Change this line to add a comma
++ param3  // Add param3
+) { /* ... */ }
+
+clownPuppiesEverywhere(
+  'foo',
+- 'bar'
++ 'bar', // Change this line to add a comma
++ 'baz'  // Add param3
+);
+```
+In total, you have to change 2 lines for the function declaration and 2 lines for each usage.
+
+If you had your function defined with trailing commas:
+
+```js
+function clownPuppiesEverywhere(
+  param1,
+  param2,
+) { /* ... */ }
+
+clownPuppiesEverywhere(
+  'foo',
+  'bar',
+);
+```
+Adding a new parameter would only change one line in the function declaration and one line for each usage:
+
+```diff
+function clownPuppiesEverywhere(
+  param1,
+  param2,
++ param3, // Add param3
+) { /* ... */ }
+
+clownPuppiesEverywhere(
+  'foo',
+  'bar',
++ 'baz', // Add param3
+);
+```
+In the end, your diff output will be cleaner and easier to read, it would be much quicker to add a new parameter to your functions, it also makes it easier to copy paste elements and move code around.
+
 ## Installation
 
 ```sh
-$ npm install babel-plugin-syntax-trailing-function-commas
+npm install --save-dev babel-plugin-syntax-trailing-function-commas
 ```
@@ -27,3 +109,3 @@
 ```sh
-$ babel --plugins syntax-trailing-function-commas script.js
+babel --plugins syntax-trailing-function-commas script.js
 ```
@@ -38,1 +120,7 @@
 ```
+
+## References
+
+* [Proposal](https://github.com/jeffmo/es-trailing-function-commas)
+* [Spec](http://jeffmo.github.io/es-trailing-function-commas/)
+* [Why you should enforce Dangling Commas for Multiline Statements](https://medium.com/@nikgraf/why-you-should-enforce-dangling-commas-for-multiline-statements-d034c98e36f8)

New alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3353

78.16%

Number of lines in readme file

124

244.44%

Worsened metrics

Number of package files

4

-71.43%

Lines of code

9

-72.73%

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes