Plato - lib/rtk.js

"use strict"
import async from 'async';
import rtkReleaseScheme from './release-schemes/rtk.js';
import jsonResourceType from './resource-types/json.js';
import keepAChangelogResourceType from './resource-types/keep-a-changelog.js';
import makefileResourceType from './resource-types/makefile.js';
import textResourceType from './resource-types/text.js';
import tomlResourceType from './resource-types/toml.js';
import yamlResourceType from './resource-types/yaml.js';

/**
 * RTK is the enchilada, Release The Kraken!
 */
class RTK {

/**
   * Construct RTK object which will manage a set of resources.
   *
   * @param {Array} resources: an array of resources which contain version value
   * @param {Object} opts: optional settings
   *   - dryRun: when true, no change will be made
   */
  constructor(resources, opts) {
    this.resources = resources || {};
    this.opts = opts || {};
    this.releaseSchemes = {
      rtk: rtkReleaseScheme
    };
    this.resourceTypes = {
      json: jsonResourceType,
      makefile: makefileResourceType,
      text: textResourceType,
      toml: tomlResourceType,
      yaml: yamlResourceType
    };
    this.resourceTypes['keep-a-changelog'] = keepAChangelogResourceType;
  }

/**
   * Execute release steps for the specified release scheme.
   *
   * @param {String} releaseSchemeName: release scheme name that defines the steps involved in a release step
   * @param {String} versionSchemeName: version scheme name that defines the release and pre-release version value
   * @param {String} scmSchemeName: name of SCM used by the repository to be released
   * @param {Function} cb: standard cb(err, result) callback
   */
  release(releaseSchemeName, versionSchemeName, scmSchemeName, cb) {
    const self = this;

releaseSchemeName = releaseSchemeName || 'rtk';
    versionSchemeName = versionSchemeName || 'semver';
    scmSchemeName = scmSchemeName || 'git';

let releaseScheme;

function versionTask(cb) {
      // uses first resource as the source of truth and the correct pre-release version
      const preReleaseResource = self.resources[0];

async.series([versionTask, preTask, releaseTask, postTask], cb);
  }

}

export {
  RTK as default
};

lib/rtk.js

Maintainability

Lines of code

Difficulty

Estimated Errors

Function weight

By Complexity

By SLOC