Skip to content

JavaScript

Usage

When first in the chain, the JavaScript filter uses no special encoding detection. It will assume utf-8 if no encoding BOM is found, and the user has not overridden the fallback encoding. Text is returned in chunks based on the context of the text. The filter can return JSDoc comments, block comment, inline comment, string, and template literal content.

matrix:
- name: javascript
  pipeline:
  - pyspelling.filters.javascript
      jsdocs: true
      line_comments: false
      block_comments: false
  sources:
  - js_files/**/*.js

Options

Options Type Default Description
block_comments bool True Return SourceText entries for each block comment.
line_comments bool True Return SourceText entries for each line comment.
jsdocs bool False Return SourceText entries for each JSDoc comment.
strings bool False Return SourceText entries for each string.
group_comments bool False Group consecutive inline JavaScript comments as one SourceText entry.
decode_escapes bool True Enable/disable decoding of string escapes.

Categories

JavaScript returns text with the following categories.

Category Description
js-block-comment Text captured from JavaScript block comments.
js-line-comment Text captured from JavaScript line comments.
js-docs Text captured from JSDoc comments.
js-string Text captured from strings and template literals.

Last update: December 22, 2019