zcy
/
svgedit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
svgedit/docs/jsdoc-config.js

38 lines
853 B
JavaScript
Raw Normal View History

TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
/* eslint-env node */
move to standard linter for simpler configuration
2021-12-28 14:02:29 +00:00
'use strict'
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
module.exports = {
move to standard linter for simpler configuration
2021-12-28 14:02:29 +00:00
plugins: ['plugins/markdown'],
fix some useless console.log
2021-05-15 14:20:13 +00:00
markdown: {},
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
recurseDepth: 10,
source: {
exclude: [
- Exclude cypress directory from jsdoc
2020-04-02 05:12:30 +00:00
'cypress',
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
'node_modules',
'dist',
- Fix more paths (Rollup, build, eslint) paths - Restore checking of a few modified "external" packages
2020-07-18 11:21:41 +00:00
'external',
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
'screencasts',
fix to doc and config
2022-06-25 21:07:06 +00:00
'test',
'src/editor/react-extensions/react-test/node_modules'
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
],
- Refactoring: Remove BBQ in favor of `deparam` (with npm script to copy in) - Fix: `initFill`/`initStroke` `color`, and `bkgd_color` problematic when using decimal-component-only hex; fixes #314
2020-01-05 09:58:50 +00:00
excludePattern: 'svgedit-config-*|build-html.js|rollup*|external/babel-polyfill|extensions/mathjax|imagelib/jquery.min.js|jspdf/jspdf.min.js|jspdf/underscore-min.js|jquery-ui|jquery.min.js|js-hotkeys'
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
},
sourceType: 'module',
tags: {
allowUnknownTags: false
},
templates: {
cleverLinks: true,
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
monospaceLinks: false /* ,
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
default: {
layoutFile: 'docs/layout.tmpl'
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
} */
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
},
opts: {
recurse: true,
verbose: true,
- Breaking change: `loadSvgString` now returns a `Promise` rather than accepting a callback - Breaking change: Treat callbacks to `editor.ready` as Promises, only resolving after all resolve - Breaking change: Make `editor.runCallbacks` return a `Promise` which resolves upon all callbacks resolving - Breaking change: Require `npx` (used with `babel-node`) to allow Node files for HTML building and JSDoc type checking to be expressed as ESM. - Breaking change: `addExtension` now throws upon a repeated attempt to add an already-added extension - Breaking change (storage preference cookies): Namespace the cookie as "svgeditstore" instead of just "store" - Breaking change (API): Remove `svgCanvas.rasterExport` fourth (callback) argument, collapsing fifth (options) to fourth - Breaking change (API): Remove `svgCanvas.exportPDF` third (callback) argument - Breaking change (API): `editor/contextmenu.js` `add` now throws instead of giving a console error only upon detecting a bad menuitem or preexisting context menu - Breaking change (API): Remove `svgCanvas.embedImage` second (callback) argument - Breaking change (API): Make `getHelpXML` a class instead of instance method of `RGBColor` - Breaking change (internal API): Refactor `dbox` (and `alert`/`confirm`/`process`/`prompt`/`select`) to avoid a callback argument in favor of return a Promise - Fix: Avoid running in extension `langReady` multiple times or serially - Enhancement (API): Add svgCanvas.runExtension to run just one extension and add `nameFilter` callback to `runExtensions` - Enhancement (API): Supply `$` (our wrapped jQuery) to extensions so can use its plugins, e.g., dbox with its `alert` - Enhancement: Use alert dialog in place of `alert` in webappfind - Enhancement: `editor.ready` now returns a Promise resolving when all callbacks have resolved - Enhancement: Allow `noAlert` option as part of second argument to `loadSvgString` (and `loadFromURL` and `loadFromDataURI`) to avoid UI alert (and trigger promise rejection) - Enhancement: Make `dbox` as a separate module for alert, prompt, etc. dialogs - Refactoring: Internal `PaintBox` as class; other misc. tweaks; no bitwise in canvg - Linting (ESLint): Further linting changes (for editor); rename `.eslintrc` -> `.eslintrc.json` per recommendation - Optimization: Recompress images (imageoptim-cli updated) - npm: Update devDeps - npm: Bump to 4.0.0
2018-11-08 06:48:01 +00:00
destination: 'docs/jsdoc',
TODO: Check out https://github.com/qard/remark-lint-code and https://www.npmjs.com/package/remark-lint-code-eslint ; add below to CHANGES - Docs (JSDocs) Switch to JS-based config file - Leverage syntax highlighting reporting of JSDoc to lint our code (npm version does not seem to reflect that on Github, so we use Github version we need) - Docs (ESLint): Apply most of our ESLint rules (except `no-undefined` and `padded-blocks`) to sample code blocks
2018-10-30 18:43:45 +00:00
tutorials: 'docs/tutorials'
}
move to standard linter for simpler configuration
2021-12-28 14:02:29 +00:00
}