Skip to content
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.

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

Add psalm #510

Merged
merged 13 commits into from
Jul 27, 2018
Merged

Add psalm #510

merged 13 commits into from
Jul 27, 2018

Conversation

vesquen
Copy link
Contributor

@vesquen vesquen commented May 25, 2018

Q A
Branch master for features and deprecations
Bug fix? no
New feature? yes
BC breaks? no
Deprecations? no
Documented? yes
Fixed tickets comma-separated list of tickets fixed by the PR, if any

It adds a task for Psalm

New Task Checklist:

  • Is the README.md file updated?
  • Are the dependencies added to the composer.json suggestions?
  • Is the doc/tasks.md file updated?
  • Are the task parameters documented?
  • Is the task registered in the tasks.yml file?
  • Does the task contains phpspec tests?
  • Is the configuration having logical allowed types?
  • Does the task run in the correct context?
  • Is the run() method readable?
  • Is the run() method using the configuration correctly?
  • Are all CI services returning green?

@vesquen vesquen changed the title Feature/vimeo psalm Add psalm May 25, 2018
@veewee veewee added this to the Version 0.14.2 milestone May 25, 2018
Copy link
Contributor

@veewee veewee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @vesquen,

Thanks for your work on this task! I've added a couple of small remarks to the codebase.
You also need to link the task in doc/tasks.md, otherwise the documentation won't be found by the users.

'ignore_patterns' => [],
'no_cache' => false,
'report' => null,
'threads' => 1,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is better to set this to null and let psalm decide what it uses by default?

ignore_patterns: []
no_cache: false
report: ~
threads: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The threads options is not described in the documentation

$arguments->addOptionalArgument('--report=%s', $config['report']);
$arguments->addOptionalArgument('--no-cache', $config['no_cache']);
$arguments->addOptionalArgument('--threads=%d', $config['threads']);
$arguments->addFiles($files);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During run, the file list might get very big. Would it make sense to only add the files during pre-commit context and run on all files during run context?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That does make sense, will fix!

@janvernieuwe
Copy link
Collaborator

Thanks for adding the docs, we'll merge it in with the next milestone release!

Copy link
Contributor

@Landerstraeten Landerstraeten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vesquen Thanks!

@Landerstraeten Landerstraeten merged commit 825daf0 into phpro:master Jul 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants