tslint-rule-documentation - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.js

		@@ -18,3 +18,3 @@ "use strict";
		found: false,
		uri: "https://github.com/Xapphire13/tslint-rule-documentation/blob/master/contributing.md"
		uri: "https://github.com/Xapphire13/tslint-rule-documentation/blob/master/CONTRIBUTING.md"
		};
		@@ -21,0 +21,0 @@ }

package.json

		{
		"name": "tslint-rule-documentation",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "Find the url for the documentation of a TSLint rule",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

		@@ -5,7 +5,23 @@ # tslint-rule-documentation
		# Install
		Coming soon
		```
		npm install --save tslint-rule-documentation
		```

		# Usage
		Coming soon
		```js
		const getRuleUri = require("tslint-rule-documentation").getRuleUri;

		// find uri for core rules
		getRuleUri("no-var-keyword");
		// => { found: true, uri: "https://palantir.github.io/tslint/rules/no-var-keyword"}

		// find uri for known plugins
		getRuleUri("__example/foo");
		// => { found: true, uri: "https://github.com/<user>/<repo>/blob/master/docs/foo.md"}

		// If the plugin is not known, get a link to help improve this
		getRuleUri("unknown-plugin/foo");
		// => { found: true, uri: "https://github.com/Xapphire13/tsli…tation/blob/master/contributing.md"}
		```

		# Contributing
		@@ -12,0 +28,0 @@ If a plugin you use is _not_ in the [list of supported plugins](https://github.com/Xapphire13/tslint-rule-documentation/blob/master/src/plugins.json),

New alerts