Skip to content

Commit 1a691bb

Browse files
d8vjorkd8vjork
authored
Initial commit
0 parents  commit 1a691bb

20 files changed

+458
-0
lines changed

‎.editorconfig

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
insert_final_newline = true
10+
indent_style = space
11+
indent_size = 4
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false
16+
17+
[*.{yml,xml}]
18+
indent_size = 2

‎.gitattributes

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
* text=auto
2+
3+
*.lock -diff
4+
*.min.js -diff
5+
*.min.css -diff
6+
7+
/.github export-ignore
8+
CHANGELOG.md export-ignore

‎.github/dependabot.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
# Check for updates to GitHub Actions every week
8+
interval: "weekly"

‎.github/workflows/phpstan.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: phpstan
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
analyze:
7+
runs-on: ubuntu-latest
8+
9+
name: PHPStan
10+
11+
steps:
12+
- name: 🏗 Checkout code
13+
uses: actions/checkout@v4
14+
15+
- name: 🏗 Setup PHP
16+
uses: shivammathur/setup-php@v2
17+
with:
18+
php-version: '8.3'
19+
coverage: none
20+
tools: phpstan
21+
22+
- name: 🏗 Get composer cache directory
23+
id: composer-cache
24+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
25+
26+
- name: 🏗 Cache dependencies
27+
uses: actions/cache@v4
28+
with:
29+
path: ${{ steps.composer-cache.outputs.dir }}
30+
key: phpstan-composer-${{ hashFiles('**/composer.lock') }}
31+
restore-keys: phpstan-composer-
32+
33+
- name: 📦 Install dependencies
34+
run: composer install --no-interaction --no-suggest
35+
36+
- name: 🧪 Analyse code
37+
run: phpstan analyse

‎.github/workflows/pint.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: pint
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
analyze:
7+
runs-on: ubuntu-latest
8+
9+
name: Laravel Pint
10+
11+
steps:
12+
- name: 🏗 Checkout code
13+
uses: actions/checkout@v4
14+
15+
- name: 🏗 Setup PHP
16+
uses: shivammathur/setup-php@v2
17+
with:
18+
php-version: '8.3'
19+
coverage: none
20+
tools: laravel/pint
21+
22+
- name: 🧪 Analyse code
23+
run: pint

‎.github/workflows/publish.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Publish
2+
3+
on:
4+
push:
5+
tags:
6+
- '**'
7+
8+
jobs:
9+
# @see https://stackoverflow.com/a/72959712/8179249
10+
check-current-branch:
11+
runs-on: ubuntu-latest
12+
13+
outputs:
14+
branch: ${{ steps.check_step.outputs.branch }}
15+
16+
steps:
17+
- name: 🏗 Checkout code
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: 🏗 Get current branch
23+
id: check_step
24+
run: |
25+
raw=$(git branch -r --contains ${{ github.ref }})
26+
branch="$(echo ${raw//origin\//} | tr -d '\n')"
27+
echo "{name}=branch" >> $GITHUB_OUTPUT
28+
echo "Branches where this tag exists : $branch."
29+
30+
build:
31+
runs-on: ubuntu-latest
32+
33+
needs: check-current-branch
34+
35+
steps:
36+
- name: 🏗 Checkout code
37+
uses: actions/checkout@v4
38+
39+
- name: 🏗 Get release info
40+
id: query-release-info
41+
uses: release-flow/keep-a-changelog-action@v3
42+
with:
43+
command: query
44+
version: latest
45+
46+
- name: 🚀 Publish to Github releases
47+
uses: softprops/action-gh-release@v2
48+
with:
49+
body: ${{ steps.query-release-info.outputs.release-notes }}
50+
make_latest: contains(${{ needs.check.outputs.branch }}, 'main')
51+
# prerelease: true
52+
# files: '*.vsix'

‎.github/workflows/tests.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: tests
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
test:
7+
runs-on: ${{ matrix.os }}
8+
9+
strategy:
10+
fail-fast: true
11+
matrix:
12+
os: [ ubuntu-latest ]
13+
php: [ 8.1, 8.2, 8.3 ]
14+
stability: [ prefer-stable ]
15+
laravel: [ 10.*, 11.* ]
16+
include:
17+
- laravel: 10.*
18+
testbench: 8.*
19+
20+
- laravel: 11.*
21+
testbench: 9.*
22+
exclude:
23+
- php: 8.1
24+
laravel: 11.*
25+
26+
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
27+
28+
steps:
29+
- name: 🏗 Checkout code
30+
uses: actions/checkout@v4
31+
32+
- name: 🏗 Setup PHP
33+
uses: shivammathur/setup-php@v2
34+
with:
35+
php-version: ${{ matrix.php }}
36+
coverage: pcov
37+
38+
- name: 🏗 Get composer cache directory
39+
id: composer-cache
40+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
41+
42+
- name: 🏗 Cache dependencies
43+
uses: actions/cache@v4
44+
with:
45+
path: ${{ steps.composer-cache.outputs.dir }}
46+
key: dependencies-composer-laravel-${{ matrix.laravel }}-${{ hashFiles('**/composer.lock') }}
47+
restore-keys: dependencies-composer-laravel-${{ matrix.laravel }}-
48+
49+
- name: 📦 Install dependencies
50+
run: |
51+
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
52+
composer update --prefer-dist --no-interaction --no-progress --${{ matrix.stability }}
53+
54+
- name: 🧪 Execute tests
55+
run: vendor/bin/phpunit -c phpunit.coverage.dist.xml
56+
57+
- name: 🚀 Upload coverage reports to Codecov
58+
uses: codecov/codecov-action@v4
59+
with:
60+
token: ${{ secrets.CODECOV_TOKEN }}
61+
files: ./clover.xml
62+
fail_ci_if_error: true
63+
# verbose: true

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/vendor/
2+
/node_modules
3+
composer.lock
4+
phpunit.xml
5+
.DS_Store
6+
coverage
7+
clover.xml
8+
.phpunit.cache

