Skip to content

Commit c89a3f8

Browse files
committed
Initial commit
0 parents  commit c89a3f8

13 files changed

+420
-0
lines changed

.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at https://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

.gitattributes

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.editorconfig export-ignore
6+
/.gitattributes export-ignore
7+
/.github export-ignore
8+
/.gitignore export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/PULL_REQUEST_TEMPLATE.md export-ignore
11+
/ISSUE_TEMPLATE.md export-ignore
12+
/phpcs.xml.dist export-ignore
13+
/phpunit.xml.dist export-ignore
14+
/tests export-ignore
15+
/docs export-ignore
16+
/img export-ignore

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.idea
2+
build
3+
composer.lock
4+
vendor
5+
phpunit.xml
6+
.phpunit.result.cache

CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
All notable changes to `swisnl/php-cs-fixer-bitbucket` will be documented in this file.
4+
5+
Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
6+
7+
## [Unreleased]
8+
9+
- Nothing

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at `service@swis.nl`. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [GitHub](https://github.com/swisnl/php-cs-fixer-bitbucket).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Fix the code style with ``$ composer format``.
11+
12+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
13+
14+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
15+
16+
- **Create feature branches** - Don't ask us to pull from your master branch.
17+
18+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
19+
20+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
21+
22+
23+
**Happy coding**!

ISSUE_TEMPLATE.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Provide a general summary of the issue in the Title above -->
2+
3+
## Detailed description
4+
5+
Provide a detailed description of the change or addition you are proposing.
6+
7+
Make it clear if the issue is a bug, an enhancement or just a question.
8+
9+
## Context
10+
11+
Why is this change important to you? How would you use it?
12+
13+
How can it benefit other users?
14+
15+
## Possible implementation
16+
17+
Not obligatory, but suggest an idea for implementing addition or change.
18+
19+
## Your environment
20+
21+
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
22+
23+
* Version used (e.g. PHP 8.0):
24+
* Operating system and version (e.g. Ubuntu 22.04, Windows 10):
25+
* Link to your project:
26+
* ...
27+
* ...

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2023 SWIS BV
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

PULL_REQUEST_TEMPLATE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
5+
Describe your changes in detail.
6+
7+
## Motivation and context
8+
9+
Why is this change required? What problem does it solve?
10+
11+
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
12+
or `closes #num`, the issue will be automatically closed when the pull is accepted.)
13+
14+
## How has this been tested?
15+
16+
Please describe in detail how you tested your changes.
17+
18+
Include details of your testing environment, and the tests you ran to
19+
see how your change affects other areas of the code, etc.
20+
21+
## Screenshots (if appropriate)
22+
23+
## Types of changes
24+
25+
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
26+
- [ ] Bug fix (non-breaking change which fixes an issue)
27+
- [ ] New feature (non-breaking change which adds functionality)
28+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
29+
30+
## Checklist:
31+
32+
Go over all the following points, and put an `x` in all the boxes that apply.
33+
34+
Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our [continuous integration](http://www.phptherightway.com/#continuous-integration) server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/).
35+
36+
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
37+
- [ ] My pull request addresses exactly one patch/feature.
38+
- [ ] I have created a branch for this patch/feature.
39+
- [ ] Each individual commit in the pull request is meaningful.
40+
- [ ] I have added tests to cover my changes.
41+
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
42+
43+
If you're unsure about any of these, don't hesitate to ask. We're here to help!

README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# PHP CS Fixer Bitbucket error reporter
2+
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Buy us a tree][ico-treeware]][link-treeware]
6+
[![Total Downloads][ico-downloads]][link-downloads]
7+
[![Maintained by SWIS][ico-swis]][link-swis]
8+
9+
This PHP CS Fixer reporter will add annotations in Bitbucket, for example in pull requests, similar to the built-in GitLab formatting.
10+
11+
## Installation
12+
13+
Via Composer
14+
15+
```bash
16+
composer require --dev swisnl/php-cs-fixer-bitbucket
17+
```
18+
19+
## Usage
20+
21+
To use this custom reporter you need to run PHP CS Fixer with the GitLab format and pipe the results to this package. For example:
22+
23+
```bash
24+
php-cs-fixer check --format=gitlab --diff | phpcsf2bb
25+
```
26+
27+
## Screenshots
28+
29+
TODO
30+
31+
## Changelog
32+
33+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
34+
35+
## Contributing
36+
37+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
38+
39+
## Security
40+
41+
If you discover any security related issues, please email security@swis.nl instead of using the issue tracker.
42+
43+
## Credits
44+
45+
- [Jasper Zonneveld][link-author]
46+
- [All Contributors][link-contributors]
47+
48+
## License
49+
50+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
51+
52+
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**][link-treeware] to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
53+
54+
## SWIS :heart: Open Source
55+
56+
[SWIS][link-swis] is a web agency from Leiden, the Netherlands. We love working with open source software.
57+
58+
[ico-version]: https://img.shields.io/packagist/v/swisnl/php-cs-fixer-bitbucket.svg?style=flat-square
59+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
60+
[ico-treeware]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen.svg?style=flat-square
61+
[ico-downloads]: https://img.shields.io/packagist/dt/swisnl/php-cs-fixer-bitbucket.svg?style=flat-square
62+
[ico-swis]: https://img.shields.io/badge/%F0%9F%9A%80-maintained%20by%20SWIS-%230737A9.svg?style=flat-square
63+
64+
[link-packagist]: https://packagist.org/packages/swisnl/php-cs-fixer-bitbucket
65+
[link-downloads]: https://packagist.org/packages/swisnl/php-cs-fixer-bitbucket
66+
[link-treeware]: https://plant.treeware.earth/swisnl/php-cs-fixer-bitbucket
67+
[link-fork]: https://github.com/modprobe/php-cs-fixer-bitbucket
68+
[link-author]: https://github.com/JaZo
69+
[link-contributors]: ../../contributors
70+
[link-swis]: https://www.swis.nl

bin/phpcsf2bb

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#!/usr/bin/env php
2+
<?php
3+
4+
error_reporting(E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED);
5+
6+
set_error_handler(static function ($severity, $message, $file, $line) {
7+
if ($severity & error_reporting()) {
8+
throw new ErrorException($message, 0, $severity, $file, $line);
9+
}
10+
});
11+
12+
// load dependencies
13+
(function () {
14+
$possibleFiles = [__DIR__.'/../../../autoload.php', __DIR__.'/../../autoload.php', __DIR__.'/../vendor/autoload.php'];
15+
$file = null;
16+
foreach ($possibleFiles as $possibleFile) {
17+
if (file_exists($possibleFile)) {
18+
$file = $possibleFile;
19+
20+
break;
21+
}
22+
}
23+
24+
if (null === $file) {
25+
throw new RuntimeException('Unable to locate autoload.php file.');
26+
}
27+
28+
require_once $file;
29+
})();
30+
31+
use Swis\PhpCsFixer\Report\BitbucketReporter;
32+
33+
$data = stream_get_contents(STDIN);
34+
$annotations = json_decode($data, true, 512, JSON_THROW_ON_ERROR);
35+
36+
$reporter = new BitbucketReporter();
37+
$reporter->report($annotations);
38+
39+
__HALT_COMPILER();

0 commit comments

Comments
 (0)