Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kentnl/dist-zilla-role-version-sanitize

Sanitize a version from a plugin
https://github.com/kentnl/dist-zilla-role-version-sanitize

dist-zilla perl

Last synced: 18 days ago
JSON representation

Sanitize a version from a plugin

Awesome Lists containing this project

README

        

# NAME

Dist::Zilla::Role::Version::Sanitize - Sanitize a version from a plugin

# VERSION

version 0.002004

# ATTRIBUTES

## `normal_form`

Determines which [_normal form_](#normal-forms) is used.

Default is : **`numify`**

## `mantissa`

Determines the mandatory length of the `mantissa` for the [`numify`](#numify) normal form.

Default is : **`6`**

Which yields:

1.001001
10.001001
100.001001
1000.001001

Etc.

# NORMAL FORMS

## `normal`

Normalizes to the notation:

v1
v1.2
v1.2.3
v1.2.3.4

## `normal_3`

Normalizes to the notation

1.2.3
1.2.3.4

Note: Due to the absence of the leading `v`, 3, is the minimum number of places that can be represented in this notation.

Accidentally normalizing to

1.2

In this form should raise a fatal exception.

## `numify`

Normalizes to the notation

1.23456789
| ^------^--- The Mantissa
|
^------------ Integer part.

And the length for mantissa is forced by `mantissa`, either _truncating_ to `mantissa` length, or `paddding` to `mantissa` length with `0`'s

# AUTHOR

Kent Fredric

# COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Kent Fredric .

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.