mdast-util-definitions - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

history.md

@@ -5,18 +5,12 @@ <!--remark setext-->
 
+1.1.1 / 2016-06-13
+==================
+
+*   Remove support for Duo ([`970b24f`](https://github.com/wooorm/mdast-util-definitions/commit/970b24f))
+*   Update `readme.md` ([`e997528`](https://github.com/wooorm/mdast-util-definitions/commit/e997528))
+*   Update dev-dependencies ([`0aca600`](https://github.com/wooorm/mdast-util-definitions/commit/0aca600))
+
 1.1.0 / 2016-01-08
 ==================
 
-*   Fix Travis test-target ([4756e25](https://github.com/wooorm/mdast-util-definitions/commit/4756e25))
-*   Fix signatures in `readme.md` ([839acc9](https://github.com/wooorm/mdast-util-definitions/commit/839acc9))
-*   Fix code-style in `readme.md` ([60a25ca](https://github.com/wooorm/mdast-util-definitions/commit/60a25ca))
-*   Add Travis deployment to npm ([20dd057](https://github.com/wooorm/mdast-util-definitions/commit/20dd057))
-*   Add Travis deployment to GitHub releases ([c4be01a](https://github.com/wooorm/mdast-util-definitions/commit/c4be01a))
-*   Remove support for component ([e4a8810](https://github.com/wooorm/mdast-util-definitions/commit/e4a8810))
-*   Remove support for bower ([9b83c68](https://github.com/wooorm/mdast-util-definitions/commit/9b83c68))
-*   Remove superfluous ignores ([49c30bf](https://github.com/wooorm/mdast-util-definitions/commit/49c30bf))
-*   Update copyright notice to include 2016 ([c47460e](https://github.com/wooorm/mdast-util-definitions/commit/c47460e))
-*   Refactor npm test target ([28cfc8d](https://github.com/wooorm/mdast-util-definitions/commit/28cfc8d))
-*   Add node 4.0, node 5.0 to Travis test targets ([c1650fd](https://github.com/wooorm/mdast-util-definitions/commit/c1650fd))
-*   Remove superfluous test script ([f510e9e](https://github.com/wooorm/mdast-util-definitions/commit/f510e9e))
-*   Refactor to replace mocha with tape ([c740b51](https://github.com/wooorm/mdast-util-definitions/commit/c740b51))
 *   Update dev-dependencies ([618011f](https://github.com/wooorm/mdast-util-definitions/commit/618011f))
@@ -23,0 +17,0 @@ *   Update `mdast` to `remark` ([9355890](https://github.com/wooorm/mdast-util-definitions/commit/9355890))

package.json

 {
   "name": "mdast-util-definitions",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Find definition nodes in mdast nodes",
@@ -18,4 +18,8 @@ "license": "MIT",
   },
-  "repository": "wooorm/mdast-util-definitions",
-  "author": "Titus Wormer <[e-mail]>",
+  "repository": "https://github.com/wooorm/mdast-util-definitions",
+  "bugs": "https://github.com/wooorm/mdast-util-definitions/issues",
+  "author": "Titus Wormer <[e-mail]> (http://wooorm.com)",
+  "contributors": [
+    "Titus Wormer <[e-mail]> (http://wooorm.com)"
+  ],
   "files": [
@@ -25,14 +29,15 @@ "index.js"
   "devDependencies": {
-    "browserify": "^12.0.0",
-    "eslint": "^1.0.0",
+    "browserify": "^13.0.0",
+    "eslint": "^2.0.0",
     "esmangle": "^1.0.0",
     "istanbul": "^0.4.0",
-    "jscs": "^2.0.0",
-    "jscs-jsdoc": "^1.0.0",
-    "remark": "^3.0.0",
-    "remark-comment-config": "^2.0.0",
-    "remark-github": "^2.0.0",
-    "remark-lint": "^2.0.0",
-    "remark-slug": "^3.0.0",
-    "remark-validate-links": "^2.0.0",
+    "jscs": "^3.0.0",
+    "jscs-jsdoc": "^2.0.0",
+    "remark": "^5.0.0",
+    "remark-cli": "^1.0.0",
+    "remark-comment-config": "^4.0.0",
+    "remark-github": "^5.0.0",
+    "remark-lint": "^4.0.0",
+    "remark-slug": "^4.0.0",
+    "remark-validate-links": "^4.0.0",
     "tape": "^4.0.0"
@@ -39,0 +44,0 @@ },

readme.md

@@ -1,9 +0,13 @@
-# mdast-util-definitions [![Build Status](https://img.shields.io/travis/wooorm/mdast-util-definitions.svg)](https://travis-ci.org/wooorm/mdast-util-definitions) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/mdast-util-definitions.svg)](https://codecov.io/github/wooorm/mdast-util-definitions)
+# mdast-util-definitions [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
 
-Get a definition in `node` by `identifier`. Supports weird keys (like
-`__proto__` or `toString`).
+<!--lint disable list-item-spacing heading-increment list-item-indent-->
 
+<!--lint disable no-duplicate-headings-->
+
+Get definitions in [MDAST][] nodes by `identifier`.  Supports funky
+keys, like `__proto__` or `toString`.
+
 ## Installation
 
-[npm](https://docs.npmjs.com/cli/install):
+[npm][]:
 
@@ -14,5 +18,4 @@ ```bash
 
-**mdast-util-definitions** is also available for [duo](http://duojs.org/#getting-started)
-and as an AMD, CommonJS, and globals module, ([uncompressed and
-compressed](https://github.com/wooorm/mdast-util-definitions/releases)).
+**mdast-util-definitions** is also available as an AMD, CommonJS, and
+globals module, [uncompressed and compressed][releases].
 
@@ -25,10 +28,10 @@ ## Usage
 
-var ast = remark.parse('[example]: http://example.com "Example"');
+var ast = remark().parse('[example]: http://example.com "Example"');
 
-var getDefinition = definitions(ast);
+var definition = definitions(ast);
 
-getDefinition('example');
+definition('example');
 // {type: 'definition', 'title': 'Example', ...}
 
-getDefinition('foo');
+definition('foo');
 // null
@@ -39,24 +42,54 @@ ```
 
-### `getDefinitionFactory(node): getDefinition`
+### `definitions(node)`
 
 Create a cache of all `definition`s in `node`.
 
-Parameters:
+###### Parameters
 
-*   `node` (`Node`) — (Grand)parent of definitions.
+*   `node` ([`Node`][node]) — Ancestor of definitions.
 
-Returns: `Function` — See [`getDefinition`](#getdefinitionidentifier)
+###### Returns
 
-### `getDefinition(identifier)`
+[`Function`][definition]
 
-Get a definition by `identifier`.
+### `definition(identifier)`
 
-Parameters:
+###### Parameters
 
 *   `identifier` (`string`) — Identifier of definition.
 
-Returns: `Node?` — Definition, if found.
+###### Returns
 
+[`Node?`][node] — Definition, if found.
+
 ## License
 
-[MIT](LICENSE) [@](https://github.com/) [Titus Wormer](http://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[build-badge]: https://img.shields.io/travis/wooorm/mdast-util-definitions.svg
+
+[build-status]: https://travis-ci.org/wooorm/mdast-util-definitions
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-definitions.svg
+
+[coverage-status]: https://codecov.io/github/wooorm/mdast-util-definitions
+
+[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
+
+[chat]: https://gitter.im/wooorm/remark
+
+[releases]: https://github.com/wooorm/mdast-util-definitions/releases
+
+[license]: LICENSE
+
+[author]: http://wooorm.com
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[mdast]: https://github.com/wooorm/mdast
+
+[node]: https://github.com/wooorm/mdast#node
+
+[definition]: #definitionidentifier

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

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

93

increased by55%

Worsened metrics

Total package byte prevSize

6696

decreased by-18.57%

Dev dependency count

14

increased by7.69%

Number of package files

4

decreased by-20%

No dependency changes