.config/coc/extensions/node_modules/coc-prettier/node_modules/tslint/lib/rules/encodingRule.js

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2017 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 fs = require("fs");
  21 var Lint = require("../index");
  22 var utils_1 = require("../utils");
  23 var Rule = /** @class */ (function (_super) {
  24     tslib_1.__extends(Rule, _super);
  25     function Rule() {
  26         return _super !== null && _super.apply(this, arguments) || this;
  27     }
  28     /* tslint:enable:object-literal-sort-keys */
  29     Rule.FAILURE_STRING = function (actual) {
  30         return "This file is encoded as " + showEncoding(actual) + " instead of UTF-8.";
  31     };
  32     Rule.prototype.apply = function (sourceFile) {
  33         return this.applyWithFunction(sourceFile, walk);
  34     };
  35     /* tslint:disable:object-literal-sort-keys */
  36     Rule.metadata = {
  37         ruleName: "encoding",
  38         description: "Enforces UTF-8 file encoding.",
  39         optionsDescription: "Not configurable.",
  40         options: null,
  41         optionExamples: ["true"],
  42         type: "style",
  43         typescriptOnly: false,
  44     };
  45     return Rule;
  46 }(Lint.Rules.AbstractRule));
  47 exports.Rule = Rule;
  48 function walk(ctx) {
  49     var encoding = detectEncoding(ctx.sourceFile.fileName);
  50     if (encoding !== "utf8") {
  51         ctx.addFailure(0, 1, Rule.FAILURE_STRING(encoding));
  52     }
  53 }
  54 function showEncoding(encoding) {
  55     switch (encoding) {
  56         case "utf8":
  57             return "UTF-8";
  58         case "utf8-bom":
  59             return "UTF-8 with byte-order marker (BOM)";
  60         case "utf16le":
  61             return "UTF-16 (little-endian)";
  62         case "utf16be":
  63             return "UTF-16 (big-endian)";
  64     }
  65 }
  66 function detectEncoding(fileName) {
  67     var fd = fs.openSync(fileName, "r");
  68     var maxBytesRead = 3; // Only need 3 bytes to detect the encoding.
  69     var buffer = Buffer.allocUnsafe(maxBytesRead);
  70     var bytesRead = fs.readSync(fd, buffer,
  71     /*offset*/ 0,
  72     /*length*/ maxBytesRead,
  73     /*position*/ 0);
  74     fs.closeSync(fd);
  75     return utils_1.detectBufferEncoding(buffer, bytesRead);
  76 }