summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js')
-rw-r--r--tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js51
1 files changed, 51 insertions, 0 deletions
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js
new file mode 100644
index 0000000000..98fe94e26e
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-osfile.js
@@ -0,0 +1,51 @@
+/**
+ * @fileoverview Reject calls into OS.File. We're phasing this out in
+ * favour of IOUtils.
+ *
+ * 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 { maybeGetMemberPropertyName } = require("../helpers");
+
+function isIdentifier(node, id) {
+ return node && node.type === "Identifier" && node.name === id;
+}
+
+function isOSProp(expr, prop) {
+ return (
+ maybeGetMemberPropertyName(expr.object) === "OS" &&
+ isIdentifier(expr.property, prop)
+ );
+}
+
+module.exports = {
+ meta: {
+ docs: {
+ url:
+ "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/reject-osfile.html",
+ },
+ type: "problem",
+ },
+
+ create(context) {
+ return {
+ MemberExpression(node) {
+ if (isOSProp(node, "File")) {
+ context.report(
+ node,
+ "OS.File is deprecated. You should use IOUtils instead."
+ );
+ } else if (isOSProp(node, "Path")) {
+ context.report(
+ node,
+ "OS.Path is deprecated. You should use PathUtils instead."
+ );
+ }
+ },
+ };
+ },
+};