Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ghostwriter authored Oct 15, 2022
0 parents commit 8e3f2a7
Show file tree
Hide file tree
Showing 28 changed files with 6,755 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size = 2

[docker-compose.yml]
indent_size = 4
27 changes: 27 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Auto detect text files and perform LF normalization
* text=auto
*.md text diff=markdown
*.sh text eol=lf
*.png binary
*.jpg binary
/.github/ export-ignore
/docs/ export-ignore
/tests/ export-ignore
/.editorconfig export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/ecs.php export-ignore
/infection.json export-ignore
/infection.json.dist export-ignore
/mkdocs.yml export-ignore
/mkdocs.yml.dist export-ignore
/phpbench.json export-ignore
/phpbench.json.dist export-ignore
/phpcs.xml export-ignore
/phpcs.xml.dist export-ignore
/phpunit.xml export-ignore
/phpunit.xml.dist export-ignore
/psalm-baseline.xml export-ignore
/psalm.xml export-ignore
/psalm.xml.dist export-ignore
/rector.php export-ignore
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# <https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners>

* @ghostwriter
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [ghostwriter]
46 changes: 46 additions & 0 deletions .github/workflows/compliance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Compliance

on:
workflow_dispatch:
pull_request:
push:
branches:
- "**"
- "[0-9]+.[0-9]+.x"
- "v[0-9]+"
schedule:
- cron: "0 * * * *" # Runs hourly

jobs:
matrix:
name: Generate job matrix
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.matrix.outputs.matrix }}
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Determine CI Jobs
id: matrix
uses: ghostwriter/compliance@v1
with:
command: matrix
qa:
name: ${{ matrix.name }} on PHP ${{ matrix.php }} with ${{ matrix.dependency }} dependencies
needs: [matrix]
runs-on: ${{ matrix.os }}
continue-on-error: ${{ matrix.experimental }}
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.matrix.outputs.matrix) }}
steps:
- name: ${{ matrix.name }} on PHP ${{ matrix.php }}
uses: ghostwriter/laminas-continuous-integration-action@temp
with:
job: '{"php":"${{ matrix.php }}","dependencies":"${{ matrix.dependency }}","extensions":[],"ini":[],"command":"${{ matrix.command }}"}'
# - name: QA Check ${{ matrix.name }} on PHP ${{ matrix.php }}
# uses: ghostwriter/compliance@qa/test-workflow
# with:
# command: check
# job: ${{ matrix.command }}
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/.cache/
/.phpunit.cache/
/docs/html/
/vendor/
/.env
/.phpcs-cache
/.phpunit.cache
/.phpunit.result.cache
/clover.xml
/coveralls-upload.json
/infection.json
/mkdocs.site.yml
/phpbench.json
/phpcs.xml
/phpunit.xml
/psalm.xml
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2020, Nathanael Esayeas
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# wip

