noBitwiseRule.js 4.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2013 Palantir Technologies, Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. Object.defineProperty(exports, "__esModule", { value: true });
  19. var tslib_1 = require("tslib");
  20. var ts = require("typescript");
  21. var Lint = require("../index");
  22. var Rule = /** @class */ (function (_super) {
  23. tslib_1.__extends(Rule, _super);
  24. function Rule() {
  25. return _super !== null && _super.apply(this, arguments) || this;
  26. }
  27. Rule.prototype.apply = function (sourceFile) {
  28. return this.applyWithFunction(sourceFile, walk);
  29. };
  30. /* tslint:disable:object-literal-sort-keys */
  31. Rule.metadata = {
  32. ruleName: "no-bitwise",
  33. description: "Disallows bitwise operators.",
  34. descriptionDetails: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Specifically, the following bitwise operators are banned:\n `&`, `&=`, `|`, `|=`,\n `^`, `^=`, `<<`, `<<=`,\n `>>`, `>>=`, `>>>`, `>>>=`, and `~`.\n This rule does not ban the use of `&` and `|` for intersection and union types."], ["\n Specifically, the following bitwise operators are banned:\n \\`&\\`, \\`&=\\`, \\`|\\`, \\`|=\\`,\n \\`^\\`, \\`^=\\`, \\`<<\\`, \\`<<=\\`,\n \\`>>\\`, \\`>>=\\`, \\`>>>\\`, \\`>>>=\\`, and \\`~\\`.\n This rule does not ban the use of \\`&\\` and \\`|\\` for intersection and union types."]))),
  35. rationale: Lint.Utils.dedent(templateObject_2 || (templateObject_2 = tslib_1.__makeTemplateObject(["\n Bitwise operators are often typos - for example `bool1 & bool2` instead of `bool1 && bool2`.\n They also can be an indicator of overly clever code which decreases maintainability."], ["\n Bitwise operators are often typos - for example \\`bool1 & bool2\\` instead of \\`bool1 && bool2\\`.\n They also can be an indicator of overly clever code which decreases maintainability."]))),
  36. optionsDescription: "Not configurable.",
  37. options: null,
  38. optionExamples: [true],
  39. type: "functionality",
  40. typescriptOnly: false,
  41. };
  42. /* tslint:enable:object-literal-sort-keys */
  43. Rule.FAILURE_STRING = "Forbidden bitwise operation";
  44. return Rule;
  45. }(Lint.Rules.AbstractRule));
  46. exports.Rule = Rule;
  47. function walk(ctx) {
  48. return ts.forEachChild(ctx.sourceFile, function cb(node) {
  49. if (node.kind === ts.SyntaxKind.BinaryExpression) {
  50. switch (node.operatorToken.kind) {
  51. case ts.SyntaxKind.AmpersandToken:
  52. case ts.SyntaxKind.AmpersandEqualsToken:
  53. case ts.SyntaxKind.BarToken:
  54. case ts.SyntaxKind.BarEqualsToken:
  55. case ts.SyntaxKind.CaretToken:
  56. case ts.SyntaxKind.CaretEqualsToken:
  57. case ts.SyntaxKind.LessThanLessThanToken:
  58. case ts.SyntaxKind.LessThanLessThanEqualsToken:
  59. case ts.SyntaxKind.GreaterThanGreaterThanToken:
  60. case ts.SyntaxKind.GreaterThanGreaterThanEqualsToken:
  61. case ts.SyntaxKind.GreaterThanGreaterThanGreaterThanToken:
  62. case ts.SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken:
  63. ctx.addFailureAtNode(node, Rule.FAILURE_STRING);
  64. }
  65. }
  66. else if (node.kind === ts.SyntaxKind.PrefixUnaryExpression &&
  67. node.operator === ts.SyntaxKind.TildeToken) {
  68. ctx.addFailureAtNode(node, Rule.FAILURE_STRING);
  69. }
  70. return ts.forEachChild(node, cb);
  71. });
  72. }
  73. var templateObject_1, templateObject_2;