Skip to content

Validate init global project options #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2015
Merged

Validate init global project options #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a674c39
Add options (project & global) notes
jmolivas Aug 5, 2015
64435f0
Add options (project & global) validation
jmolivas Aug 5, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ $ ln -s /path/to/phpqa/bin/phpqa /usr/local/bin/phpqa
### Copy configuration file(s)
```
$ cd to/project/path
$ phpqa init --project=PROJECT --global --override
$ phpqa init --project=PROJECT --override
$ phpqa init --global --override
```
| Option | Description |
| -------- | ----------------------------- |
Expand All @@ -101,6 +102,7 @@ $ phpqa init --project=PROJECT --global --override
**NOTES:**
- Option `global` does not accept a value must be set as `--global`.
- Option `override` does not accept a value must be set as `--override`.
- Options `project` and `global` can not used in combination.

### Analyze a project
```
Expand All @@ -117,8 +119,8 @@ $ phpqa analyze --project=PROJECT --git

**NOTES:**
- Option `git` does not accept a value must be set as `--git`.
- Options `files` and `git` can not used in combination.
- Option `project` could be omitted if a `phpqa.yml` or `phpqa.yml.dist` file is available at current working directory.
- Options `files` and `git` can not used in combination.

## Override configuration
This project was built to be fully customizable and you can enable/disable analyzers and modify arguments/options passed to analyzers by updating the `phpqa.yml` or `phpqa.yml.dist` file on your project root copied when running init command, or the files `~/.phpqa/php/config.yml`, `~/.phpqa/symfony/config.yml` or `~/.phpqa/drupal/config.yml` copied when running `init` command using `--global` option.
Expand Down
6 changes: 5 additions & 1 deletion src/Command/InitCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,11 @@ protected function execute(InputInterface $input, OutputInterface $output)

$project = $input->getOption('project');

if (!$project || !in_array($project, $this->projects)) {
if ($global && $project) {
throw new \Exception('Options `project` and `global` can not used in combination.');
}

if (!$global && (!$project || !in_array($project, $this->projects))) {
throw new \Exception(
sprintf(
'You must provide a valid project value (%s)',
Expand Down