@chassis/core/src/lib/utilities/FileUtils.js

CSS4 pre-processor and responsive framework for modern UI development

import fs from 'fs-extra'
import path from 'path'
import parser from 'postcss-scss'

export default class FileUtils {
  /**
   * @method fileExists
   * Determine whether or not a filepath points to an existing file
   * @param {string} filepath
   * @param {boolean} relative
   * @static
   */
  static fileExists (filepath) {
    return fs.existsSync(filepath)
  }

  /**
   * @method getFileExtension
   * Returns the extension name of a file.
   * @param  {string} filepath
   * Path to file.
   * @return {string}
   */
  static getFileExtension (filepath) {
    return path.extname(filepath)
  }

  /**
   * @method getFilePath
   * Strips the file name and extension from the provided path
   * @param  {string} filepath
   * @return {string}
   * @static
   */
  static getFilePath (filepath) {
    return filepath.substring(0, filepath.lastIndexOf('/'))
  }

  /**
   * @method getFileName
   * Returns the name of the file at the provided path
   * @param  {string} filepath
   * @return {string}
   * @static
   */
  static getFileName (filepath) {
    return path.basename(filepath)
  }

  /**
   * @method isDirectory
   * Determine whether or not a filepath points to a directory
   * @param {string} filepath
   * @static
   */
  static isDirectory (filepath) {
    if (fs.existsSync(filepath)) {
      return fs.lstatSync(filepath).isDirectory()
    }

    return false
  }

  /**
   * @method parseDirectory
   * Parse all style sheets in a directory. This method does NOT parse subdirectories.
   * @param {string} dir
   * Directory to query for stylesheets.
   * @param {boolean} relative
   * Whether or not dirpath is relative (false means absolute)
   * @static
   */
  static parseDirectory (dir, relative = true) {
    dir = relative ? this.resolve(dir) : dir

    const files = fs.readdirSync(dir)
      .filter(item => !this.isDirectory(item))
      .filter(file => this.getFileExtension(file) === '.css')
      .map(file => path.join(dir, file))

    return files.length > 0 ? this.parseStyleSheets(files, false) : ''
  }

  // static parseSpecSheet (filepath, relative = true) {
  //   return this.parseStyleSheet(...arguments)
  // }

  // static hydrateSpecSheet (ast, vars) {
  //   if (!vars || Object.keys(vars).length === 0) {
  //     return
  //   }
  //
  //   ast.walk(node => {
  //     switch (node.type) {
  //       case 'atrule':
  //         node.params = StringUtils.interpolate(node.params, vars)
  //         break
  //
  //       case 'rule':
  //         node.selector = StringUtils.interpolate(node.selector, vars)
  //         break
  //
  //       case 'decl':
  //         node.prop = StringUtils.interpolate(node.prop, vars)
  //         node.value = StringUtils.interpolate(node.value, vars)
  //         break
  //
  //       default: return
  //     }
  //   })
  // }

  /**
   * @method parseStyleSheet
   * Parse a CSS style sheet into a postcss AST
   * @param {string} filepath
   * @return {AST}
   * @static
   */
  static parseStyleSheet (filepath) {
    return parser.parse(fs.readFileSync(filepath), { from: filepath })
  }

  /**
   * @method parseStyleSheets
   * Parses an array of CSS style sheets into a single postcss AST
   * @param {array} filepaths
   * @return {AST}
   * @static
   */
  static parseStyleSheets (filepaths, relative = true) {
    const output = this.parseStyleSheet(filepaths[0], relative)
    const remainingFilepaths = filepaths.slice(1)
    remainingFilepaths.forEach(path => output.append(this.parseStyleSheet(path, relative)))
    return output
  }

  /**
   * @method pathIsAbsolute
   * Determines whether a path is absolute (true) or relative (false)
   * @param  {string} filepath
   * @return {boolean}
   * @static
   */
  static pathIsAbsolute (filepath) {
    return path.isAbsolute(filepath)
  }

  // /**
  //  * @method resolve
  //  * Resolve a relative path
  //  * @param {string} filepath
  //  * @static
  //  */
  // static resolve (filepath) {
  //   return path.join(__dirname, '../', filepath)
  // }
}