zcy
/
svgedit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
svgedit/docs/Linting.md

19 lines
534 B
Markdown
Raw Normal View History

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-10-30 19:41:22 +00:00
## Command line
```
use a fixed import for canvg
2020-08-28 22:02:35 +00:00
npm run lint
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-10-30 19:41:22 +00:00
```
This will query both JavaScript files and will query JavaScript within
- Linting: Lint hidden `ncurc.js` file - Docs: Add 6.0.0.md migration file - Docs: Update Contributing, Testing (renamed to Development), Linting and ReleaseInstructions - Docs: Info on submodules - npm: Add scripts for updating submodules - npm: Add `license-badges`, `build-docs`, and `copy` scripts to `prepublishOnly` script - npm: Bump to 6.0.0
2020-02-22 03:38:33 +00:00
Markdown and HTML files. It will also check for some JSDoc issues,
Mocha/chai-specific rules, etc.
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-10-30 19:41:22 +00:00
## 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.