Skip to content

Commit

Permalink
Change details in CHANGELOG.md, README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rougin committed Sep 30, 2024
1 parent 89cfe25 commit cfcc618
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 18 deletions.
10 changes: 6 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ All notable changes to `Blueprint` will be documented in this file.
## [0.7.0](https://github.com/rougin/blueprint/compare/v0.6.0...v0.7.0) - Unreleased

> [!WARNING]
> This release will introduce a backward compatability break if upgrading from `v0.6.0` release. This is only applicable if the `Blueprint` package was extended.
> This release will introduce a backward compatability break if upgrading from `v0.6.0` release.
> This is only applicable to packages that were extended to the `Blueprint` package.
### Added
- `Command` class for an alternative way of creating commands

### Changed
- Code documentation by `php-cs-fixer`, code quality by `phpstan`
- Workflow from `Travis CI` to `Github Actions`
- Code coverage from `Scrutinizer CI` to `Codecov`
- Code coverage to `Codecov`
- Code documentation by `php-cs-fixer`
- Improved code quality by `phpstan`
- Simplified code structure
- Workflow to `Github Actions`

### Removed
- `Application` class
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,13 @@ To initialize a console application, the `Blueprint` class must be created first
use Rougin\Blueprint\Blueprint;
// Return the root directory of the project ------------
$vendor = (string) __DIR__ . '/../../../../';
// Return the root directory of the project ----------
$root = (string) __DIR__ . '/../../../../';
$exists = file_exists($vendor . '/vendor/autoload.php');
$exists = file_exists($root . '/vendor/autoload.php');
$root = $exists ? $vendor : __DIR__ . '/../';
// -----------------------------------------------------
$root = $exists ? $root : __DIR__ . '/../';
// ---------------------------------------------------
require $root . '/vendor/autoload.php';
Expand Down
10 changes: 5 additions & 5 deletions bin/blueprint
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

use Rougin\Blueprint\Console;

// Return the root directory of the project ------------
$vendor = (string) __DIR__ . '/../../../../';
// Return the root directory of the project ----------
$root = (string) __DIR__ . '/../../../../';

$exists = file_exists($vendor . '/vendor/autoload.php');
$exists = file_exists($root . '/vendor/autoload.php');

$root = $exists ? $vendor : __DIR__ . '/../';
// -----------------------------------------------------
$root = $exists ? $root : __DIR__ . '/../';
// ---------------------------------------------------

// Load the Composer autoloader -------
require $root . '/vendor/autoload.php';
Expand Down
4 changes: 0 additions & 4 deletions src/Commands/InitializeCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,6 @@ public function init()
$text = 'Create a "' . $this->file . '" file';

$this->description = $text;

$text = 'Create a new "' . $this->file . '" file in the current directory.';

$this->help = (string) $text;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions tests/Fixture/Commands/GreetCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ class GreetCommand extends Command
*/
protected $aliases = array('wave');

/**
* @var string
*/
protected $help = 'Perform a greeting to a specified person.';

/**
* @var string
*/
Expand Down

0 comments on commit cfcc618

Please sign in to comment.