log-ocd/act/year.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * ACT TASK: year
 * -----------------------------------------------------------------------------
 * @file Use `$ act year` to access this file.
 * @version 1.0.0-beta.11
 *
 * @author Adam Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 * @copyright 2022 Adam A Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 *
 * @see [JSDoc3](http://usejsdoc.org)
 * @see [Closure Compiler JSDoc](https://developers.google.com/closure/compiler/docs/js-for-compiler)
 */

'use strict';

////////////////////////////////////////////////////////////
// EXPORTS
////////////////////////////////////////////////////////////

exports['desc'] = 'updates year in entire repo';
exports['value'] = '2xxx';
exports['method'] = updateYear;

////////////////////////////////////////////////////////////
// HELPERS
////////////////////////////////////////////////////////////

var vitals = require('node-vitals')('base', 'fs');
var each   = vitals.each;
var fuse   = vitals.fuse;
var get    = vitals.get;
var has    = vitals.has;
var remap  = vitals.remap;
var to     = vitals.to;

var path = require('path');
var resolve = path.resolve;

////////////////////////////////////////////////////////////
// CONSTANTS
////////////////////////////////////////////////////////////

var ROOT = resolve(__dirname, '..');

var CPRT = /(copyright )2[0-9]{3}/ig;
var YEAR = /^2[0-9]{3}$/;

////////////////////////////////////////////////////////////
// PUBLIC METHODS
////////////////////////////////////////////////////////////

/**
 * @public
 * @param {string} year
 */
function updateYear(year) {

  /** @type {!Array<string>} */
  var filepaths;

  if ( !isYear(year) ) throw new Error('invalid `year` - should be `2xxx`');

  filepaths = get.filepaths('.', {
    basepath:    true,
    recursive:   true,
    validExts:   'js|md',
    invalidExts: 'json',
    invalidDirs: '.*|node_modules|tmp'
  });
  insertYears(filepaths, year);
}

////////////////////////////////////////////////////////////
// PRIVATE METHODS
////////////////////////////////////////////////////////////

/**
 * @private
 * @param {string} year
 * @return {boolean}
 */
function isYear(year) {
  return !!year && has(year, YEAR);
}

/**
 * @private
 * @param {!Array<string>} filepaths
 * @param {string} year
 */
function insertYears(filepaths, year) {
  year = fuse('$1', year);
  each(filepaths, function(filepath) {
    insertYear(filepath, year);
  });
}

/**
 * @private
 * @param {string} filepath
 * @param {string} year
 */
function insertYear(filepath, year) {

  /** @type {string} */
  var content;

  content = get.file(filepath);
  content = remap(content, CPRT, year);
  to.file(content, filepath);
}