wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Bug 1203520 - We need a DevTools ESLint plugin containing our ruleset r=gps

Browse Source
This commit is contained in:
Michael Ratcliffe 2015-09-30 14:44:48 +01:00
parent da598a4d3e
commit 49de3d4930
37 changed files with 1042 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.eslintrc Normal file
View File

@ -0,0 +1,5 @@
{
"plugins": [
"mozilla"
]
}

3
.gitignore vendored
View File

@ -71,3 +71,6 @@ testing/web-platform/sync/
# Android Gradle artifacts.
mobile/android/gradle/.gradle
# Ignore node_modules from eslint-plugin-mozilla
testing/eslint-plugin-mozilla/node_modules/

3
.hgignore
View File

@ -93,3 +93,6 @@ GPATH
# Ignore mozharness execution files
^testing/mozharness/logs/
^testing/mozharness/build/
# Ignore node_modules from eslint-plugin-mozilla
^testing/eslint-plugin-mozilla/node_modules/

5
devtools/.eslintrc
View File

@ -25,6 +25,11 @@
// These are the rules that have been configured so far to match the
// devtools coding style.
// Rules from the mozilla plugin
"mozilla/components-imports": 1,
"mozilla/import-headjs-globals": 1,
"mozilla/mark-test-function-used": 1,
// Disallow using variables outside the blocks they are defined (especially
// since only let and const are used, see "no-var").
"block-scoped-var": 2,

15
devtools/.eslintrc.mochitests
View File

