Skip to content

Commit 1c81639

Browse files
authored
Import v0.1.0 (#2)
1 parent 4cce581 commit 1c81639

29 files changed

+1307
-220
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
12+
A clear and concise description of what the bug is.
13+
14+
## Environment
15+
16+
**PHP Version:**
17+
<!-- e.g., 8.2.15, 8.3.2 -->
18+
19+
**PHPStan Version:**
20+
<!-- e.g., 2.0.1, 2.1.0 -->
21+
22+
**Extension Version:**
23+
<!-- e.g., 1.0.0 or commit hash if using dev version -->
24+
25+
## Code Sample
26+
27+
Please provide a minimal code sample that demonstrates the issue:
28+
29+
```php
30+
// Your code here that reproduces the issue
31+
```
32+
33+
## Expected Behavior
34+
35+
A clear and concise description of what you expected to happen.
36+
37+
## Actual Behavior
38+
39+
A clear and concise description of what actually happened.
40+
41+
## PHPStan Configuration
42+
43+
If relevant, please share your PHPStan configuration:
44+
45+
```neon
46+
# Your phpstan.neon configuration
47+
```
48+
49+
## Additional Context
50+
51+
Add any other context about the problem here (stack traces, error messages, etc.).

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a Question
4+
url: https://github.com/built-fast/phpstan-sensitive-parameter/discussions
5+
about: Ask questions and discuss with the community
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Description
11+
12+
A clear and concise description of what you want to happen.
13+
14+
## Use Case
15+
16+
Describe the problem you're trying to solve. Why would this feature be useful?
17+
18+
## Proposed Solution
19+
20+
A clear and concise description of what you want to happen.
21+
22+
## Code Example
23+
24+
If applicable, provide a code example of how this feature would work:
25+
26+
```php
27+
// Example of how the feature would be used
28+
```
29+
30+
## Alternatives Considered
31+
32+
A clear and concise description of any alternative solutions or features you've considered.
33+
34+
## Additional Context
35+
36+
Add any other context, screenshots, or examples about the feature request here.

.github/pull_request_template.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Summary
2+
3+
Describe what this PR does and why it's needed.
4+
5+
## Type of Change
6+
7+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change that adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📚 Documentation update
11+
- [ ] 🎨 Code style/formatting change
12+
- [ ] ♻️ Refactoring (no functional changes)
13+
- [ ] ⚡ Performance improvement
14+
- [ ] 🧪 Test updates
15+
16+
## Changes Made
17+
18+
- [ ] Describe specific change 1
19+
- [ ] Describe specific change 2
20+
- [ ] Describe specific change 3
21+
22+
## Testing
23+
24+
- [ ] Added/updated tests for new functionality
25+
- [ ] All existing tests pass (`vendor/bin/pest`)
26+
- [ ] PHPStan analysis passes (`vendor/bin/phpstan analyze`)
27+
- [ ] Code style check passes (`vendor/bin/pint --test`)
28+
- [ ] Tested with PHP 8.2 and 8.3
29+
- [ ] Tested with multiple PHPStan versions (if applicable)
30+
31+
## Documentation
32+
33+
- [ ] README updated (if applicable)
34+
- [ ] Code comments added for complex logic
35+
- [ ] PHPDoc blocks updated
36+
37+
## Checklist
38+
39+
- [ ] Self-review completed
40+
- [ ] Code follows project style guidelines (PSR-12, enforced by Pint)
41+
- [ ] No breaking changes (or breaking changes documented)
42+
- [ ] Commit messages are clear and descriptive

.github/workflows/ci.yml

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
name: Tests (PHP ${{ matrix.php-version }}, PHPStan ${{ matrix.phpstan-version }})
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
fail-fast: false
16+
matrix:
17+
php-version: [8.2, 8.3]
18+
phpstan-version: ['2.0.*', '^2.1']
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- name: Setup PHP
24+
uses: shivammathur/setup-php@v2
25+
with:
26+
php-version: ${{ matrix.php-version }}
27+
extensions: dom, curl, libxml, mbstring, zip
28+
coverage: none
29+
30+
- name: Cache Composer packages
31+
id: composer-cache
32+
uses: actions/cache@v3
33+
with:
34+
path: vendor
35+
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
36+
restore-keys: |
37+
${{ runner.os }}-php-
38+
39+
- name: Install dependencies
40+
run: composer install --prefer-dist --no-progress
41+
42+
- name: Install specific PHPStan version
43+
run: composer require --dev "phpstan/phpstan:${{ matrix.phpstan-version }}" --no-update && composer update phpstan/phpstan
44+
45+
- name: Execute tests via Pest
46+
run: vendor/bin/pest
47+
48+
pint:
49+
name: Code Style (Pint)
50+
runs-on: ubuntu-latest
51+
52+
steps:
53+
- uses: actions/checkout@v4
54+
55+
- name: Setup PHP
56+
uses: shivammathur/setup-php@v2
57+
with:
58+
php-version: 8.3
59+
extensions: dom, curl, libxml, mbstring, zip
60+
coverage: none
61+
62+
- name: Cache Composer packages
63+
id: composer-cache
64+
uses: actions/cache@v3
65+
with:
66+
path: vendor
67+
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
68+
restore-keys: |
69+
${{ runner.os }}-php-
70+
71+
- name: Install dependencies
72+
run: composer install --prefer-dist --no-progress
73+
74+
- name: Run Pint
75+
run: vendor/bin/pint --test
76+
77+
phpstan:
78+
name: Static Analysis (PHPStan)
79+
runs-on: ubuntu-latest
80+
81+
steps:
82+
- uses: actions/checkout@v4
83+
84+
- name: Setup PHP
85+
uses: shivammathur/setup-php@v2
86+
with:
87+
php-version: 8.3
88+
extensions: dom, curl, libxml, mbstring, zip
89+
coverage: none
90+
91+
- name: Cache Composer packages
92+
id: composer-cache
93+
uses: actions/cache@v3
94+
with:
95+
path: vendor
96+
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
97+
restore-keys: |
98+
${{ runner.os }}-php-
99+
100+
- name: Install dependencies
101+
run: composer install --prefer-dist --no-progress
102+
103+
- name: Run PHPStan
104+
run: vendor/bin/phpstan analyze

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
/vendor/
2-
/composer.lock
2+
/composer.lock
3+
/.envrc
4+
/.phpunit.result.cache
5+
/.claude/settings.local.json
6+
.DS_Store

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 BuiltFast.com
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.

0 commit comments

Comments
 (0)