ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Format JSDoc @params

by finitewisdom ST2/ST3 Missing

A package to extend the functionality of the Sublime Text editor. Specifically, if the current selection represents a set of @param lines, one per line, it will reformat the lines to align the parameter types, names and descriptions.

Details

  • 1.0.1
  • bitbucket.​org
  • 3 years ago
  • 2 months ago
  • 3 years ago

Installs

  • Total 11K
  • Win 5K
  • OS X 4K
  • Linux 2K
Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
bitbucket.​org

Overview

JSDocParam is a 3rd-party package for Sublime Text that can be used to format JSDoc @param blocks.

User Interface

A menu item named Format JSDoc @params will be added to the Edit menu. There is no key binding associated with this menu item, by default. If you would like to define one, then do the following:

  1. Select Key Bindings from the Preferences menu
  2. Add { "keys": ["ctrl+shift+2"], "command": "jsdoc_param" } to the array of user bindings
  3. Save the user bindings

In this example, we chose Shift-2 because that represents the @ character, ubiquitous throughout JSDoc documentation. Of course, you can specify any key binding that you prefer.

What It Does

If the current selection represents a set of @param lines, one per line, it will reformat the lines to align the parameter types, names and descriptions. For example, if the selection represents this (excluding the dashed lines):

----------------------------------------------------------------------------
 * @param {module:app/model/model~Model} model - The model definition
 * @param {string} mode - The mode being performed (e.g. "add", "edit")
 * @param {string} name - The name of the field (e.g. "type")
 * @param {function} callback - The Node-style callback to invoke with the result
 * @param {?module:javascript~Error} callback.err - The error object
 * @param {string} callback.s - The authorization level
----------------------------------------------------------------------------

it will reformat it into this:

----------------------------------------------------------------------------
 * @param {module:app/model/model~Model} model        - The model definition
 * @param {string}                       mode         - The mode being performed (e.g. "add", "edit")
 * @param {string}                       name         - The name of the field (e.g. "type")
 * @param {function}                     callback     - The Node-style callback to invoke with the result
 * @param {?module:javascript~Error}     callback.err - The error object
 * @param {string}                       callback.s   - The authorization level
----------------------------------------------------------------------------

The last line in the selection might represent a @returns statement instead of a @param statement. In this case, this:

------------------------------------------------------------------------
 *         @return      {string}     -       The formatted result
------------------------------------------------------------------------

would be reformatted to this:

------------------------------------------------------------------------
 * @returns {string} The formatted result
------------------------------------------------------------------------

Details

The general format of a @param line is:

* @param {xxx} [yyy] - zzz
------------------------------
123456789 123456789 123456789 
         1         2         3
         0         0         0

where:

- Positions 1, 3, 10, 16, 22, 24, 28: Can represent 0 or more whitespace characters
- "xxx" represents any characters other than a "}"
- The "[" and "]" are themselves optional
- "yyy" represents 1 or more non-whitespace characters
- "zzz" represents 0 or more characters of any kind

The general format of a @returns line is:

* @xxx { yyy } - zzz
------------------------------
123456789 123456789 123456789 
         1         2         3
         0         0         0

where:

  • “xxx” is either “return” or “returns”
  • “yyy” represents 1 or more non-whitespace characters
  • “zzz” represents 0 or more characters of any kind
  • any whitespace (positions 1, 3, 8, 10, 14, 16, 20) represents 0 or more whitespace characters
  • the “-” in position 17 may or may not be present

This line will be reformatted to:

* @returns {yyy} zzz
------------------------------
123456789 123456789 123456789 
         1         2         3
         0         0         0

where:

- column 1 represents the indentation to match the first @param
- columns 3, 12 and 18 represent a single space

Miscellaneous

Note 1

In the reformatted output, all lines will match the indentation of the first line. In other words, whatever whitespace appears before the * on the first line will appear on all lines.

Note 2

If there's nothing but whitespace after the *, we will leave the line as-is. This allows you to have blank (except for the leading *) lines between your @params, if you wish.

Note 3

If there isn't exactly one blank line between the @param lines and the @returns line, the output will be reformatted such that exactly one blank line exists.

Note 4

This package works just as well on @property statements as it does on @param statements.

Note 5

You don't need to select the first and last lines in their entirety. Any selection will be automatically expanded to the entirety of the first and last lines.

Note 6

“Format JSDoc @params” is an opinionated package. There are no configuration options at all. If you don't format your @params like we do, then this package isn't for you.