configLoader

A module to load configuration for the semverist.

configLoader

semveristSuper

A module to load configuration for the semverist.

semveristSuper

module:configLoader

Initializes the manifest class.

module:configLoader(configNameSpace: string, configs: semveristBehaviors)
Parameters
configNameSpace (string) A namespace in configuration to draw configuration from for this manifest.
configs (semveristBehaviors) A configurtion override object. semveristBehaviors

semveristBehaviors

The semverist Behavior object. A part of semverist configuration which if provided from the config module should be namespaced to 'semverist'.

semveristBehaviors

Type: Object

Parameters
configNameSpace (any)
configs (any)
Properties
inheritence (boolean?) : (null|semverImplied|lasySemverist) Enables inheritence for the semverist object composer. Can be 1) null, or no inheritence, 2) semverImplied the default in which Parent semverist elements are inherited to their child leaves unless they are overridden by another instance of the same semverist element. Inheritence does not cross over from parent to its siblings or 3) lazySemverist which Affects inheritence by treating the the highest semver occurence of a semverist element (elements indicated below), as the element to inherit from for all future parent and children leaves until specifically overriden by another instance of the same semverist element. Adjacent higher siblings in the semverist object can inherit elements from a previous sibling or its children.
lazySemverist (Object?) : Configuration for lazySemverist behavior. This is only in effect if the inheritence is lazySemverist.
  • lazySemverist.preReleaseForwards boolean?

    If true allows lazy semverist enabled semverist elements to carry forward from prereleases.

  • lazySemverist.attributes boolean?

    Applies lazySemverist inheritence to the semverist element, attributes. Currently this is the only kind of lazySemverist though we plan to add groups and defaults as well.

default (boolean?) : Enables default semverist elements to influence semverist composer inheritence and merge strategies.
defaultName (string?) : An override name for defaults.Semverist elements with this name will be utilized as defaults.
groups (boolean?) : Enables group semverist elements to influence semverist composer inheritence and merge strategies.
mergeStrategy (string?) : Sets the mergeStrategy for use with semverist composer realizations of semverist element attributes.
preReleasePattern (RegExp?) : A regex pattern to use to match your prerelease naming and versioning. Please note that any item that the bounds of your prerelease pattern could create conflicts with your semverist attribute names. Please be sure to tightly cordon off your patterns.

configLoader

sourceConverter factory.

configLoader(superNameSpace: any, pluginName: any)
Parameters
superNameSpace (any)
pluginName (any)

createConverter

Static converter creator to supply manifest class with its converter object and class.

createConverter(converterSource: SemveristObject): Promise.Array
Parameters
converterSource (SemveristObject) -
Returns
Promise.Array: converterPromise - An array of converter object and the converter class. Which returns the appropriate object or directory version of a converter.

getManifestConfig

Gets the config for the manifest created during the factory based on the config namespace.

getManifestConfig(): Object
Returns
Object: configuration for the semverist.

composer

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

composer(superclass: any)
Parameters
superclass (any)

pathBuildImprovement

Revises the path to handle any special cases. Can be a place for super overrides to modify the path for special prereleases and the like.

pathBuildImprovement(parsedPath: Object): string
Parameters
parsedPath (Object) A semver utils parsed path.
Returns
string: A valid object path.

pathBuildImprovement

Revises the path to handle any special cases. Can be a place for super overrides to modify the path for special prereleases and the like.

pathBuildImprovement(parsedPath: Object): string
Parameters
parsedPath (Object) A semver utils parsed path.
Returns
string: A valid object path.

defaultManifestComponents

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

defaultManifestComponents(superclass: any)
Parameters
superclass (any)

defaultPriority

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

defaultPriority(superclass: any)
Parameters
superclass (any)

directoryWriter

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

directoryWriter(superclass: any)
Parameters
superclass (any)

groupManifestComponents

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

groupManifestComponents(superclass: any)
Parameters
superclass (any)

inspector

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

inspector(superclass: any)
Parameters
superclass (any)

mergeStrategy

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

mergeStrategy(superclass: any)
Parameters
superclass (any)

objectWriter

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

objectWriter(superclass: any)
Parameters
superclass (any)

directoryToSemverishObject

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

directoryToSemverishObject(superclass: any)
Parameters
superclass (any)

parseSemverUtils

This is a semverist plugin for semver parsing. It is self-contained. Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

parseSemverUtils(superclass: any)
Parameters
superclass (any)

semverAdjacent

This is a semverist plugin for analyzing the adjacency of two semver. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

semverAdjacent(superclass: any)
Parameters
superclass (any)

semverishElement

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

semverishElement(superclass: any)
Parameters
superclass (any)

semverishLevel

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

semverishLevel(superclass: any)
Parameters
superclass (any)

semverishValue

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

semverishValue(superclass: any)
Parameters
superclass (any)

semveristElementType

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

semveristElementType(superclass: any)
Parameters
superclass (any)

sortRangeArray

This is a semverist plugin for sorting ranges. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

sortRangeArray(superclass: any)
Parameters
superclass (any)

toCaretRange

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

toCaretRange(superclass: any)
Parameters
superclass (any)

toTildeRange

This is a semverist plugin for set/geting the semverist element. It is self-contained.

Mixins follow the formula for mixins described at: http://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/ More info in the README.

toTildeRange(superclass: any)
Parameters
superclass (any)

validateRange

Validate a range string.

validateRange(rangeString: string)
Parameters
rangeString (string) A semver range string.
Throws
  • any: Throws an error If the passed range is not valid.

rangeMaker

A range making utility function.

rangeMaker(firstValue: sting, firstOperator: string, secondValue: string, secondOperator: string, exception: any): string
Parameters
firstValue (sting) a semverish value.
firstOperator (string) a semver range operator string.
secondValue (string) a semverish value.
secondOperator (string) a semver range operator string.
exception (any)
Returns
string: a valid semver range string.

module:semveristSuper

A super class for semverish instances like semverish, range and converter.

module:semveristSuper

getSemverLevels

Returns an array of semver parts in order of their occurence.

getSemverLevels(): Array
Returns
Array: An array of semver parts in order.