commonform-resolve - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

package.json

 {
   "name": "commonform-resolve",
   "description": "resolve definitions, uses, references, fields, and blanks",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "author": "Kyle E. Mitchell <[e-mail]> (http://kemitchell.com)",
   "dependencies": {
-    "clone": "^1.0.2",
-    "commonform-group-series": "^0.4.0",
+    "commonform-group-series": "^0.5.0",
     "commonform-number": "^0.4.0",
@@ -13,7 +12,4 @@ "commonform-predicate": "^0.4.0"
   "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"
   },
@@ -29,11 +25,6 @@ "homepage": "https://commonform.github.io",
   "license": "Apache-2.0",
-  "main": "source/index.js",
   "repository": "commonform/commonform-resolve",
   "scripts": {
-    "coverage": "istanbul cover _mocha && istanbul check-coverage coverage/coverage.json",
-    "lint": "jshint source test && jscs source test",
-    "pre-commit": "npm run lint && npm run coverage",
-    "test": "mocha",
-    "travis-ci": "npm run pre-commit"
+    "test": "defence README.md | replace-require-self | node"
   }
 }

README.md

@@ -1,7 +0,163 @@
-commonform-resolve
-==================
+```javascript
+var resolve = require('commonform-resolve')
+```
 
-[![NPM version](https://img.shields.io/npm/v/commonform-resolve.svg)](https://www.npmjs.com/package/commonform-resolve)
-[![build status](https://img.shields.io/travis/commonform/commonform-resolve.svg)](http://travis-ci.org/commonform/commonform-resolve)
+Passes strings through:
 
-Resolve definitions, uses, references, fields, and blanks.
+```javascript
+var assert = require('assert')
+
+assert.deepEqual(
+  resolve(
+    { content: [ 'A' ] },
+    { }),
+  { content: [ 'A' ] })
+```
+
+Converts term uses to strings:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [ { use: 'A' } ] },
+    { }),
+  { content: [ 'A' ] })
+```
+
+Passes definitions through:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [ { definition: 'A' } ] },
+    { } ),
+  { content: [ { definition: 'A' } ] })
+```
+
+Replaces blanks with provided values, or a blank when none are provided:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [ { blank: 'A' } ] },
+    { A: '1' }),
+  { content: [ '1' ] })
+
+assert.deepEqual(
+  resolve(
+    { content: [ { blank: 'A' } ] },
+    { }),
+  { content: [ { blank: 'A' } ] })
+```
+
+Replaces references with the numberings of target forms:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [
+      { heading: 'A',
+        form: { content: [ 'A' ] } },
+      { reference: 'A' } ] },
+    { })
+    .content[1],
+  { heading: 'A',
+    numbering: [
+      { series:  { number: 1, of: 1 },
+        element: { number: 1, of: 1 } } ] })
+
+```
+
+Indicates broken references:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [ { reference: 'A' } ] },
+    { }),
+  { content: [ { heading: 'A', broken: true } ] })
+
+```
+
+Flags ambiguous references with the numberings of all potential target forms:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [
+      { heading: 'A',
+        form: { content: [ 'A' ] } },
+      { heading: 'A',
+        form: { content: [ 'A' ] } },
+      { reference: 'A' } ] },
+    { })
+    .content[2],
+    { heading: 'A',
+      ambiguous: true,
+      numberings: [
+        [ { series:  { number: 1, of: 1 },
+            element: { number: 1, of: 2 } } ],
+        [ { series:  { number: 1, of: 1 },
+            element: { number: 2, of: 2 } } ] ] } )
+
+```
+
+Concatenates strings and contiguous objects that are resolved to strings:
+
+```javascript
+assert.deepEqual(
+  resolve({ content: [ 'A', { use: 'B' } ] }, { }).content,
+  [ 'AB' ])
+
+assert.deepEqual(
+  resolve({ content: [ { use: 'A' }, 'B' ] }, { }).content,
+  [ 'AB' ])
+
+```
+
+Preserves conspicuous formatting flags:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [
+      { heading: 'First',
+        form: {
+          content: [ 'test' ],
+          conspicuous: 'true' } } ] },
+    { })
+    .content,
+  [ { heading: 'First',
+      form: {
+        content: [ 'test' ],
+        conspicuous: 'true'},
+      numbering: [
+        { series:  { number: 1, of: 1 },
+          element: { number: 1, of: 1 } } ] } ])
+
+```
+
+Throws on invalid content:
+
+```javascript
+assert.throws(
+  function() {
+    resolve(
+      { content: [ { invalid: 'object' } ] },
+      { }) },
+  /Invalid content/)
+```
+
+Attaches numberings to form objects:
+
+```javascript
+assert.deepEqual(
+  resolve(
+    { content: [ { form: { content: [ 'test' ] } } ] },
+    { })
+    .content,
+    [ { numbering: [
+          { series:  { number: 1, of: 1 },
+            element: { number: 1, of: 1 } } ],
+        form: { content: [ 'test' ] } } ])
+```

New alerts

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

Improved metrics

Total package byte prevSize

6568

increased by60.16%

Dependency count

3

decreased by-25%

Dev dependency count

2

decreased by-60%

Number of lines in readme file

164

increased by1950%

Worsened metrics

Lines of code

87

decreased by-12.12%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedcommonform-group-series@0.5.2(transitive)

• - Removedclone@^1.0.2

• Updatedcommonform-group-series@^0.5.0