mirror of
https://github.com/zen-browser/desktop
synced 2026-04-25 17:15:00 +02:00
fix: Start working on more eslint rules, p=#11874
* fix: Start working on more eslint rules, b=no-bug, c=common, mods, workspaces * chore: Continue migration, b=no-bug, c=workflows, windows, glance, mods, welcome, workspaces, common, compact-mode, folders, tests, kbs, media, split-view, tabs * chore: Finish, b=no-bug, c=common, compact-mode, folders, glance, tests, kbs, media, mods, split-view, tabs, workspaces, welcome * fix: Fix installing deps, b=no-bug, c=common * feat: Dont initialize git on download checks, b=no-bug, c=workflows * feat: Remove empty JS docs, b=no-bug, c=common, compact-mode, folders, glance, kbs, media, mods, split-view, tabs, tests, workspaces * chore: Run lint, b=no-bug, c=common, folders, glance, kbs, mods, split-view, tabs, workspaces
This commit is contained in:
363
tools/eslint-plugin-spidermonkey-js/LICENSE
Normal file
363
tools/eslint-plugin-spidermonkey-js/LICENSE
Normal 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.
|
||||
|
||||
@@ -0,0 +1,182 @@
|
||||
/**
|
||||
* @file Add environment defaults to SpiderMonkey's self-hosted JS.
|
||||
*
|
||||
* 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";
|
||||
|
||||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
|
||||
let gRootDir = null;
|
||||
|
||||
/**
|
||||
* Gets the root directory of the repository by walking up directories from
|
||||
* this file until the top-level mozilla-central package.json file is found.
|
||||
* If this fails, the same procedure will be attempted from the current
|
||||
* working dir.
|
||||
* Copied from `tools/lint/eslint/eslint-plugin-mozilla/lib/helpers.js`.
|
||||
*
|
||||
* @returns {string} The absolute path of the repository directory
|
||||
*/
|
||||
function getRootDir() {
|
||||
if (!gRootDir) {
|
||||
function searchUpForPackage(dirName) {
|
||||
let parsed = path.parse(dirName);
|
||||
while (parsed.root !== dirName) {
|
||||
let possibleFile = path.join(dirName, "package.json");
|
||||
if (fs.existsSync(possibleFile)) {
|
||||
let packageData = require(possibleFile);
|
||||
if (packageData.name == "mozilla-central") {
|
||||
return dirName;
|
||||
}
|
||||
}
|
||||
// Move up a level
|
||||
dirName = parsed.dir;
|
||||
parsed = path.parse(dirName);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
let possibleRoot = searchUpForPackage(path.dirname(module.filename));
|
||||
if (!possibleRoot) {
|
||||
possibleRoot = searchUpForPackage(path.resolve());
|
||||
}
|
||||
if (!possibleRoot) {
|
||||
// We've couldn't find a root from the module or CWD, so lets just go
|
||||
// for the CWD. We really don't want to throw if possible, as that
|
||||
// tends to give confusing results when used with ESLint.
|
||||
possibleRoot = process.cwd();
|
||||
}
|
||||
|
||||
gRootDir = possibleRoot;
|
||||
}
|
||||
|
||||
return gRootDir;
|
||||
}
|
||||
|
||||
function tryReadFile(filePath) {
|
||||
let absPath = path.join(getRootDir(), filePath);
|
||||
if (!fs.existsSync(absPath)) {
|
||||
// Safely handle the case when the file wasn't found, because throwing
|
||||
// errors can lead to confusing result when used with ESLint.
|
||||
return "";
|
||||
}
|
||||
return fs.readFileSync(absPath, "utf-8");
|
||||
}
|
||||
|
||||
// Search for top-level declarations, #defines, and #includes.
|
||||
function addGlobalsFrom(dirName, fileName, globals) {
|
||||
let filePath = path.join(dirName, fileName);
|
||||
|
||||
// Definitions are separated by line.
|
||||
let lines = tryReadFile(filePath).split("\n");
|
||||
|
||||
// We don't have to fully parse the source code, because it's formatted
|
||||
// through "prettier", which means we know the exact code structure.
|
||||
//
|
||||
// |class| is disallowed in self-hosted code, so we don't have to handle it.
|
||||
for (let line of lines) {
|
||||
if (
|
||||
line.startsWith("function") ||
|
||||
line.startsWith("function*") ||
|
||||
line.startsWith("async function") ||
|
||||
line.startsWith("async function*")
|
||||
) {
|
||||
let m = line.match(/^(?:async )?function(?:\*)?\s+([\w\$]+)\s*\(/);
|
||||
if (m) {
|
||||
globals[m[1]] = "readonly";
|
||||
}
|
||||
} else if (line.startsWith("var") || line.startsWith("let") || line.startsWith("const")) {
|
||||
let m = line.match(/^(?:var|let|const)\s+([\w\$]+)\s*[;=]/);
|
||||
if (m) {
|
||||
globals[m[1]] = "readonly";
|
||||
}
|
||||
} else if (line.startsWith("#define")) {
|
||||
let m = line.match(/^#define (\w+)/);
|
||||
if (m) {
|
||||
globals[m[1]] = "readonly";
|
||||
}
|
||||
} else if (line.startsWith("#include")) {
|
||||
let m = line.match(/^#include \"([\w\.]+)\"$/);
|
||||
if (m) {
|
||||
// Also process definitions from includes.
|
||||
addGlobalsFrom(dirName, m[1], globals);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function selfHostingDefines(dirName = "js/src/builtin/") {
|
||||
let absDir = path.join(getRootDir(), dirName);
|
||||
if (!fs.existsSync(absDir)) {
|
||||
// See |tryReadFile| for why we avoid to throw any errors.
|
||||
return {};
|
||||
}
|
||||
|
||||
// Search sub-directories and js-files within |dirName|.
|
||||
let dirs = [];
|
||||
let jsFiles = [];
|
||||
for (let name of fs.readdirSync(absDir)) {
|
||||
let stat = fs.statSync(path.join(absDir, name));
|
||||
if (stat.isDirectory()) {
|
||||
dirs.push(name);
|
||||
} else if (stat.isFile() && name.endsWith(".js")) {
|
||||
jsFiles.push(name);
|
||||
}
|
||||
}
|
||||
|
||||
let globals = Object.create(null);
|
||||
|
||||
// Process each js-file.
|
||||
for (let jsFile of jsFiles) {
|
||||
addGlobalsFrom(dirName, jsFile, globals);
|
||||
}
|
||||
|
||||
// Recursively traverse all sub-directories.
|
||||
for (let dir of dirs) {
|
||||
globals = { ...globals, ...selfHostingDefines(path.join(dirName, dir)) };
|
||||
}
|
||||
|
||||
return globals;
|
||||
}
|
||||
|
||||
function selfHostingFunctions() {
|
||||
// Definitions can be spread across multiple lines and may have extra
|
||||
// whitespace, so we simply remove all whitespace and match over the complete
|
||||
// file.
|
||||
let content = tryReadFile("js/src/vm/SelfHosting.cpp").replace(/\s+/g, "");
|
||||
|
||||
let globals = Object.create(null);
|
||||
let re = /(?:JS_FN|JS_INLINABLE_FN|JS_TRAMPOLINE_FN)\("(\w+)"/g;
|
||||
for (let m of content.matchAll(re)) {
|
||||
globals[m[1]] = "readonly";
|
||||
}
|
||||
return globals;
|
||||
}
|
||||
|
||||
function errorNumbers() {
|
||||
// Definitions are separated by line.
|
||||
let lines = tryReadFile("js/public/friend/ErrorNumbers.msg").split("\n");
|
||||
|
||||
let globals = Object.create(null);
|
||||
for (let line of lines) {
|
||||
let m = line.match(/^MSG_DEF\((\w+),/);
|
||||
if (m) {
|
||||
globals[m[1]] = "readonly";
|
||||
}
|
||||
}
|
||||
return globals;
|
||||
}
|
||||
|
||||
const globals = {
|
||||
...selfHostingDefines(),
|
||||
...selfHostingFunctions(),
|
||||
...errorNumbers(),
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
globals,
|
||||
};
|
||||
21
tools/eslint-plugin-spidermonkey-js/lib/index.js
Normal file
21
tools/eslint-plugin-spidermonkey-js/lib/index.js
Normal file
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* @file A processor to help parse the spidermonkey js code.
|
||||
* 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 = {
|
||||
meta: { name: "eslint-plugin-spidermonkey-js", version: "0.1.1" },
|
||||
processors: {
|
||||
processor: require("./processors/self-hosted"),
|
||||
},
|
||||
environments: {
|
||||
environment: require("./environments/self-hosted"),
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,128 @@
|
||||
/**
|
||||
* @file Remove macros from SpiderMonkey's self-hosted JS.
|
||||
*
|
||||
* 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";
|
||||
|
||||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
|
||||
const selfHostedRegex = /js\/src\/builtin\/.*?\.js$/;
|
||||
const macroRegex = /\s*\#(if|ifdef|else|elif|endif|include|define|undef|error).*/;
|
||||
|
||||
function isSelfHostedFile(filename) {
|
||||
if (path.win32) {
|
||||
filename = filename.split(path.sep).join("/");
|
||||
}
|
||||
return selfHostedRegex.test(filename);
|
||||
}
|
||||
|
||||
function tryReadFile(filePath) {
|
||||
if (!path.isAbsolute(filePath)) {
|
||||
return "";
|
||||
}
|
||||
if (!fs.existsSync(filePath)) {
|
||||
// Safely handle the case when the file wasn't found, because throwing
|
||||
// errors can lead to confusing result when used with ESLint.
|
||||
return "";
|
||||
}
|
||||
return fs.readFileSync(filePath, "utf-8");
|
||||
}
|
||||
|
||||
// Adjust the range of fixes to match the original source code.
|
||||
function createFix(lines, message) {
|
||||
let { line, column, fix } = message;
|
||||
|
||||
// Line and column are 1-based. Make sure we got a valid input.
|
||||
if (line <= 0 || column <= 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Reject to create a fix when the line is out of range for some reason.
|
||||
if (line > lines.length) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Find the absolute start position of the line in the original file.
|
||||
let startOfLine = 0;
|
||||
for (let i = 0; i < line - 1; ++i) {
|
||||
// Add the length of the line, including its line separator.
|
||||
startOfLine += lines[i].length + "\n".length;
|
||||
}
|
||||
|
||||
// Add the 1-based column to the start of line to get the start position.
|
||||
let start = startOfLine + (column - 1);
|
||||
|
||||
// Add the fix range to get the end position.
|
||||
let end = start + (fix.range[1] - fix.range[0]);
|
||||
|
||||
// And finally return the new fix object.
|
||||
return { text: fix.text, range: [start, end] };
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
preprocess(text, filename) {
|
||||
if (!isSelfHostedFile(filename)) {
|
||||
return [text];
|
||||
}
|
||||
|
||||
let lines = text.split(/\n/);
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
if (!macroRegex.test(lines[i])) {
|
||||
// No macro here, nothing to do.
|
||||
continue;
|
||||
}
|
||||
|
||||
for (; i < lines.length; i++) {
|
||||
// The macro isn't correctly indented, so we need to instruct
|
||||
// prettier to ignore them.
|
||||
lines[i] = "// prettier-ignore -- " + lines[i];
|
||||
|
||||
// If the line ends with a backslash (\), the next line
|
||||
// is also part of part of the macro.
|
||||
if (!lines[i].endsWith("\\")) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return [lines.join("\n")];
|
||||
},
|
||||
|
||||
postprocess(messages, filename) {
|
||||
// Don't attempt to create fixes for any non-selfhosted files.
|
||||
if (!isSelfHostedFile(filename)) {
|
||||
return [].concat(...messages);
|
||||
}
|
||||
|
||||
let lines = null;
|
||||
|
||||
let result = [];
|
||||
for (let message of messages.flat()) {
|
||||
if (message.fix) {
|
||||
if (lines === null) {
|
||||
lines = tryReadFile(filename).split(/\n/);
|
||||
}
|
||||
|
||||
let fix = createFix(lines, message);
|
||||
if (fix) {
|
||||
message.fix = fix;
|
||||
} else {
|
||||
// We couldn't create a fix, so we better remove the passed in fix,
|
||||
// because its range points to the preprocessor output, but the post-
|
||||
// processor must translate it into a range of the original source.
|
||||
delete message.fix;
|
||||
}
|
||||
}
|
||||
|
||||
result.push(message);
|
||||
}
|
||||
return result;
|
||||
},
|
||||
|
||||
supportsAutofix: true,
|
||||
};
|
||||
28
tools/eslint-plugin-spidermonkey-js/package.json
Normal file
28
tools/eslint-plugin-spidermonkey-js/package.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"description": "A collection of rules that help enforce JavaScript coding standard in the Mozilla SpiderMonkey project.",
|
||||
"keywords": [
|
||||
"eslint",
|
||||
"eslintplugin",
|
||||
"eslint-plugin",
|
||||
"mozilla",
|
||||
"spidermonkey"
|
||||
],
|
||||
"bugs": {
|
||||
"url": "https://bugzilla.mozilla.org/enter_bug.cgi?product=Testing&component=Lint"
|
||||
},
|
||||
"homepage": "http://firefox-source-docs.mozilla.org/tools/lint/linters/eslint-plugin-spidermonkey-js.html",
|
||||
"repository": {
|
||||
"type": "hg",
|
||||
"url": "https://hg.mozilla.org/mozilla-central/"
|
||||
},
|
||||
"author": "Mozilla",
|
||||
"main": "lib/index.js",
|
||||
"dependencies": {},
|
||||
"devDependencies": {},
|
||||
"engines": {
|
||||
"node": ">=6.9.1"
|
||||
},
|
||||
"license": "MPL-2.0",
|
||||
"notes(private)": "We don't want to publish to npm, so this is marked as private",
|
||||
"private": true
|
||||
}
|
||||
Reference in New Issue
Block a user