@ -1,21 +1,15 @@
// Parent config file for all devtools browser mochitest files.
{
"rules": {
// Only disallow non-global unused vars, so that things like the test
// function do not produce errors.
"no-unused-vars": [2, {"vars": "local"}],
// Allow using undefined variables so that tests can refer to functions
// and variables defined in head.js files, without having to maintain a
// list of globals in each .eslintrc file.
// Note that bug 1168340 will eventually help auto-registering globals
// from head.js files.
"no-undef": 0,
"block-scoped-var": 0
// Only disallow non-global unused vars, so that head.js does not produce
// errors.
"no-unused-vars": [2, {"vars": "local"}]
},
// All globals made available in the test environment.
"globals": {
"add_task": true,
"Assert": true,
"BrowserTestUtils": true,
"content": true,
"document": true,
"EventUtils": true,
@ -38,7 +32,6 @@
"setTimeout": true,
"SimpleTest": true,
"SpecialPowers": true,
"test": true,
"todo": true,
"todo_is": true,
"todo_isnot": true,

3
devtools/client/animationinspector/animation-controller.js
View File

@ -3,8 +3,7 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals ViewHelpers, Task, AnimationsPanel, promise, EventEmitter,
AnimationsFront */
/* globals AnimationsPanel */
"use strict";

1
devtools/client/animationinspector/components.js
View File

@ -3,7 +3,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals ViewHelpers */
"use strict";

1
devtools/client/framework/toolbox-hosts.js
View File

@ -1,7 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals DOMHelpers, Services */
"use strict";

3
devtools/client/framework/toolbox.js
View File

@ -1,9 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals gDevTools, DOMHelpers, toolboxStrings, InspectorFront, Selection,
CommandUtils, DevToolsUtils, Hosts, osString, showDoorhanger,
getHighlighterUtils, createPerformanceFront */
"use strict";

1
devtools/client/layoutview/view.js
View File

@ -3,7 +3,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals ViewHelpers, window, document */
"use strict";

2
devtools/client/promisedebugger/promise-controller.js
View File

@ -4,7 +4,7 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* global promise, PromisesPanel, PromisesFront, DevToolsUtils */
/* global PromisesPanel */
"use strict";

2
devtools/client/shared/inplace-editor.js
View File

@ -4,8 +4,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals focusManager, CSSPropertyList, domUtils */
/**
* Basic use:
* let spanToEdit = document.getElementById("somespan");

3
devtools/client/shared/widgets/Tooltip.js
View File

@ -4,9 +4,6 @@
"use strict";
/* globals beautify, setNamedTimeout, clearNamedTimeout, VariablesView,
VariablesViewController, Task */
const {Cu, Ci} = require("chrome");
const promise = require("promise");
const {Spectrum} = require("devtools/client/shared/widgets/Spectrum");

3
devtools/client/styleinspector/computed-view.js
View File

@ -4,8 +4,7 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals overlays, StyleInspectorMenu, loader, clipboardHelper,
_Iterator, StopIteration */
/* globals _Iterator, StopIteration */
"use strict";

4
devtools/client/styleinspector/rule-view.js
View File

@ -4,10 +4,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals overlays, Services, EventEmitter, StyleInspectorMenu,
clipboardHelper, _strings, domUtils, AutocompletePopup, loader,
osString */
"use strict";
const {Cc, Ci, Cu} = require("chrome");

2
devtools/client/styleinspector/style-inspector-menu.js
View File

@ -4,8 +4,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals overlays, Services, clipboardHelper, _strings */
"use strict";
const {Cc, Ci, Cu} = require("chrome");

2
devtools/client/styleinspector/style-inspector.js
View File

@ -4,8 +4,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals RuleView, ComputedView, gDevTools */
"use strict";
const {Cc, Cu, Ci} = require("chrome");

2
devtools/client/styleinspector/utils.js
View File

@ -4,8 +4,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* global domUtils */
"use strict";
const {Cc, Ci, Cu} = require("chrome");

5
devtools/server/actors/inspector.js
View File

@ -1,7 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals DevToolsUtils, DOMParser, eventListenerService, CssLogic */
"use strict";
@ -999,7 +998,9 @@ var NodeFront = protocol.FrontClass(NodeActor, {
return this._form.props ? (name in this._form.props) : null;
},
get formProperties() this._form.props,
get formProperties() {
return this._form.props
},
/**
* Return a new AttributeModificationList for this node.

2
devtools/server/actors/promises.js
View File

@ -12,8 +12,6 @@ const { ObjectActor,
const DevToolsUtils = require("devtools/shared/DevToolsUtils");
loader.lazyRequireGetter(this, "events", "sdk/event/core");
/* global events */
// Teach protocol.js how to deal with legacy actor types
types.addType("ObjectActor", {
write: actor => actor.grip(),

2
devtools/server/actors/styles.js
View File

@ -1,7 +1,7 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals CssLogic, DOMUtils, CSS */
/* globals CSS */
"use strict";

1
devtools/shared/gcli/commands/highlight.js
View File

@ -1,7 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals nodesSelected, PluralForm */
"use strict";

2
devtools/shared/output-parser.js
View File

@ -2,8 +2,6 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals DOMUtils */
"use strict";
const {Cc, Ci, Cu} = require("chrome");

2
devtools/shared/webconsole/network-monitor.js
View File

@ -1,8 +1,6 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
/* globals NetworkHelper, Services, DevToolsUtils, NetUtil,
gActivityDistributor */
"use strict";

143
python/mach_commands.py
View File

@ -8,6 +8,9 @@ import argparse
import logging
import mozpack.path as mozpath
import os
import platform
import subprocess
import sys
import which
from mozbuild.base import (
@ -20,17 +23,46 @@ from mach.decorators import (
Command,
)
ESLINT_NOT_FOUND_MESSAGE = '''
Could not find eslint! We looked at the --binary option, at the ESLINT
environment variable, and then at your path. Install eslint and needed plugins
with
npm install -g eslint eslint-plugin-react
mach eslint --setup
and try again.
'''.strip()
NODE_NOT_FOUND_MESSAGE = '''
nodejs is either not installed or is installed to a non-standard path.
Please install nodejs from https://nodejs.org and try again.
Valid installation paths:
'''.strip()
NPM_NOT_FOUND_MESSAGE = '''
Node Package Manager (npm) is either not installed or installed to a
non-standard path. Please install npm from https://nodejs.org (it comes as an
option in the node installation) and try again.
Valid installation paths:
'''.strip()
ESLINT_PROMPT = '''
Would you like to use eslint
'''.strip()
ESLINT_PLUGIN_MOZILLA_PROMPT = '''
eslint-plugin-mozilla is an eslint plugin containing rules that help enforce
JavaScript coding standards in the Mozilla project. Would you like to use this
plugin
'''.strip()
ESLINT_PLUGIN_REACT_PROMPT = '''
eslint-plugin-react is an eslint plugin containing rules that help React
developers follow strict guidelines. Would you like to install it
'''.strip()
@CommandProvider
class MachCommands(MachCommandBase):
@ -132,7 +164,10 @@ class MachCommands(MachCommandBase):
return 0 if return_code == 0 else 1
@Command('eslint', category='devenv')
@Command('eslint', category='devenv',
description='Run eslint or help configure eslint for optimal development.')
@CommandArgument('-s', '--setup', default=False, action='store_true',
help='configure eslint for optimal development.')
@CommandArgument('path', nargs='?', default='.',
help='Path to files to lint, like "browser/components/loop" '
'or "mobile/android". '
@ -142,9 +177,12 @@ class MachCommands(MachCommandBase):
@CommandArgument('-b', '--binary', default=None,
help='Path to eslint binary.')
@CommandArgument('args', nargs=argparse.REMAINDER) # Passed through to eslint.
def eslint(self, path, ext=None, binary=None, args=[]):
def eslint(self, setup, path, ext=None, binary=None, args=[]):
'''Run eslint.'''
if setup:
return self.eslint_setup()
if not binary:
binary = os.environ.get('ESLINT', None)
if not binary:
@ -182,3 +220,100 @@ class MachCommands(MachCommandBase):
pass_thru=True, # Allow user to run eslint interactively.
ensure_exit_code=False, # Don't throw on non-zero exit code.
)
def eslint_setup(self, update_only=False):
"""Ensure eslint is optimally configured.
This command will inspect your eslint configuration and
guide you through an interactive wizard helping you configure
eslint for optimal use on Mozilla projects.
"""
sys.path.append(os.path.dirname(__file__))
# At the very least we need node installed.
nodePath = self.getNodeOrNpmPath("node")
if not nodePath:
return 1
npmPath = self.getNodeOrNpmPath("npm")
if not npmPath:
return 1
# Install eslint.
print("Installing eslint...")
with open(os.devnull, "w") as fnull:
subprocess.call([npmPath, "install", "eslint", "-g"],
stdout=fnull, stderr=fnull)
# Install eslint-plugin-mozilla.
print("")
print("Installing eslint-plugin-mozilla...")
with open(os.devnull, "w") as fnull:
subprocess.call([npmPath, "link"],
cwd="testing/eslint-plugin-mozilla",
stdout=fnull, stderr=fnull)
# Install eslint-plugin-react.
print("")
print("Installing eslint-plugin-react...")
with open(os.devnull, "w") as fnull:
subprocess.call([npmPath, "install", "-g", "eslint-plugin-react"],
stdout=fnull, stderr=fnull)
def getPossibleNodePathsWin(self):
"""
Return possible nodejs paths on Windows.
"""
if platform.system() != "Windows":
return []
return {
"%s\\nodejs" % os.environ.get("SystemDrive"),
os.path.join(os.environ.get("ProgramFiles"), "nodejs"),
os.path.join(os.environ.get("PROGRAMW6432"), "nodejs"),
os.path.join(os.environ.get("PROGRAMFILES"), "nodejs")
}
def getNodeOrNpmPath(self, filename):
"""
Return the nodejs or npm path.
"""
try:
appPath = which.which(filename)
return appPath
except which.WhichError:
pass
if platform.system() == "Windows":
try:
for ext in ["", ".cmd", ".exe"]:
nodeOrNpmPath = which.which(filename + ext,
path=self.getPossibleNodePathsWin())
if self.is_valid(nodeOrNpmPath):
return nodeOrNpmPath
except which.WhichError:
pass
if filename == "node":
print(NODE_NOT_FOUND_MESSAGE)
elif filename == "npm":
print(NPM_NOT_FOUND_MESSAGE)
if platform.system() == "Windows":
appPaths = self.getPossibleNodePathsWin()
for p in appPaths:
print(" - " + p)
elif platform.system() == "Darwin":
print(" - /usr/local/bin/node")
elif platform.system() == "Linux":
print(" - /usr/bin/nodejs")
return None
def is_valid(self, path):
try:
with open(os.devnull, "w") as fnull:
subprocess.check_call([path, "--version"], stdout=fnull)
return True
except subprocess.CalledProcessError:
return False

363
testing/eslint-plugin-mozilla/LICENSE Normal file
View File

@ -0,0 +1,363 @@
Mozilla Public License, version 2.0
1. Definitions
1.1. "Contributor"
means each individual or legal entity that creates, contributes to the
creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used by a
Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached the
notice in Exhibit A, the Executable Form of such Source Code Form, and
Modifications of such Source Code Form, in each case including portions
thereof.
1.5. "Incompatible With Secondary Licenses"
means
a. that the initial Contributor has attached the notice described in
Exhibit B to the Covered Software; or
b. that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the terms of
a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in a
separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible, whether
at the time of the initial grant or subsequently, any and all of the
rights conveyed by this License.
1.10. "Modifications"
means any of the following:
a. any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered Software; or
b. any new file in Source Code Form that contains any Covered Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the License,
by the making, using, selling, offering for sale, having made, import,
or transfer of either its Contributions or its Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU Lesser
General Public License, Version 2.1, the GNU Affero General Public
License, Version 3.0, or any later versions of those licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that controls, is
controlled by, or is under common control with You. For purposes of this
definition, "control" means (a) the power, direct or indirect, to cause
the direction or management of such entity, whether by contract or
otherwise, or (b) ownership of more than fifty percent (50%) of the
outstanding shares or beneficial ownership of such entity.
2. License Grants and Conditions
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
a. under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
b. under Patent Claims of such Contributor to make, use, sell, offer for
sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
a. for any code that a Contributor has removed from Covered Software; or
b. for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
c. under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights to
grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
Section 2.1.
3. Responsibilities
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
a. such Covered Software must also be made available in Source Code Form,
as described in Section 3.1, and You must inform recipients of the
Executable Form how they can obtain a copy of such Source Code Form by
reasonable means in a timely manner, at a charge no more than the cost
of distribution to the recipient; and
b. You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter the
recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty, or
limitations of liability) contained within the Source Code Form of the
Covered Software, except that You may alter any license notices to the
extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
If it is impossible for You to comply with any of the terms of this License
with respect to some or all of the Covered Software due to statute,
judicial order, or regulation then You must: (a) comply with the terms of
this License to the maximum extent possible; and (b) describe the
limitations and the code they affect. Such description must be placed in a
text file included with all distributions of the Covered Software under
this License. Except to the extent prohibited by statute or regulation,
such description must be sufficiently detailed for a recipient of ordinary
skill to be able to understand it.
5. Termination
5.1. The rights granted under this License will terminate automatically if You
fail to comply with any of its terms. However, if You become compliant,
then the rights granted under this License from a particular Contributor
are reinstated (a) provisionally, unless and until such Contributor
explicitly and finally terminates Your grants, and (b) on an ongoing
basis, if such Contributor fails to notify You of the non-compliance by
some reasonable means prior to 60 days after You have come back into
compliance. Moreover, Your grants from a particular Contributor are
reinstated on an ongoing basis if such Contributor notifies You of the
non-compliance by some reasonable means, this is the first time You have
received notice of non-compliance with this License from such
Contributor, and You become compliant prior to 30 days after Your receipt
of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
license agreements (excluding distributors and resellers) which have been
validly granted by You or Your distributors under this License prior to
termination shall survive termination.
6. Disclaimer of Warranty
Covered Software is provided under this License on an "as is" basis,
without warranty of any kind, either expressed, implied, or statutory,
including, without limitation, warranties that the Covered Software is free
of defects, merchantable, fit for a particular purpose or non-infringing.
The entire risk as to the quality and performance of the Covered Software
is with You. Should any Covered Software prove defective in any respect,
You (not any Contributor) assume the cost of any necessary servicing,
repair, or correction. This disclaimer of warranty constitutes an essential
part of this License. No use of any Covered Software is authorized under
this License except under this disclaimer.
7. Limitation of Liability
Under no circumstances and under no legal theory, whether tort (including
negligence), contract, or otherwise, shall any Contributor, or anyone who
distributes Covered Software as permitted above, be liable to You for any
direct, indirect, special, incidental, or consequential damages of any
character including, without limitation, damages for lost profits, loss of
goodwill, work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses, even if such party shall have been
informed of the possibility of such damages. This limitation of liability
shall not apply to liability for death or personal injury resulting from
such party's negligence to the extent applicable law prohibits such
limitation. Some jurisdictions do not allow the exclusion or limitation of
incidental or consequential damages, so this exclusion and limitation may
not apply to You.
8. Litigation
Any litigation relating to this License may be brought only in the courts
of a jurisdiction where the defendant maintains its principal place of
business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions. Nothing
in this Section shall prevent a party's ability to bring cross-claims or
counter-claims.
9. Miscellaneous
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides that
the language of a contract shall be construed against the drafter shall not
be used to construe this License against a Contributor.
10. Versions of the License
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses If You choose to distribute Source Code Form that is
Incompatible With Secondary Licenses under the terms of this version of
the License, the notice described in Exhibit B of this License must be
attached.
Exhibit A - Source Code Form License Notice
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file,
then You may include the notice in a location (such as a LICENSE file in a
relevant directory) where a recipient would be likely to look for such a
notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
This Source Code Form is "Incompatible
With Secondary Licenses", as defined by
the Mozilla Public License, v. 2.0.

21
testing/eslint-plugin-mozilla/docs/components-imports.rst Normal file
View File

@ -0,0 +1,21 @@
.. _components-imports:
==================
components-imports
==================
Rule Details
------------
Adds the filename of imported files e.g.
``Cu.import("some/path/Blah.jsm")`` adds Blah to the global scope.
The following patterns are supported:
- ``Cu.import("resource:///modules/devtools/ViewHelpers.jsm");``
- ``loader.lazyImporter(this, "name1");``
- ``loader.lazyRequireGetter(this, "name2"``
- ``loader.lazyServiceGetter(this, "name3"``
- ``XPCOMUtils.defineLazyModuleGetter(this, "setNamedTimeout", ...)``
- ``loader.lazyGetter(this, "toolboxStrings"``
- ``XPCOMUtils.defineLazyGetter(this, "clipboardHelper"``

31
testing/eslint-plugin-mozilla/docs/import-headjs-globals.rst Normal file
View File

@ -0,0 +1,31 @@
.. _import-headjs-globals:
=====================
import-headjs-globals
=====================
Rule Details
------------
Import globals from head.js and from any files that were imported by
head.js (as far as we can correctly resolve the path).
The following file import patterns are supported:
- ``Services.scriptloader.loadSubScript(path)``
- ``loader.loadSubScript(path)``
- ``loadSubScript(path)``
- ``loadHelperScript(path)``
If path does not exist because it is generated e.g.
``testdir + "/somefile.js"`` we do our best to resolve it.
The following patterns are supported:
- ``Cu.import("resource:///modules/devtools/ViewHelpers.jsm");``
- ``loader.lazyImporter(this, "name1");``
- ``loader.lazyRequireGetter(this, "name2"``
- ``loader.lazyServiceGetter(this, "name3"``
- ``XPCOMUtils.defineLazyModuleGetter(this, "setNamedTimeout", ...)``
- ``loader.lazyGetter(this, "toolboxStrings"``
- ``XPCOMUtils.defineLazyGetter(this, "clipboardHelper"``

41
testing/eslint-plugin-mozilla/docs/index.rst Normal file
View File

@ -0,0 +1,41 @@
.. _index:
=====================
Mozilla ESLint Plugin
=====================
``components-imports`` adds the filename of imported files e.g.
``Cu.import("some/path/Blah.jsm")`` adds Blah to the global scope.
``import-headjs-globals`` imports globals from head.js and from any files that
should be imported by head.js (as far as we can correctly resolve the path).
``mark-test-function-used`` simply marks test (the test method) as used. This
avoids ESLint telling us that the function is never called.
+-------+-----------------------+
| Possible values for all rules |
+-------+-----------------------+
| Value | Meaning |
+-------+-----------------------+
| 0 | Deactivated |
+-------+-----------------------+
| 1 | Warning |
+-------+-----------------------+
| 2 | Error |
+-------+-----------------------+
Example configuration::
"rules": {
"mozilla/components-imports": 1,
"mozilla/import-headjs-globals": 1,
"mozilla/mark-test-function-used": 1,
}
.. toctree::
:maxdepth: 1
components-imports
import-headjs-globals
mark-test-function-used

11
testing/eslint-plugin-mozilla/docs/mark-test-function-used.rst Normal file
View File

@ -0,0 +1,11 @@
.. _mark-test-function-used:
=======================
mark-test-function-used
=======================
Rule Details
------------
Simply marks test (the test method) as used. This avoids ESLint telling
us that the function is never called.

193
testing/eslint-plugin-mozilla/lib/helpers.js Normal file
View File

@ -0,0 +1,193 @@
/**
* @fileoverview A collection of helper functions.
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
var escope = require("eslint/node_modules/escope");
var espree = require("eslint/node_modules/espree");
var regexes = [
/^(?:Cu|Components\.utils)\.import\(".*\/(.*?)\.jsm?"\);?$/,
/^loader\.lazyImporter\(\w+, "(\w+)"/,
/^loader\.lazyRequireGetter\(\w+, "(\w+)"/,
/^loader\.lazyServiceGetter\(\w+, "(\w+)"/,
/^XPCOMUtils\.defineLazyModuleGetter\(\w+, "(\w+)"/,
/^loader\.lazyGetter\(\w+, "(\w+)"/,
/^XPCOMUtils\.defineLazyGetter\(\w+, "(\w+)"/
];
module.exports = {
/**
* Gets the abstract syntax tree (AST) of the JavaScript source code contained
* in sourceText.
*
* @param {String} sourceText
* Text containing valid JavaScript.
*
* @return {Object}
* The resulting AST.
*/
getAST: function(sourceText) {
// Use a permissive config file to allow parsing of anything that Espree
// can parse.
var config = this.getPermissiveConfig();
return espree.parse(sourceText, config);
},
/**
* Gets the source text of an AST node.
*
* @param {ASTNode} node
* The AST node representing the source text.
* @param {ASTContext} context
* The current context.
*
* @return {String}
* The source text representing the AST node.
*/
getSource: function(node, context) {
return context.getSource(node).replace(/[\r\n]+\s*/g, " ")
.replace(/\s*=\s*/g, " = ")
.replace(/\s+\./g, ".")
.replace(/,\s+/g, ", ")
.replace(/;\n(\d+)/g, ";$1")
.replace(/\s+/g, " ");
},
/**
* Gets the variable name from an import source
* e.g. Cu.import("path/to/someName") will return "someName."
*
* Some valid input strings:
* - Cu.import("resource:///modules/devtools/ViewHelpers.jsm");
* - loader.lazyImporter(this, "name1");
* - loader.lazyRequireGetter(this, "name2"
* - loader.lazyServiceGetter(this, "name3"
* - XPCOMUtils.defineLazyModuleGetter(this, "setNamedTimeout", ...)
* - loader.lazyGetter(this, "toolboxStrings"
* - XPCOMUtils.defineLazyGetter(this, "clipboardHelper"
*
* @param {String} source
* The source representing an import statement.
*
* @return {String}
* The variable name imported.
*/
getVarNameFromImportSource: function(source) {
for (var i = 0; i < regexes.length; i++) {
var regex = regexes[i];
var matches = source.match(regex);
if (matches) {
var name = matches[1];
return name;
}
}
},
/**
* Get an array of globals from an AST.
*
* @param {Object} ast
* The AST for which the globals are to be returned.
*
* @return {Array}
* An array of variable names.
*/
getGlobals: function(ast) {
var scopeManager = escope.analyze(ast);
var globalScope = scopeManager.acquire(ast);
var result = [];
for (var variable in globalScope.variables) {
var name = globalScope.variables[variable].name;
result.push(name);
}
return result;
},
/**
* Add a variable to the current scope.
* HACK: This relies on eslint internals so it could break at any time.
*
* @param {String} name
* The variable name to add to the current scope.
* @param {ASTContext} context
* The current context.
*/
addVarToScope: function(name, context) {
var scope = context.getScope();
var variables = scope.variables;
var variable = new escope.Variable(name, scope);
variable.eslintExplicitGlobal = false;
variable.writeable = true;
variables.push(variable);
},
/**
* Get the single line text represented by a particular AST node.
*
* @param {ASTNode} node
* The AST node representing the source text.
* @param {String} text
* The text representing the AST node.
*
* @return {String}
* A single line version of the string represented by node.
*/
getTextForNode: function(node, text) {
var source = text.substr(node.range[0], node.range[1] - node.range[0]);
return source.replace(/[\r\n]+\s*/g, "")
.replace(/\s*=\s*/g, " = ")
.replace(/\s+\./g, ".")
.replace(/,\s+/g, ", ")
.replace(/;\n(\d+)/g, ";$1");
},
/**
* To allow espree to parse almost any JavaScript we need as many features as
* possible turned on. This method returns that config.
*
* @return {Object}
* Espree compatible permissive config.
*/
getPermissiveConfig: function() {
return {
range: true,
loc: true,
tolerant: true,
ecmaFeatures: {
arrowFunctions: true,
blockBindings: true,
destructuring: true,
regexYFlag: true,
regexUFlag: true,
templateStrings: true,
binaryLiterals: true,
octalLiterals: true,
unicodeCodePointEscapes: true,
defaultParams: true,
restParams: true,
forOf: true,
objectLiteralComputedProperties: true,
objectLiteralShorthandMethods: true,
objectLiteralShorthandProperties: true,
objectLiteralDuplicateProperties: true,
generators: true,
spread: true,
superInFunctions: true,
classes: true,
modules: true,
globalReturn: true
}
};
}
};

25
testing/eslint-plugin-mozilla/lib/index.js Normal file
View File

@ -0,0 +1,25 @@
/**
* @fileoverview A collection of rules that help enforce JavaScript coding
* standard and avoid common errors in the Mozilla project.
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
//------------------------------------------------------------------------------
// Plugin Definition
//------------------------------------------------------------------------------
module.exports = {
rules: {
"components-imports": require("../lib/rules/components-imports"),
"import-headjs-globals": require("../lib/rules/import-headjs-globals"),
"mark-test-function-used": require("../lib/rules/mark-test-function-used")
},
rulesConfig: {
"components-imports": 0,
"import-headjs-globals": 0,
"mark-test-function-used": 0
}
};

33
testing/eslint-plugin-mozilla/lib/rules/components-imports.js Normal file
View File

@ -0,0 +1,33 @@
/**
* @fileoverview Adds the filename of imported files e.g.
* Cu.import("some/path/Blah.jsm") adds Blah to the current scope.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
var path = require("path");
var helpers = require("../helpers");
module.exports = function(context) {
//--------------------------------------------------------------------------
// Public
//--------------------------------------------------------------------------
return {
ExpressionStatement: function(node) {
var source = helpers.getSource(node, context);
var name = helpers.getVarNameFromImportSource(source);
if (name) {
helpers.addVarToScope(name, context);
}
}
};
};

100
testing/eslint-plugin-mozilla/lib/rules/import-headjs-globals.js Normal file
View File

@ -0,0 +1,100 @@
/**
* @fileoverview Import globals from head.js and from any files that were
* imported by head.js (as far as we can correctly resolve the path).
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
var fs = require("fs");
var path = require("path");
var helpers = require("../helpers");
module.exports = function(context) {
//--------------------------------------------------------------------------
// Helpers
//--------------------------------------------------------------------------
function checkFile(fileArray, context) {
var filePath = fileArray.pop();
while (filePath) {
var headText;
try {
headText = fs.readFileSync(filePath, "utf8");
} catch(e) {
// Couldn't find file, continue.
filePath = fileArray.pop();
continue;
}
var ast = helpers.getAST(headText);
var globalVars = helpers.getGlobals(ast);
for (var i = 0; i < globalVars.length; i++) {
var name = globalVars[i];
helpers.addVarToScope(name, context);
}
for (var index in ast.body) {
var node = ast.body[index];
var source = helpers.getTextForNode(node, headText);
var name = helpers.getVarNameFromImportSource(source);
if (name) {
helpers.addVarToScope(name, context);
continue;
}
// Scripts loaded using loadSubScript or loadHelperScript
var matches =
source.match(/^(?:Services\.scriptloader\.|loader)?loadSubScript\((.+)[",]/);
if (!matches) {
matches = source.match(/^loadHelperScript\((.+)[",]/);
}
if (matches) {
var cwd = process.cwd();
filePath = matches[1];
filePath = filePath.replace("chrome://mochitests/content/browser", cwd + "/../../../..");
filePath = filePath.replace(/testdir\s*\+\s*["']/gi, cwd + "/");
filePath = filePath.replace(/test_dir\s*\+\s*["']/gi, cwd);
filePath = filePath.replace(/["']/gi, "");
filePath = path.normalize(filePath);
fileArray.push(filePath);
}
}
filePath = fileArray.pop();
}
}
//--------------------------------------------------------------------------
// Public
//--------------------------------------------------------------------------
return {
Program: function(node) {
var pathAndFilename = this.getFilename();
var processPath = process.cwd();
var isTest = /.*\/browser_.+\.js$/.test(pathAndFilename);
if (!isTest) {
return;
}
var testFilename = path.basename(pathAndFilename);
var testPath = path.join(processPath, testFilename);
var headjs = path.join(processPath, "head.js");
checkFile([testPath, headjs], context);
}
};
};

25
testing/eslint-plugin-mozilla/lib/rules/mark-test-function-used.js Normal file
View File

@ -0,0 +1,25 @@
/**
* @fileoverview Simply marks test (the test method) as used. This avoids ESLint
* telling us that the function is never called..
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = function(context) {
//--------------------------------------------------------------------------
// Public
//--------------------------------------------------------------------------
return {
Program: function(node) {
context.markVariableAsUsed("test");
}
};
};

7
testing/eslint-plugin-mozilla/moz.build Normal file
View File

@ -0,0 +1,7 @@
# -*- Mode: python; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*-
# vim: set filetype=python:
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
SPHINX_TREES['eslint-plugin-mozilla'] = 'docs'

25
testing/eslint-plugin-mozilla/package.json Normal file
View File

@ -0,0 +1,25 @@
{
"name": "eslint-plugin-mozilla",
"version": "0.0.2",
"description": "A collection of rules that help enforce JavaScript coding standard in the Mozilla project.",
"keywords": [
"eslint",
"eslintplugin",
"eslint-plugin",
"mozilla",
"firefox"
],
"bugs": {
"url": "https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools"
},
"homepage": "https://bugzilla.mozilla.org/show_bug.cgi?id=1203520",
"author": "Mike Ratcliffe",
"main": "lib/index.js",
"devDependencies": {
"eslint": "~1.2.0"
},
"engines": {
"node": ">=0.10.0"
},
"license": "MPL-2.0"
}