front-matter - npm Package Compare versions

Comparing version 0.1.5 to 0.2.0

examples/dashes-seperator.md

@@ -5,3 +5,3 @@ ---
   - yaml
-  - toes
+  - front-matter
   - dashes
@@ -15,2 +15,2 @@ expaned-description: with some --- crazy stuff in it
 
-ALso this shouldn't be a problem
+Also this shouldn't be a problem

examples/missing-body.md

@@ -5,5 +5,5 @@ ---
   - yaml
-  - toes
+  - front-matter
   - dashes
 expaned-description: with some --- crazy stuff in it
 ---

index.js

@@ -1,27 +0,36 @@
-var parser = require('yaml-js')
 
-module.exports = function(string){
-  var body = string
-    , attributes = {}
-    , match = matcher(string, '= yaml =') || matcher(string, '---')
+const parser = require('yaml-js')
+const seperators = [ '---', '= yaml =']
+const pattern = pattern = '^('
+      + '((= yaml =)|(---))'
+      + '$([\\s\\S]*?)'
+      + '\\2'
+      + '$'
+      + (process.platform === 'win32' ? '\\r?' : '')
+      + '(?:\\n)?)'
+const regex = new RegExp(pattern, 'm')
 
-  if (match){
-    attributes = parser.load(match[2].replace(/^\s+|\s+$/g, '')) || {}
-    body = string.replace(match[0], '')
-  }
+module.exports = extractor
+module.exports.test = test
 
+function extractor(string) {
+  string = string || ''
+
+  if (regex.test(string)) return parse(string)
+  else return { attributes: {}, body: string }
+}
+
+function parse(string) {
+  var match = regex.exec(string)
+  var yaml = match[match.length - 1].replace(/^\s+|\s+$/g, '')
+  var attributes = parser.load(yaml) || {}
+  var body = string.replace(match[0], '')
+
   return { attributes: attributes, body: body }
 }
 
-function matcher(string, seperator){
+function test(string){
+  string = string || ''
 
-  var seperator = seperator || '---'
-      , pattern = '^('
-        + seperator
-        + '$([\\s\\S]*?)'
-        + seperator+'$' + (process.platform === 'win32' ? '\\r?' : '') + '(?:\\n)?)'
-      , regex = new RegExp(pattern, 'm')
-      , match = regex.exec(string)
-
-  if (match && match.length > 0) return match
+  return regex.test(string)
 }

package.json

@@ -11,3 +11,3 @@ {
   "license": "MIT",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "homepage": "https://github.com/jxson/front-matter",
@@ -21,3 +21,3 @@ "bugs": "https://github.com/jxson/front-matter/issues",
   "scripts": {
-    "test": "mocha tests/ --reporter spec"
+    "test": "mocha tests/*-test.js --reporter spec"
   },
@@ -31,4 +31,3 @@ "engines": {
   "devDependencies": {
-    "chai": "1.4.2",
-    "mocha": "1.7.4"
+    "mocha": "~1.17.0"
   },
@@ -40,4 +39,5 @@ "contributors": [
     "Jean-Philippe Monette <[e-mail]> (https://github.com/jpmonette)",
-    "Marc-André Arseneault <[e-mail]> (https://github.com/arsnl)"
+    "Marc-André Arseneault <[e-mail]> (https://github.com/arsnl)",
+    "Bret Comnes <[e-mail]> (http://bret.io)"
   ]
 }

README.md

@@ -66,2 +66,10 @@
 
+# fm.test(string)
+
+Check if a string contains a front matter header of "---" or "= yaml =". Primarily used internally but is useful outside of the module.
+
+Returns `true` or `false`
+
+    fm.test(string) #=> true || false
+
 # Contributing
@@ -80,2 +88,3 @@
 * **Marc-André Arseneault**: [github](https://github.com/arsnl) - [twitter](https://twitter.com/im_arsnl)
+* **Bret Comnes**: [github](https://github.com/bcomnes) - [bret.io](http://bret.io)
 
@@ -82,0 +91,0 @@ # LICENSE (MIT)

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Dev dependency count

1

decreased by-50%

Number of lines in readme file

104

increased by9.47%

Worsened metrics

Total package byte prevSize

11482

decreased by-1.31%

Lines of code

105

decreased by-16.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes