markdown-escape - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

index.js

 var replacements = [
-  [ /\*/g, '\\*' ],
-  [ /#/g, '\\#' ],
-  [ /\//g, '\\/' ],
-  [ /\(/g, '\\(' ],
-  [ /\)/g, '\\)' ],
-  [ /\[/g, '\\[' ],
-  [ /\]/g, '\\]' ],
-  [ /\</g, '&lt;' ],
-  [ /\>/g, '&gt;' ],
-  [ /_/g, '\\_' ] ]
+  [/\*/g, '\\*', 'asterisks'],
+  [/#/g, '\\#', 'number signs'],
+  [/\//g, '\\/', 'slashes'],
+  [/\(/g, '\\(', 'parentheses'],
+  [/\)/g, '\\)', 'parentheses'],
+  [/\[/g, '\\[', 'square brackets'],
+  [/\]/g, '\\]', 'square brackets'],
+  [/</g, '&lt;', 'angle brackets'],
+  [/>/g, '&gt;', 'angle brackets'],
+  [/_/g, '\\_', 'underscores']
+]
 
-module.exports = function(string) {
-  return replacements.reduce(
-    function(string, replacement) {
-      return string.replace(replacement[0], replacement[1])
-    },
-    string) }
+module.exports = function (string, skips) {
+  skips = skips || []
+  return replacements.reduce(function (string, replacement) {
+    var name = replacement[2]
+    return name && skips.indexOf(name) !== -1
+      ? string
+      : string.replace(replacement[0], replacement[1])
+  }, string)
+}

package.json

 {
   "name": "markdown-escape",
   "description": "escape Markdown control characters",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "author": "Kyle E. Mitchell <[e-mail]> (https://kemitchell.com/)",
+  "files": [
+    "index.js"
+  ],
   "devDependencies": {
-    "jsmd-tape": "^0.1.0",
-    "markdown-it": "^4.4.0",
-    "tape": "^4.0.1"
+    "commonmark": "^0.29.1",
+    "defence-cli": "^3.0.1",
+    "replace-require-self": "^1.1.1",
+    "standard": "^14.3.4"
   },
@@ -19,5 +23,7 @@ "keywords": [
   "scripts": {
-    "pretest": "jsmd-tape README.md | sed 's!markdown-escape!./!' | sed 's!jsmd!README!' > README.js",
-    "test": "tape README.js test.js"
+    "lint": "standard",
+    "test:readme": "defence -i javascript README.md | replace-require-self | node",
+    "test:suite": "node test.js",
+    "test": "npm run test:readme && npm run test:suite"
   }
 }

README.md

@@ -5,3 +5,11 @@ Escape Markdown control characters.
 var escape = require('markdown-escape')
-escape("#1! We're #1!") // => "\\#1! We're \\#1!"
+var assert = require('assert')
+
+assert(escape("#1! We're #1!") === "\\#1! We're \\#1!")
+assert(escape("http://example.com") === 'http:\\/\\/example.com')
+assert(escape('one (1)') === 'one \\(1\\)')
+
+// Skip escaping specific characters.
+assert(escape('one (1)', ['parentheses']) === 'one (1)')
+assert(escape("http://example.com", ['slashes']) === 'http://example.com')
 ```

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

Number of lines in readme file

15

increased by150%

Worsened metrics

Total package byte prevSize

2904

decreased by-1.19%

Dev dependency count

4

increased by33.33%

Number of package files

4

decreased by-33.33%

Lines of code

21

decreased by-4.55%

No dependency changes