svgedit/docs/Linting.md at ed2e6e8a97b235ea199a2138ca44e8a4c7bd4312

Files

Brett Zamir 901c9547fe TODO: Besides splitting this out from previous commit, should really avoid markdown field in favor of modifying jsdoc to report wherever it lays out "prettyprint"; still probably missing some one-liners; see https://github.com/google/code-prettify ; update builds to confirm new stackblur is working; add below to CHANGES; add back for eslint-plugin-jsdoc once merged (though need new version ^3.9.1); move any linting changes to other linting branch

- Refactoring (minor): Add favicon to canvas demo
- Linting (ESLint Markdown JavaScript): Add `eslint-plugin-markdown` with
  slightly loosened config (`no-undef` and `padded-blocks` off and
  `no-unused-vars` as a warning)
- Linting (ESLint JSDoc code comments): Add `eslint-plugin-jsdoc` and apply to
    JSDoc code comments
- Linting (ESLint): Completely avoid unescaped tabs in files
- Docs (Linting): Add linting info file
- npm: Rename `copy-deps` script to `copy`
- Refactoring: Add stackblur-canvas as a dependency and copy it in (until such time as we can do so for canvg)

2018-11-07 14:51:09 +08:00

755 B

Raw Blame History

Command line

npm run eslint

This will query both JavaScript files and will query JavaScript within Markdown files. It will also check for some JSDoc issues.

JSDoc

To check for JSDoc issues, besides the eslint script, one may run the following to find any overly generic types in use (types should be as specific as possible):

npm run types-doc

Atom usage

If using the Atom package linter-eslint, one may add source.gfm to the "List of scopes to run ESLint on..." setting to get reporting of JavaScript errors in Markdown.

One may also add source.embedded.js though configuration comments and skip directives (not currently in use) don't seem to work there.

755 B Raw Blame History

Command line

JSDoc

Atom usage

755 B

Raw Blame History