@theopenweb/node-recently-modified/index.js

Simple Node js library for getting recently modified files. Main goal is for having a way of getting modified files that need to be back-upped. By default, gets only folders, but can set to get only files and both too.

const { Stats } = require('fs-extra')
const readdir = require('recursive-readdir')

const Settings = () => {
  return {
    path: './',
    /**
     * @type {string[]}
     */
    exclude: [], // globs
    files: true,
    directories: true,
    newerThan: 0,
    logging: true
  }
}

class Builder {
  constructor () {
    /**
     * @type {ReturnType<Settings>}
     */
    this.settings = Settings()
  }

  /**
   * Set source path
   * @param {String} dir
   * @return {Builder}
   */
  path (dir = './') {
    this.settings.path = dir
    return this
  }

  /**
   * Exclude directories
   * @param {string[]} dirList
   * @return {Builder}
   */
  exclude (dirList = []) {
    this.settings.exclude = this.settings.exclude.concat(dirList)
    return this
  }

  /**
   * Sets whether to include files
   * @param {boolean} [bool]
   * @return {Builder}
   */
  files (bool = false) {
    this.settings.files = bool
    return this
  }

  /**
   * Sets whether to include directories
   * @param {boolean} [bool]
   * @return {Builder}
   */
  directories (bool = false) {
    this.settings.directories = bool
    return this
  }

  /**
   * Sets newer than setting
   * @param {Date} datetime
   * @return {Builder}
   */
  newerThan (datetime) {
    this.settings.newerThan = Number(datetime)
    return this
  }

/**
   * Sets whether to output logs.
   * If not set, uses true.
   * @param {boolean} [bool]
   * @return {Builder}
   */
  logging (bool = false) {
    this.settings.logging = bool
    return this
  }

  /**
   * Executes the scan
   * @return {Promise<string[]>} Resolves list of files
   */
  exec () {
    if(this.settings.logging){
        console.log('exec', 'Settings: newerThan is stored in milliseconds', {
          'settings': this.settings
        })
    }
    // https://github.com/jergason/recursive-readdir
    // @ts-ignore
    const promise = readdir(this.settings.path, [...this.settings.exclude, this._oldExcluder.bind(this)])
    return promise
  }

  /**
  * @see https://github.com/jergason/recursive-readdir/issues/61
  * @param {File} file
  * @param {Stats} stats
  * @return {boolean}
   */
  _oldExcluder (file, stats) {
    if(this.settings.logging){
        console.log('File', file, stats)
    }
    if (stats.isFile() && !this.settings.files) {
      if(this.settings.logging){
          console.log('file not allowed')
      }
      return true
    }
    if (stats.isDirectory() && !this.settings.directories) {
        if(this.settings.logging){
            console.log('directory not allowed')
        }
      return true
    }
    if (stats.mtimeMs < this.settings.newerThan) {
        if(this.settings.logging){
            console.log('file modify date too new')
        }
      return true
    }

    if(this.settings.logging) {
      console.log('file not excluded')
    }
    return false
  }
}

class NodeRecentlyModified {
  static builder () {
    return new Builder()
  }
}

module.exports = NodeRecentlyModified