From f07ebb12e6a8e785e0058f3536684e7005f6c4b6 Mon Sep 17 00:00:00 2001 From: Bernhard Schussek Date: Mon, 12 Jan 2015 17:55:00 +0100 Subject: [PATCH] Released version "1.0.0-beta" --- README.md | 6 +- composer.json | 2 +- docs/Makefile | 2 +- docs/man/puli-ls.1 | 60 ++++++++++++++++++ docs/man/puli-package.1 | 48 +++++++++++++++ docs/man/puli.1 | 123 +++++++++++++++++++++++++++++++++++++ docs/puli-dump.txt | 19 ------ src/PuliCliApplication.php | 4 +- 8 files changed, 238 insertions(+), 26 deletions(-) create mode 100644 docs/man/puli-ls.1 create mode 100644 docs/man/puli-package.1 create mode 100644 docs/man/puli.1 delete mode 100644 docs/puli-dump.txt diff --git a/README.md b/README.md index 52eef70..8ff8f22 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ The Puli Command Line Interface =============================== -[![Build Status](https://travis-ci.org/puli/cli.svg?branch=master)](https://travis-ci.org/puli/cli) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/puli/cli/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/puli/cli/?branch=master) +[![Build Status](https://travis-ci.org/puli/cli.svg?branch=1.0.0-beta)](https://travis-ci.org/puli/cli) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/puli/cli/badges/quality-score.png?b=1.0.0-beta)](https://scrutinizer-ci.com/g/puli/cli/?branch=1.0.0-beta) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/96bbb04c-f5c3-47c2-8e43-1f92d26f7c3a/mini.png)](https://insight.sensiolabs.com/projects/96bbb04c-f5c3-47c2-8e43-1f92d26f7c3a) [![Latest Stable Version](https://poser.pugx.org/puli/cli/v/stable.svg)](https://packagist.org/packages/puli/cli) [![Total Downloads](https://poser.pugx.org/puli/cli/downloads.svg)](https://packagist.org/packages/puli/cli) [![Dependency Status](https://www.versioneye.com/php/puli:cli/1.0.0/badge.svg)](https://www.versioneye.com/php/puli:cli/1.0.0) -Latest release: [1.0.0-alpha1](https://packagist.org/packages/puli/cli#1.0.0-alpha1) +Latest release: [1.0.0-beta](https://packagist.org/packages/puli/cli#1.0.0-beta) PHP >= 5.3.9 diff --git a/composer.json b/composer.json index bd934ab..c29288c 100644 --- a/composer.json +++ b/composer.json @@ -22,7 +22,7 @@ "require-dev": { "symfony/filesystem": "~2.3" }, - "minimum-stability": "dev", + "minimum-stability": "beta", "autoload": { "psr-4": { "Puli\\Cli\\": "src/", diff --git a/docs/Makefile b/docs/Makefile index d0e60fb..c18d45a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,4 +1,4 @@ -PULI_VERSION = "@package_version@" +PULI_VERSION = "1.0.0-beta" BUILD_HTML_DIR = html BUILD_MAN_DIR = man diff --git a/docs/man/puli-ls.1 b/docs/man/puli-ls.1 new file mode 100644 index 0000000..c53fbae --- /dev/null +++ b/docs/man/puli-ls.1 @@ -0,0 +1,60 @@ +'\" t +.\" Title: puli-ls +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 01/12/2015 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "PULI\-LS" "1" "01/12/2015" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +puli-ls \- List the entries of a directory in the resource repository\&. +.SH "SYNOPSIS" +.sp +.nf +\fIpuli ls\fR [\-\-recursive] [] +.fi +.SH "DESCRIPTION" +.sp +This command lists the entries of a directory in the Puli repository\&. +.SH "ARGUMENTS" +.PP + +.RS 4 +The directory to list\&. If no directory is passed, the directory "/" is assumed\&. +.RE +.SH "OPTIONS" +.PP +\-\-recursive, \-R +.RS 4 +Recursively display all entries of the directory and its subdirectories\&. +.RE +.SH "AUTHOR" +.sp +Written by Bernhard Schussek <\m[blue]\fBbschussek@gmail\&.com\fR\m[]\&\s-2\u[1]\d\s+2> +.SH "NOTES" +.IP " 1." 4 +bschussek@gmail.com +.RS 4 +\%mailto:bschussek@gmail.com +.RE diff --git a/docs/man/puli-package.1 b/docs/man/puli-package.1 new file mode 100644 index 0000000..23967fa --- /dev/null +++ b/docs/man/puli-package.1 @@ -0,0 +1,48 @@ +'\" t +.\" Title: puli-package +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 01/12/2015 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "PULI\-PACKAGE" "1" "01/12/2015" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +puli-package \- List installed packages +.SH "SYNOPSIS" +.sp +.nf +\fIpuli package\fR +.fi +.SH "DESCRIPTION" +.sp +This command lists all installed packages\&. +.SH "AUTHOR" +.sp +Written by Bernhard Schussek <\m[blue]\fBbschussek@gmail\&.com\fR\m[]\&\s-2\u[1]\d\s+2> +.SH "NOTES" +.IP " 1." 4 +bschussek@gmail.com +.RS 4 +\%mailto:bschussek@gmail.com +.RE diff --git a/docs/man/puli.1 b/docs/man/puli.1 new file mode 100644 index 0000000..999aff8 --- /dev/null +++ b/docs/man/puli.1 @@ -0,0 +1,123 @@ +'\" t +.\" Title: puli +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 01/12/2015 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "PULI" "1" "01/12/2015" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +puli \- PHP\*(Aqs powerful resource manager +.SH "SYNOPSIS" +.sp +.nf +\fIpuli\fR [\-\-help] [\-\-quiet] [\-\-verbose] [\-\-version] [\-\-ansi] + [\-\-no\-ansi] [\-\-no\-interaction] + [] [] \&... [] +.fi +.SH "DESCRIPTION" +.sp +Puli is a PHP library that manages files, directories and other resources in a repository \- much like a virtual file system\&. \fIResources\fR can be anything, but usually we use the term for machine\-processed files that are not PHP, such as CSS, JavaScript, XLIFF, YAML, XML or HTML files\&. +.SH "ARGUMENTS" +.PP + +.RS 4 +The name of the command to execute\&. The list of commands is displayed in the output of +\fBpuli\fR\&. +.RE +.PP + +.RS 4 +Some Puli commands have sub\-commands\&. Pass the name of a sub\-command in this argument\&. You can list the commands and their sub\-commands with +\fBpuli \-a\fR\&. +.RE +.PP + +.RS 4 +The arguments of the command\&. Run +\fBpuli \-h\fR +to learn more about the arguments supported by a command\&. +.RE +.SH "OPTIONS" +.PP +\-\-help, \-h +.RS 4 +Print the synopsis and a list of the most commonly used commands\&. +.RE +.PP +\-\-quiet, \-q +.RS 4 +Mute all output of the command\&. +.RE +.PP +\-\-verbose, \-v, \-vv, \-vvv +.RS 4 +Enable verbose output of the command\&. You can enable three levels of verbosity\&. The option +\fI\-v\fR +enables slightly verbose, +\fI\-vv\fR +more verbose and +\fI\-vvv\fR +very verbose output\&. +.RE +.PP +\-\-version, \-V +.RS 4 +Print the version of Puli\&. +.RE +.PP +\-\-ansi +.RS 4 +Enable colorization of the output\&. If the terminal supports colorization, the output will be colorized by default\&. +.RE +.PP +\-\-no\-ansi +.RS 4 +Disable output colorization\&. This is useful if you want to process the output of a command in a script\&. +.RE +.PP +\-\-no\-interaction, \-n +.RS 4 +Disable all dialogs and assumes the suggested answers\&. This is useful for running a command in a script\&. +.RE +.SH "LICENSE" +.sp +The MIT License (MIT) +.sp +Copyright (c) 2014 Bernhard Schussek +.sp +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +.sp +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. +.sp +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. +.SH "AUTHOR" +.sp +Written by Bernhard Schussek <\m[blue]\fBbschussek@gmail\&.com\fR\m[]\&\s-2\u[1]\d\s+2> +.SH "NOTES" +.IP " 1." 4 +bschussek@gmail.com +.RS 4 +\%mailto:bschussek@gmail.com +.RE diff --git a/docs/puli-dump.txt b/docs/puli-dump.txt deleted file mode 100644 index 506184e..0000000 --- a/docs/puli-dump.txt +++ /dev/null @@ -1,19 +0,0 @@ -puli-dump(1) -============ - -NAME ----- -puli-dump - Dump the resource repository - -SYNOPSIS --------- -[verse] -'puli dump' - -DESCRIPTION ------------ -This command dumps the resource repository to a file. - -AUTHOR ------- -Written by Bernhard Schussek diff --git a/src/PuliCliApplication.php b/src/PuliCliApplication.php index d9218f3..da6123e 100644 --- a/src/PuliCliApplication.php +++ b/src/PuliCliApplication.php @@ -34,9 +34,9 @@ */ class PuliCliApplication extends Application { - const VERSION = '@package_version@'; + const VERSION = '1.0.0-beta'; - const RELEASE_DATE = '@release_date@'; + const RELEASE_DATE = '2015-01-12'; public function __construct() {