Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including tslint-jsdoc-rules with all npm packages installed. Try it out:

var tslintJsdocRules = require("tslint-jsdoc-rules")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

tslint-jsdoc-rules v0.2.0

Rules for tslint to enforce JSDoc in sources.

Enforce JSDoc comments via tslint

A rule set for tslint that enfoces JSDoc comments on typescript code.

Making sure that all code elements are well documented improves code readability. It also helps with JSDoc generation as well as transpilation to compilers like Google's closure.

"jsdoc-require": [
  true
],

Other arguments may be optionally provided:

  • "no-methods" excludes JSDoc comments on interface specifications and class methods
  • "no-constructors" excludes JSDoc comments on class constructors
  • "no-properties" excludes JSDoc comments on class properties
  • "no-functions" excludes JSDoc comments on all functions
  • "no-protected" excludes JSDoc comments on protected elements
  • "no-private" excludes JSDoc comments on private elements
  • "no-private-properties" excludes private properties from enforcing JSDoc comments.

Install as a node module using npm:

 npm install tslint-jsdoc-rules

To use inside Emacs include the following code in your .emacs file.

(defun tslint-buffer ()
  (interactive)
  (compile (format "tslint -r ~/node_modules/tslint-jsdoc-rules/lib/ %s" (buffer-file-name)) nil)
  )

Works with

"typescript": ">=1.7.5"
"tslint": ">=3.2.2"
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free