playwright/utils/doclint/Source.js

/**
 * Copyright 2017 Google Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

const path = require('path');
const util = require('util');
const fs = require('fs');

const readFileAsync = util.promisify(fs.readFile);
const statAsync = util.promisify(fs.stat);
const readdirAsync = util.promisify(fs.readdir);
const writeFileAsync = util.promisify(fs.writeFile);

const PROJECT_DIR = path.join(__dirname, '..', '..');

async function recursiveReadDir(dirPath, exclude) {
  const files = [];
  if (exclude.includes(dirPath))
    return files;
  for (const file of await readdirAsync(dirPath)) {
    const fullPath = path.join(dirPath, file);
    if ((await statAsync(fullPath)).isDirectory())
      files.push(...await recursiveReadDir(fullPath, exclude))
    else
      files.push(fullPath);
  }
  return files;
}

class Source {
  /**
   * @param {string} filePath
   * @param {string} text
   */
  constructor(filePath, text) {
    this._filePath = filePath;
    this._projectPath = path.relative(PROJECT_DIR, filePath);
    this._name = path.basename(filePath);
    this._text = text;
    this._hasUpdatedText = false;
  }

  /**
   * @return {string}
   */
  filePath() {
    return this._filePath;
  }

  /**
   * @return {string}
   */
  projectPath() {
    return this._projectPath;
  }

  /**
   * @return {string}
   */
  name() {
    return this._name;
  }

  /**
   * @param {string} text
   * @return {boolean}
   */
  setText(text) {
    if (text === this._text)
      return false;
    this._hasUpdatedText = true;
    this._text = text;
    return true;
  }

  /**
   * @return {string}
   */
  text() {
    return this._text;
  }

  /**
   * @return {boolean}
   */
  hasUpdatedText() {
    return this._hasUpdatedText;
  }

  async save() {
    await writeFileAsync(this.filePath(), this.text());
  }

  async saveAs(path) {
    await writeFileAsync(path, this.text());
  }

  /**
   * @param {string} filePath
   * @return {!Promise<Source>}
   */
  static async readFile(filePath) {
    filePath = path.resolve(filePath);
    const text = await readFileAsync(filePath, {encoding: 'utf8'});
    return new Source(filePath, text);
  }

  /**
   * @param {string} dirPath
   * @param {string=} extension
   * @param {Array<string>=} exclude
   * @return {!Promise<!Array<!Source>>}
   */
  static async readdir(dirPath, extension = '', exclude = []) {
    extension = extension.toLowerCase();
    const filePaths = (await recursiveReadDir(dirPath, exclude)).filter(fileName => fileName.toLowerCase().endsWith(extension));
    return Promise.all(filePaths.map(filePath => Source.readFile(filePath)));
  }
}
module.exports = Source;