Permalink
Browse files

update dist.ini and support files

  • Loading branch information...
xdg committed Sep 10, 2013
1 parent ea2d702 commit 6ce8fa31b73495ef08828f46f6cbcd8d568d2a24
Showing with 112 additions and 217 deletions.
  1. +1 −0 .local.vimrc
  2. +44 −0 .perltidyrc
  3. +34 −14 CONTRIBUTING
  4. +0 −88 META.json
  5. +1 −0 README.mkdn
  6. +0 −112 README.pod
  7. +26 −0 cpanfile
  8. +6 −3 dist.ini
View
@@ -0,0 +1 @@
+autocmd BufWritePre *.pl,*.pm,*.t call DoTidyWrite()
View
@@ -0,0 +1,44 @@
+# DAGOLDEN .perltidyrc file
+
+-st # Output to STDOUT
+-se # Errors to STDERR
+
+-l=85 # Max line width target
+-vmll # variable maximum line length
+-wc=10 # depth to reduce indentation levels
+-i=4 # Indent level
+-ci=2 # Continuation
+
+-vt=0 # vertical tightness
+-cti=0 # extra indentation for closing brackets
+-vtc=0 # close parens on own line if possible
+
+-nsot # stack opening
+-nsct # stack closing
+
+-notr # opening tokens on right of a line
+-pt=1 # parenthesis tightness
+-bt=1 # brace tightness
+-sbt=1 # square bracket tightness
+-bbt=0 # block brace tightness
+#-boc # break at old comma breakpoints
+-cab=1
+
+-nsfp # no space after function
+-nsfs # No space before semicolons in for loops
+
+-nolq # Don't outdent long quoted strings
+-nola # Don't outdent labels
+-nolc # Don't outdent long comments
+-nokw # Don't outdent keywords
+-nhsc # Don't expect hanging side comments
+-nbbc # No blank before comments
+-tso # Tight secret operators
+
+-msc=1 # Space to side comment
+
+#-wbb="% + - * / x != == >= <= =~ !~ < > | & = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x="
+-wbb="% + - * / x != == >= <= =~ !~ < > | &"
+ # Break before all operators except assignment
+
+-ole=unix # line endings
View
@@ -1,4 +1,4 @@
-README.PATCHING
+## HOW TO CONTRIBUTE
Thank you for considering contributing to this distribution. This file
contains instructions that will help you work with the source code.
@@ -7,36 +7,56 @@ The distribution is managed with Dist::Zilla. This means than many of the
usual files you might expect are not in the repository, but are generated
at release time (e.g. Makefile.PL).
-However, you can run tests directly using the 'prove' tool:
+### Getting dependencies
- $ prove -l
- $ prove -lv t/some_test_file.t
+See the included `cpanfile` file for a list of dependencies. If you have
+App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
+dependencies like this:
-For most distributions, 'prove' is entirely sufficent for you to test any
+ $ cpanm --installdeps .
+
+Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
+dependencies with the regular `cpan` client and `cpanfile-dump`:
+
+ $ cpan `cpanfile-dump`
+
+### Running tests
+
+You can run tests directly using the `prove` tool:
+
+ $ prove -l
+ $ prove -lv t/some_test_file.t
+
+For most distributions, `prove` is entirely sufficent for you to test any
patches you have.
+### Patching documentation
+
Likewise, much of the documentation Pod is generated at release time.
Depending on the distribution, some documentation may be written in a Pod
-dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
-submit a documentation edit, please limit yourself to the documentation you
-see.
+dialect called WikiDoc. (See Pod::WikiDoc on CPAN.)
+
+If you would like to submit a documentation edit, please limit yourself to the
+documentation you see.
If you see typos or documentation issues in the generated docs, please
email or open a bug ticket instead of patching.
+### Learning Dist::Zilla
+
Dist::Zilla is a very powerful authoring tool, but requires a number of
author-specific plugins. If you would like to use it for contributing,
install it from CPAN, then run one of the following commands, depending on
your CPAN client:
- $ cpan `dzil authordeps`
- $ dzil authordeps | cpanm
+ $ cpan `dzil authordeps`
+ $ dzil authordeps | cpanm
Once installed, here are some dzil commands you might try:
- $ dzil build
- $ dzil test
- $ dzil xtest
-
+ $ dzil build
+ $ dzil test
+ $ dzil xtest
+
You can learn more about Dist::Zilla at http://dzil.org/
View
@@ -1,88 +0,0 @@
-{
- "abstract" : "Map Perl operating system names to generic types",
- "author" : [
- "David Golden <dagolden@cpan.org>"
- ],
- "dynamic_config" : 0,
- "generated_by" : "Dist::Zilla version 4.300035, CPAN::Meta::Converter version 2.132140",
- "license" : [
- "perl_5"
- ],
- "meta-spec" : {
- "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
- "version" : "2"
- },
- "name" : "Perl-OSType",
- "no_index" : {
- "directory" : [
- "t",
- "xt",
- "examples",
- "corpus"
- ],
- "package" : [
- "DB"
- ]
- },
- "prereqs" : {
- "configure" : {
- "requires" : {
- "ExtUtils::MakeMaker" : "6.30"
- }
- },
- "develop" : {
- "requires" : {
- "Pod::Coverage::TrustPod" : "0",
- "Test::CPAN::Meta" : "0",
- "Test::Pod" : "1.41",
- "Test::Pod::Coverage" : "1.08"
- }
- },
- "runtime" : {
- "requires" : {
- "Exporter" : "0",
- "perl" : "5.006",
- "strict" : "0",
- "warnings" : "0"
- }
- },
- "test" : {
- "requires" : {
- "Capture::Tiny" : "0",
- "ExtUtils::MakeMaker" : "0",
- "File::Spec::Functions" : "0",
- "File::Temp" : "0",
- "List::Util" : "0",
- "Test::More" : "0.88",
- "blib" : "0",
- "constant" : "0"
- }
- }
- },
- "provides" : {
- "Perl::OSType" : {
- "file" : "lib/Perl/OSType.pm",
- "version" : "1.004"
- }
- },
- "release_status" : "stable",
- "resources" : {
- "bugtracker" : {
- "web" : "https://github.com/dagolden/perl-ostype/issues"
- },
- "homepage" : "https://metacpan.org/release/Perl-OSType",
- "repository" : {
- "type" : "git",
- "url" : "git://github.com/dagolden/perl-ostype.git",
- "web" : "https://github.com/dagolden/perl-ostype"
- }
- },
- "version" : "1.004",
- "x_authority" : "cpan:DAGOLDEN",
- "x_contributors" : [
- "Jonas B. Nielsen <jonasbn@hoarfrost.local>",
- "Owain G. Ainsworth <oga@nicotinebsd.org>",
- "Paul Green <Paul.Green@stratus.com>"
- ]
-}
-
View
View
@@ -1,112 +0,0 @@
-=pod
-
-=encoding utf-8
-
-=head1 NAME
-
-Perl::OSType - Map Perl operating system names to generic types
-
-=head1 VERSION
-
-version 1.004
-
-=head1 SYNOPSIS
-
- use Perl::OSType ':all';
-
- $current_type = os_type();
- $other_type = os_type('dragonfly'); # gives 'Unix'
-
-=head1 DESCRIPTION
-
-Modules that provide OS-specific behaviors often need to know if
-the current operating system matches a more generic type of
-operating systems. For example, 'linux' is a type of 'Unix' operating system
-and so is 'freebsd'.
-
-This module provides a mapping between an operating system name as given by
-C<$^O> and a more generic type. The initial version is based on the OS type
-mappings provided in L<Module::Build> and L<ExtUtils::CBuilder>. (Thus,
-Microsoft operating systems are given the type 'Windows' rather than 'Win32'.)
-
-=head1 USAGE
-
-No functions are exported by default. The export tag ":all" will export
-all functions listed below.
-
-=head2 os_type()
-
- $os_type = os_type();
- $os_type = os_type('MSWin32');
-
-Returns a single, generic OS type for a given operating system name. With no
-arguments, returns the OS type for the current value of C<$^O>. If the
-operating system is not recognized, the function will return the empty string.
-
-=head2 is_os_type()
-
- $is_windows = is_os_type('Windows');
- $is_unix = is_os_type('Unix', 'dragonfly');
-
-Given an OS type and OS name, returns true or false if the OS name is of the
-given type. As with C<os_type>, it will use the current operating system as a
-default if no OS name is provided.
-
-=head1 SEE ALSO
-
-=over 4
-
-=item *
-
-L<Devel::CheckOS>
-
-=back
-
-=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
-
-=head1 SUPPORT
-
-=head2 Bugs / Feature Requests
-
-Please report any bugs or feature requests through the issue tracker
-at L<https://github.com/dagolden/perl-ostype/issues>.
-You will be notified automatically of any progress on your issue.
-
-=head2 Source Code
-
-This is open source software. The code repository is available for
-public review and contribution under the terms of the license.
-
-L<https://github.com/dagolden/perl-ostype>
-
- git clone git://github.com/dagolden/perl-ostype.git
-
-=head1 AUTHOR
-
-David Golden <dagolden@cpan.org>
-
-=head1 CONTRIBUTORS
-
-=over 4
-
-=item *
-
-Jonas B. Nielsen <jonasbn@hoarfrost.local>
-
-=item *
-
-Owain G. Ainsworth <oga@nicotinebsd.org>
-
-=item *
-
-Paul Green <Paul.Green@stratus.com>
-
-=back
-
-=head1 COPYRIGHT AND LICENSE
-
-This software is copyright (c) 2013 by David Golden.
-
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
-
View
@@ -0,0 +1,26 @@
+requires "Exporter" => "0";
+requires "perl" => "5.006";
+requires "strict" => "0";
+requires "warnings" => "0";
+
+on 'test' => sub {
+ requires "ExtUtils::MakeMaker" => "0";
+ requires "File::Spec::Functions" => "0";
+ requires "File::Temp" => "0";
+ requires "IO::Handle" => "0";
+ requires "IPC::Open3" => "0";
+ requires "List::Util" => "0";
+ requires "Test::More" => "0.88";
+ requires "constant" => "0";
+};
+
+on 'configure' => sub {
+ requires "ExtUtils::MakeMaker" => "6.30";
+};
+
+on 'develop' => sub {
+ requires "Pod::Coverage::TrustPod" => "0";
+ requires "Test::CPAN::Meta" => "0";
+ requires "Test::Pod" => "1.41";
+ requires "Test::Pod::Coverage" => "1.08";
+};
View
@@ -4,8 +4,11 @@ license = Perl_5
copyright_holder = David Golden
[@DAGOLDEN]
-:version = 0.035
-AutoMetaResources.bugtracker.rt = 0
-AutoMetaResources.bugtracker.github = user:dagolden
+:version = 0.053
stopwords = freebsd
stopwords = linux
+
+[OnlyCorePrereqs]
+:version = 0.003
+starting_version = current
+phase = test

0 comments on commit 6ce8fa3

Please sign in to comment.