Devex/jsdoc migration (#5601)

* wip: add linting jsdoc etc

* replace esdoc with jsdoc

* remove esdoc config file

* lint a bunch of files and add lint yarn script

* Adding esdocs to src/Element.js

* jsdoc for Providers.js

* update webform jsdoc types

* minor

* fix linting errors

* update types for nested component

* breadCrumbSettings -> breadcrumbSettings at line 142

* update formio.form.js jsdoc

* Adding some jsdocs to src/components/_classes/component/Component.js

* jsdoc for address provider base class and azure address

* one warning left at line 16, did not want to alter constructor logic to fix

* address provider jsdoc

* Adding component class docs.

* Working on utils eslint.

* WIP: update jsdoc

* update types to parent Form class; add builder options type

* minor update

* Re-export methods from @formio/core for the utils functions.

* Re-adding findComponents.

* JSDoc: Field.js

* update formbuilder options; type listcomponent and child classes

* type definitions for file providers

* resolve FormBuilder eslint warnings

* fix password strength linting warnings and fileProcessor lints

* whoopsie - minor typo

* Updated utils docs.

* cleaned up lint errors

* jsDoc added to Multvalue.js

* JSDoc-Update: NestedComponent.js

* fix linter warnings for Input, ListComponent, and Multivalue

* lint fixes for Form, CalendarWidget, ListComponent.form.js

* jsdoc updates for Well.form and ListComponent.form

* updates to edit forms for list, time, unknown, url, and well

* Adding types to utils.

* jsdoc updates to textfield and textfield.form

* Fixing typedocs on edit forms.

* use generic edit form function definition

* jsdoc updates to Tabs and TextArea

* jsdoc updates to SelectBoxes, Select, Number, Hidden

* Adding lint for Form.

* jsdoc updates to day and editgrid

* jsdoc updates to DataGrid

* Fixing lint for pdf, wizard, and webform builder.

* address through currency

* Adding docs to edit forms in _classes.

* Updated componments.

* jsdoc updates to nested form

* delete accidental addition

* update package json script and lockfile

---------

Co-authored-by: Travis Tidwell <[email protected]>
Co-authored-by: John Teague <[email protected]>
Co-authored-by: ryanformio <[email protected]>
Co-authored-by: Edwin Anciani <[email protected]>
Co-authored-by: Dezshaun Meeks <[email protected]>

.eslintignore

@@ -0,0 +1,10 @@
+node_modules
+lib
+dist
+app
+test
+types
+*.spec.js
+*.unit.js
+_site
+docs

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": ["eslint:recommended", "plugin:jsdoc/recommended-typescript-flavor"],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": ["jsdoc"],
+    "rules": {
+      "no-prototype-builtins": "off",
+      "no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    }
+}

gulpfile.js

@@ -6,7 +6,6 @@ const concat = require('gulp-concat');
 const replace = require('gulp-replace');
 const rename = require('gulp-rename');
 const cleanCSS = require('gulp-clean-css');
-const eslint = require('gulp-eslint');
 const clean = require('gulp-clean');
 
 // Clean lib folder.
@@ -18,14 +17,6 @@ gulp.task('clean:lib', () => {
 });
 gulp.task('clean', gulp.parallel('clean:dist', 'clean:lib'));
 
-// ESLint
-gulp.task('eslint', function eslintTask() {
-  return gulp.src(['./src/**/*.js', '!./src/**/*.spec.js'])
-    .pipe(eslint())
-    .pipe(eslint.format())
-    .pipe(eslint.failAfterError());
-});
-
 // Move font-awesome fonts into dist folder.
 gulp.task('builder-fonts', function builderFonts() {
   return gulp.src('./node_modules/bootstrap-icons/font/fonts/*').pipe(gulp.dest('dist/fonts'));

package.json

@@ -35,7 +35,7 @@
   ],
   "scripts": {
     "build": "yarn doc && yarn lib && yarn dist",
-    "doc": "esdoc",
+    "doc": "typedoc",
     "dist": "gulp clean:dist && webpack --config webpack.config.js && webpack --config webpack.prod.js && gulp build",
     "lib": "gulp clean:lib && tsc --project tsconfig.cjs.json && tsc --project tsconfig.mjs.json && yarn lib:package",
     "lib:package": "node ./libpackage.js",
@@ -50,7 +50,7 @@
     "release": "yarn build-app && yarn deploy-s3",
     "tag": "VERSION=$(yarn version);git add -A; git commit -m \"Build $Version\";git push origin master;git tag v$VERSION;git push origin --tags;",
     "dopublish": "npm run build && npm run tag && npm publish",
-    "lint": "gulp eslint",
+    "lint": "eslint ./src --fix",
     "serve": "jekyll serve --config _config.yml,_config.dev.yml",
     "test": "mocha 'src/**/*.unit.js'",
     "test:updateRenders": "npm run lib && TZ=UTC node --require jsdom-global/register test/updateRenders.js",
@@ -124,11 +124,8 @@
     "chance": "^1.1.9",
     "ejs-loader": "^0.5.0",
     "escape-string-regexp": "^5.0.0",
-    "esdoc": "^1.1.0",
-    "esdoc-ecmascript-proposal-plugin": "^1.0.0",
-    "esdoc-standard-plugin": "^1.0.0",
     "eslint": "^8.57.0",
-    "eslint-config-formio": "^1.1.4",
+    "eslint-plugin-jsdoc": "^48.2.3",
     "fetch-mock": "^9.11.0",
     "file-loader": "^6.2.0",
     "flatpickr": "^4.6.13",
@@ -137,7 +134,6 @@
     "gulp-clean": "^0.4.0",
     "gulp-clean-css": "^4.3.0",
     "gulp-concat": "^2.6.1",
-    "gulp-eslint": "^6.0.0",
     "gulp-filter": "^7.0.0",
     "gulp-rename": "^2.0.0",
     "gulp-replace": "^1.1.3",
@@ -168,6 +164,7 @@
     "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
     "tsc": "^2.0.4",
+    "typedoc": "^0.25.13",
     "typescript": "5.3.2",
     "webpack": "^5.90.3",
     "webpack-bundle-analyzer": "^4.10.2",