‎.vscode/extensions.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"open-southeners.vscode-php-extension-pack"
4+
]
5+
}

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Open Southeners
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 all
13+
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 THE
21+
SOFTWARE.

‎README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title_goes_here [![required php version](https://img.shields.io/packagist/php-v/open-southeners/packagist_package_here)](https://www.php.net/supported-versions.php) [![codecov](https://codecov.io/gh/open-southeners/packagist_package_here/branch/main/graph/badge.svg?token=codecov_badge_token)](https://codecov.io/gh/open-southeners/packagist_package_here) [![Edit on VSCode online](https://img.shields.io/badge/vscode-edit%20online-blue?logo=visualstudiocode)](https://vscode.dev/github/open-southeners/packagist_package_here)
2+
===
3+
4+
and_description_here
5+
6+
**Search & replace:**
7+
8+
| Keys | Replacement |
9+
| --------------------------------------------------------- | ------------------------------------------------------------- |
10+
| `title_goes_here` | Fancy title from the repository (only README and stuff) |
11+
| `and_description_here` | Short package description (only for README and composer.json) |
12+
| `packagist_package_here` | Packagist (composer) published package name |
13+
| `codecov_badge_token` | Codecov token for the coverage badge |
14+
| `OpenSoutheners\PhpPackage`, `OpenSoutheners\\PhpPackage` | PSR-0 and PSR-4 complaint package namespace |
15+
16+
## Getting started
17+
18+
```
19+
composer require open-southeners/packagist_package_here
20+
```
21+
22+
## Partners
23+
24+
[![skore logo](https://github.com/open-southeners/partners/raw/main/logos/skore_logo.png)](https://getskore.com)
25+
26+
## License
27+
28+
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

‎SECURITY.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We're also following the [Laravel's default support policy](https://laravel.com/docs/master/releases#support-policy) on our semantic versioning.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.x | :white_check_mark: |
10+
<!-- | 2.x | :white_check_mark: | -->
11+
<!-- | < 1.0 | :x: | -->
12+
13+
## Reporting a Vulnerability
14+
15+
Send us an email at [email protected]

‎composer.json

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"name": "open-southeners/packagist_package_here",
3+
"description": "and_description_here",
4+
"license": "MIT",
5+
"keywords": [
6+
"open-southeners"
7+
],
8+
"authors": [
9+
{
10+
"name": "Ruben Robles",
11+
"email": "[email protected]",
12+
"homepage": "https://d8vjork.com"
13+
}
14+
],
15+
"funding": [
16+
{
17+
"type": "github",
18+
"url": "https://github.com/sponsors/open-southeners"
19+
}
20+
],
21+
"require": {
22+
"php": "^8.1"
23+
},
24+
"require-dev": {
25+
"larastan/larastan": "^2.0",
26+
"orchestra/testbench": "^8.0 || ^9.0",
27+
"phpstan/phpstan": "^1.0",
28+
"phpunit/phpunit": "^10.0"
29+
},
30+
"minimum-stability": "stable",
31+
"prefer-stable": true,
32+
"autoload": {
33+
"psr-4": {
34+
"OpenSoutheners\\PhpPackage\\": "src"
35+
}
36+
},
37+
"autoload-dev": {
38+
"psr-4": {
39+
"OpenSoutheners\\PhpPackage\\Tests\\": "tests"
40+
}
41+
},
42+
"config": {
43+
"sort-packages": true
44+
},
45+
"extra": {
46+
"laravel": {
47+
"providers": [
48+
"OpenSoutheners\\PhpPackage\\ServiceProvider"
49+
]
50+
}
51+
}
52+
}

‎phpstan.neon

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
includes:
2+
- ./vendor/larastan/larastan/extension.neon
3+
4+
parameters:
5+
6+
paths:
7+
- src
8+
9+
level: "max"

0 commit comments

Comments
 (0)