commonform-flatten - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

package.json

 {
   "name": "commonform-flatten",
   "description": "flatten Common Forms",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "author": "Kyle E. Mitchell <[e-mail]> (http://kemitchell.com)",
@@ -11,7 +11,4 @@ "bugs": "https://github.com/commonform/commonform-flatten/issues",
   "devDependencies": {
-    "chai": "^2.2.0",
-    "istanbul": "^0.3.5",
-    "jscs": "^1.8.1",
-    "jshint": "^2.5.10",
-    "mocha": "^2.0.1"
+    "defence-cli": "^1.0.1",
+    "replace-require-self": "^1.0.0"
   },
@@ -27,3 +24,2 @@ "homepage": "https://commonform.github.io",
   "license": "Apache-2.0",
-  "main": "source/index",
   "peerDependencies": {
@@ -34,8 +30,4 @@ "commonform": "1.x"
   "scripts": {
-    "coverage": "istanbul check-coverage --config .dotfiles/istanbul.yml coverage/coverage.json",
-    "lint": "jshint --config .dotfiles/jshint.json source test && jscs --config .dotfiles/jscs.json source test",
-    "precommit": "npm run lint && npm run coverage",
-    "precoverage": "istanbul cover --config .dotfiles/istanbul.yml -- _mocha --opts .dotfiles/mocha.opts",
-    "test": "mocha --opts .dotfiles/mocha.opts"
+    "test": "defence README.md | replace-require-self | node"
   }
 }

README.md

@@ -1,9 +0,70 @@
-commonform-flatten
-==================
+Produces a useful intermediary representation for rendering in linear document formats, like [Office Open XML](https://npmjs.com/package/commonform-docx) and [terminal listings](https://npmjs.com/package/commonform-terminal).
 
-[![NPM version](https://img.shields.io/npm/v/commonform-flatten.svg)](https://www.npmjs.com/package/commonform-flatten)
-[![build status](https://img.shields.io/travis/commonform/commonform-flatten.svg)](http://travis-ci.org/commonform/commonform-flatten)
+```javascript
+var flatten = require('commonform-flatten')
+var assert = require('assert')
 
-Flatten Common Forms.
-
-Produces a useful intermediary representation for rendering in linear document formats, like [Office Open XML][https://npmjs.com/package/commonform-docx] and [terminal listings](https://npmjs.com/package/commonform-terminal).
+assert.deepEqual(
+  flatten(
+    { content: [
+        'some text ',
+        { blank: 'company' },
+        { heading: 'A',
+          form: {
+            conspicuous: 'yes',
+            content: [
+              'before',
+              { form: { content: [ 'B' ] } },
+              { form: { content: [ 'C' ] } },
+              'between',
+              { form: { content: [ 'D' ] } },
+              { form: { content: [ 'E' ] } },
+              'after' ] } },
+        'after' ] },
+    { company: 'NewCo' }),
+  [ { depth: 1,
+      content: [ 'some text NewCo' ] },
+    { depth: 2,
+      heading: 'A',
+      content: [ 'before' ],
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } } ],
+      conspicuous: 'yes' },
+    { depth: 3,
+      content: [ 'B' ],
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } },
+        { series:  { number: 1, of: 2 },
+          element: { number: 1, of: 2 } } ] },
+    { depth: 3,
+      content: [ 'C' ],
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } },
+        { series:  { number: 1, of: 2 },
+          element: { number: 2, of: 2 } } ] },
+    { depth: 2,
+      content: [ 'between' ],
+      conspicuous: 'yes' },
+    { depth: 3,
+      content: [ 'D' ],
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } },
+        { series:  { number: 2, of: 2 },
+          element: { number: 1, of: 2 } } ] },
+    { depth: 3,
+      content: [ 'E' ],
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } },
+        { series:  { number: 2, of: 2 },
+          element: { number: 2, of: 2 } } ] },
+    { depth: 2,
+      content: [ 'after' ],
+      conspicuous: 'yes' },
+    { depth: 1,
+      content: [ 'after' ] } ])
+```

No alert changes

Improved metrics

Total package byte prevSize

4322

increased by37.08%

Dev dependency count

2

decreased by-60%

Lines of code

48

increased by6.67%

Number of lines in readme file

71

increased by610%

Worsened metrics

Number of package files

3

decreased by-25%

No dependency changes