[![Compliance](https://github.com/ghostwriter/wip/actions/workflows/compliance.yml/badge.svg)](https://github.com/ghostwriter/wip/actions/workflows/compliance.yml)
[![Supported PHP Version](https://badgen.net/packagist/php/ghostwriter/wip?color=8892bf)](https://www.php.net/supported-versions)
[![Type Coverage](https://shepherd.dev/github/ghostwriter/wip/coverage.svg)](https://shepherd.dev/github/ghostwriter/wip)
[![Latest Version on Packagist](https://badgen.net/packagist/v/ghostwriter/wip)](https://packagist.org/packages/ghostwriter/wip)
[![Downloads](https://badgen.net/packagist/dt/ghostwriter/wip?color=blue)](https://packagist.org/packages/ghostwriter/wip)

work in progress

> **Warning**
>
> This project is not finished yet, work in progress.

## Installation

You can install the package via composer:

``` bash
composer require ghostwriter/wip
```

## Usage

```php
// work in progress
```

## Testing

``` bash
composer test
```

## Changelog

Please see [CHANGELOG.md](./CHANGELOG.md) for more information what has changed recently.

## Security

If you discover any security related issues, please email `[email protected]` instead of using the issue tracker.

## Support

[[`Become a GitHub Sponsor`](https://github.com/sponsors/ghostwriter)]

## Credits

- [Nathanael Esayeas](https://github.com/ghostwriter)
- [All Contributors](https://github.com/ghostwriter/wip/contributors)

## License

The BSD-3-Clause. Please see [License File](./LICENSE) for more information.
Empty file added bin/.gitkeep
Empty file.
133 changes: 133 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
{
"name": "ghostwriter/wip",
"description": "Here be dragons",
"license": "BSD-3-Clause",
"type": "library",
"keywords": [
"ghostwriter",
"wip"
],
"authors": [
{
"name": "Nathanael Esayeas",
"email": "[email protected]",
"homepage": "https://github.com/ghostwriter",
"role": "Developer"
}
],
"homepage": "https://github.com/ghostwriter/wip",
"support": {
"issues": "https://github.com/ghostwriter/wip/issues",
"forum": "https://github.com/ghostwriter/wip/discussions",
"source": "https://github.com/ghostwriter/wip",
"docs": "https://github.com/ghostwriter/wip",
"rss": "https://github.com/ghostwriter/wip/releases.atom"
},
"funding": [
{
"type": "github",
"url": "https://github.com/sponsors/ghostwriter"
}
],
"require": {
"php": ">=8.1,<8.3",
"ghostwriter/collection": "^0.5.1",
"ghostwriter/container": "^1.0.0",
"ghostwriter/event-dispatcher": "^1.0.0",
"ghostwriter/json": "^1.0.0",
"ghostwriter/option": "^1.0.1",
"ghostwriter/result": "^1.0.1"
},
"require-dev": {
"infection/infection": "^0.26.15",
"nikic/php-parser": "^4.15.1",
"phpbench/phpbench": "^1.2.6",
"phpunit/phpunit": "^9.5.25",
"psalm/plugin-phpunit": "^0.17.0",
"rector/rector": "^0.14.5",
"symplify/easy-coding-standard": "^11.1.10",
"vimeo/psalm": "^4.27.0"
},
"replace": {},
"minimum-stability": "stable",
"prefer-stable": true,
"autoload": {
"psr-4": {
"Ghostwriter\\wip\\": "src/"
},
"files": [
"src/constants.php",
"src/functions.php"
]
},
"autoload-dev": {
"psr-4": {
"Ghostwriter\\wip\\Tests\\": "tests/"
}
},
"bin": [
"bin/my-other-script",
"bin/my-script"
],
"config": {
"allow-plugins": {
"infection/extension-installer": true
},
"classmap-authoritative": true,
"discard-changes": true,
"optimize-autoloader": true,
"preferred-install": "dist",
"prepend-autoloader": true,
"process-timeout": 5000,
"sort-packages": true
},
"scripts": {
"cache:clear": [
"rm -fr ./.cache"
],
"check": [
"@composer validate",
"@normalizer",
"@cs-check",
"@cs-fix",
"@test",
"@psalm:security",
"@rector:dry-run",
"@psalm:dry-run"
],
"cs-check": "vendor/bin/ecs check --clear-cache || true",
"cs-fix": [
"vendor/bin/ecs check --fix --clear-cache",
"vendor/bin/ecs check-markdown --fix --clear-cache"
],
"infection": [
"@putenv XDEBUG_MODE=coverage",
"vendor/bin/infection --verbose"
],
"missing-returntypes": "psalm --alter --issues=MissingReturnType",
"normalizer": "composer normalize --no-check-lock",
"phpunit": "phpunit --colors=always --testdox --stop-on-failure",
"psalm": "@psalm:shepherd",
"psalm:baseline": "psalm --set-baseline=psalm-baseline.xml",
"psalm:dry-run": "psalm --alter --issues=all --dry-run",
"psalm:missing": "psalm --alter --issues=MissingReturnType",
"psalm:security": "psalm --taint-analysis",
"psalm:shepherd": "psalm --shepherd --stats --no-diff --no-cache",
"rector": "vendor/bin/rector process",
"rector:dry-run": "vendor/bin/rector process --dry-run || true",
"test": [
"@xdebug",
"@phpunit",
"@psalm",
"@infection"
],
"test:coverage": [
"@cache:clear",
"@xdebug",
"@phpunit"
],
"xdebug": [
"@putenv XDEBUG_MODE=coverage"
]
}
}
Loading

0 comments on commit 8e3f2a7

Please sign in to comment.