Bug 1824173 - Enable ESLint configuration valid-jsdocs across the tree, disabling for currently failing locations. r=mossop,webcompat-reviewers,extension-reviewers,credential-management-reviewers,denschub,dimi,robwu

Depends on D173450

Differential Revision: https://phabricator.services.mozilla.com/D173451
This commit is contained in:
Mark Banner 2023-03-24 19:35:25 +00:00
parent 4a729cf9d7
commit 36ab6611df
15 changed files with 128 additions and 20 deletions

View File

@ -230,6 +230,126 @@ module.exports = {
"mozilla/no-cu-reportError": "off",
},
},
{
files: ["**"],
excludedFiles: [
"accessible/tests/**",
"browser/actors/**",
"browser/base/content/**",
"browser/components/Browser*",
"browser/components/aboutlogins/**",
"browser/components/attribution/**",
"browser/components/colorways/**",
"browser/components/customizableui/**",
"browser/components/downloads/**",
"browser/components/enterprisepolicies/**",
"browser/components/firefoxview/tests/browser/head.js",
"browser/components/firefoxview/tests/browser/FirefoxViewTestUtils.sys.mjs",
"browser/components/ion/content/ion.js",
"browser/components/newtab/**",
"browser/components/originattributes/test/browser/**",
"browser/components/pocket/content/pkt*",
"browser/components/preferences/**",
"browser/components/privatebrowsing/**",
"browser/components/prompts/PromptCollection.sys.mjs",
"browser/components/protections/content/*-card.mjs",
"browser/components/protocolhandler/WebProtocolHandlerRegistrar.sys.mjs",
"browser/components/safebrowsing/content/test/**",
"browser/components/screenshots/**",
"browser/components/sessionstore/**",
"browser/components/storybook/.storybook/**",
"browser/components/syncedtabs/**",
"browser/components/tests/browser/**",
"browser/components/textrecognition/textrecognition.mjs",
"browser/components/touchbar/tests/browser/browser_touchbar_searchrestrictions.js",
"browser/components/translation/**",
"browser/components/uitour/UITour*",
"browser/extensions/pictureinpicture/**",
"browser/extensions/screenshots/**",
"browser/modules/**",
"browser/themes/BuiltInThemes.sys.mjs",
"browser/tools/mozscreenshots/**",
"devtools/**",
"docshell/base/URIFixup.sys.mjs",
"dom/**",
"editor/**",
"extensions/permissions/test/PermissionTestUtils.jsm",
"gfx/layers/apz/test/mochitest/apz_test_native_event_utils.js",
"image/test/**",
"intl/**",
"js/xpconnect/**",
"layout/**",
"mobile/android/**",
"modules/**",
"netwerk/**",
"parser/htmlparser/**",
"remote/**",
"services/**",
"storage/**",
"testing/**",
"toolkit/actors/**",
"toolkit/components/aboutmemory/**",
"toolkit/components/aboutperformance/**",
"toolkit/components/aboutprocesses/content/aboutProcesses.js",
"toolkit/components/antitracking/**",
"toolkit/components/asyncshutdown/**",
"toolkit/components/backgroundtasks/BackgroundTasks*.sys.mjs",
"toolkit/components/cleardata/**",
"toolkit/components/contentprefs/ContentPrefService2.sys.mjs",
"toolkit/components/cookiebanners/**",
"toolkit/components/corroborator/Corroborate.sys.mjs",
"toolkit/components/crashes/**",
"toolkit/components/crashmonitor/CrashMonitor.sys.mjs",
"toolkit/components/credentialmanagement/IdentityCredentialPromptService.sys.mjs",
"toolkit/components/downloads/**",
"toolkit/components/featuregates/FeatureGate*.*",
"toolkit/components/forgetaboutsite/test/unit/test_removeDataFromDomain.js",
"toolkit/components/glean/tests/browser/**",
"toolkit/components/kvstore/kvstore.sys.mjs",
"toolkit/components/lz4/lz4.js",
"toolkit/components/messaging-system/**",
"toolkit/components/mozintl/mozIntl.sys.mjs",
"toolkit/components/narrate/Narrator.jsm",
"toolkit/components/nimbus/**",
"toolkit/components/normandy/**",
"toolkit/components/osfile/**",
"toolkit/components/passwordmgr/**",
"toolkit/components/pdfjs/**",
"toolkit/components/pictureinpicture/**",
"toolkit/components/places/**",
"toolkit/components/printing/content/print*.*",
"toolkit/components/processtools/tests/browser/browser_test_powerMetrics.js",
"toolkit/components/promiseworker/**/PromiseWorker.*",
"toolkit/components/prompts/**",
"toolkit/components/reader/**",
"toolkit/components/reputationservice/test/unit/test_app_rep_windows.js",
"toolkit/components/taskscheduler/TaskScheduler*.*",
"toolkit/components/telemetry/**",
"toolkit/components/thumbnails/**",
"toolkit/components/timermanager/UpdateTimerManager.*",
"toolkit/components/translation/LanguageDetector.*",
"toolkit/components/translations/**",
"toolkit/components/url-classifier/**",
"toolkit/components/utils/**",
"toolkit/components/viewsource/**",
"toolkit/components/windowwatcher/**",
"toolkit/components/workerloader/require.js",
"toolkit/content/**",
"toolkit/crashreporter/**",
"toolkit/modules/**",
"toolkit/mozapps/downloads/**",
"toolkit/mozapps/extensions/**",
"toolkit/mozapps/handling/**",
"toolkit/mozapps/update/**",
"toolkit/profile/test/test_create_profile.xhtml",
"tools/code-coverage/tests/mochitest/test_coverage_specialpowers.html",
"tools/lint/eslint/**",
"tools/profiler/tests/**",
"uriloader/**",
"widget/tests/window_composition_text_querycontent.xhtml",
],
extends: ["plugin:mozilla/valid-jsdoc"],
},
{
files: ["layout/**"],
rules: {

View File

@ -5,7 +5,7 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
rules: {
"block-scoped-var": "error",
complexity: ["error", { max: 22 }],

View File

@ -5,7 +5,7 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
rules: {
"mozilla/var-only-at-top-level": "error",

View File

@ -5,5 +5,5 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
};

View File

@ -5,7 +5,7 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
rules: {
"mozilla/var-only-at-top-level": "error",

View File

@ -5,7 +5,7 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
rules: {
"mozilla/var-only-at-top-level": "error",

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
rules: {
// Rules from the mozilla plugin
"mozilla/balanced-listeners": "error",

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
rules: {
// Rules from the mozilla plugin
"mozilla/balanced-listeners": "error",

View File

@ -51,6 +51,8 @@ extensions = [
# JSDoc must run successfully for dirs specified, so running
# tree-wide (the default) will not work currently.
# When adding more paths to this list, please ensure that they are not
# excluded from valid-jsdoc in the top-level .eslintrc.js.
js_source_path = [
"../browser/components/extensions",
"../browser/components/migration",

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
rules: {
// Enforce return statements in callbacks of array methods.
"array-callback-return": "error",

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
globals: {
// JS files in this folder are commonly xpcshell scripts where |arguments|
// is defined in the global scope.

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
globals: {
// These are defined in the WebExtension script scopes by ExtensionCommon.jsm
Cc: true,

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
rules: {
// Rules from the mozilla plugin
"mozilla/balanced-listeners": "error",

View File

@ -5,8 +5,6 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/valid-jsdoc"],
rules: {
"mozilla/balanced-listeners": "error",
"mozilla/var-only-at-top-level": "error",

View File

@ -5,5 +5,5 @@
"use strict";
module.exports = {
extends: ["plugin:mozilla/require-jsdoc", "plugin:mozilla/valid-jsdoc"],
extends: ["plugin:mozilla/require-jsdoc"],
};