Showing preview only (560K chars total). Download the full file or copy to clipboard to get everything.
Repository: ramsey/php-library-starter-kit
Branch: main
Commit: f1e4383fdf87
Files: 247
Total size: 492.1 KB
Directory structure:
gitextract_7g50z4tk/
├── .editorconfig
├── .gitattributes.template
├── .github/
│ ├── CODEOWNERS
│ ├── ISSUE_TEMPLATE/
│ │ ├── Bug_Report.md
│ │ ├── Feature_Request.md
│ │ ├── Question.md
│ │ └── config.yml
│ ├── dependabot.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── continuous-integration.yml
│ └── merge-me.yml
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── bin/
│ └── .gitkeep
├── build/
│ ├── .gitignore
│ ├── cache/
│ │ └── .gitkeep
│ ├── coverage/
│ │ └── .gitkeep
│ └── logs/
│ └── .gitkeep
├── captainhook.json
├── codecov.yml
├── composer.json
├── conventional-commits.json
├── docs/
│ └── .gitkeep
├── phpcs.xml.dist
├── phpstan.neon.dist
├── phpunit.xml.dist
├── psalm.xml
├── resources/
│ ├── .gitkeep
│ └── templates/
│ ├── CHANGELOG.md.twig
│ ├── CONTRIBUTING.md.twig
│ ├── FUNDING.yml.twig
│ ├── code-of-conduct/
│ │ ├── Citizen-2.3.md.twig
│ │ ├── Contributor-1.4.md.twig
│ │ ├── Contributor-2.0.md.twig
│ │ └── Contributor-2.1.md.twig
│ ├── header/
│ │ ├── AGPL-3.0-or-later.twig
│ │ ├── Apache-2.0.twig
│ │ ├── BSD-2-Clause.twig
│ │ ├── BSD-3-Clause.twig
│ │ ├── CC0-1.0.twig
│ │ ├── GPL-3.0-or-later.twig
│ │ ├── Hippocratic-2.1.twig
│ │ ├── LGPL-3.0-or-later.twig
│ │ ├── MIT-0.twig
│ │ ├── MIT.twig
│ │ ├── MPL-2.0.twig
│ │ ├── Proprietary.twig
│ │ ├── Unlicense.twig
│ │ └── source-file-header.twig
│ ├── license/
│ │ ├── AGPL-3.0-or-later-NOTICE.twig
│ │ ├── AGPL-3.0-or-later.twig
│ │ ├── Apache-2.0-NOTICE.twig
│ │ ├── Apache-2.0.twig
│ │ ├── BSD-2-Clause.twig
│ │ ├── BSD-3-Clause.twig
│ │ ├── CC0-1.0.twig
│ │ ├── GPL-3.0-or-later-NOTICE.twig
│ │ ├── GPL-3.0-or-later.twig
│ │ ├── Hippocratic-2.1.twig
│ │ ├── LGPL-3.0-or-later-NOTICE.twig
│ │ ├── LGPL-3.0-or-later.twig
│ │ ├── MIT-0.twig
│ │ ├── MIT.twig
│ │ ├── MPL-2.0-NOTICE.twig
│ │ ├── MPL-2.0.twig
│ │ ├── Proprietary.twig
│ │ ├── Unlicense.twig
│ │ └── copyright-statement.twig
│ ├── readme/
│ │ ├── badges.md.twig
│ │ ├── code-of-conduct.md.twig
│ │ ├── copyright.md.twig
│ │ ├── description.md.twig
│ │ ├── security.md.twig
│ │ └── usage.md.twig
│ └── security-policy/
│ └── HackerOne.md.twig
├── src/
│ ├── Example.php
│ └── LibraryStarterKit/
│ ├── Answers.php
│ ├── Console/
│ │ ├── InstallQuestions.php
│ │ ├── Question/
│ │ │ ├── AnswersTool.php
│ │ │ ├── AuthorEmail.php
│ │ │ ├── AuthorHoldsCopyright.php
│ │ │ ├── AuthorName.php
│ │ │ ├── AuthorUrl.php
│ │ │ ├── CodeOfConduct.php
│ │ │ ├── CodeOfConductCommittee.php
│ │ │ ├── CodeOfConductEmail.php
│ │ │ ├── CodeOfConductPoliciesUrl.php
│ │ │ ├── CodeOfConductReportingUrl.php
│ │ │ ├── CopyrightEmail.php
│ │ │ ├── CopyrightHolder.php
│ │ │ ├── CopyrightUrl.php
│ │ │ ├── CopyrightYear.php
│ │ │ ├── EmailValidatorTool.php
│ │ │ ├── GithubUsername.php
│ │ │ ├── License.php
│ │ │ ├── PackageDescription.php
│ │ │ ├── PackageKeywords.php
│ │ │ ├── PackageName.php
│ │ │ ├── PackageNamespace.php
│ │ │ ├── SecurityPolicy.php
│ │ │ ├── SecurityPolicyContactEmail.php
│ │ │ ├── SecurityPolicyContactFormUrl.php
│ │ │ ├── SkippableQuestion.php
│ │ │ ├── StarterKitQuestion.php
│ │ │ ├── UrlValidatorTool.php
│ │ │ └── VendorName.php
│ │ ├── Style.php
│ │ └── StyleFactory.php
│ ├── Exception/
│ │ ├── InvalidConsoleInput.php
│ │ └── StarterKitException.php
│ ├── Filesystem.php
│ ├── Project.php
│ ├── Setup.php
│ ├── Task/
│ │ ├── Build.php
│ │ ├── Builder/
│ │ │ ├── Cleanup.php
│ │ │ ├── FixStyle.php
│ │ │ ├── InstallDependencies.php
│ │ │ ├── RenameTemplates.php
│ │ │ ├── RunTests.php
│ │ │ ├── SetupRepository.php
│ │ │ ├── UpdateChangelog.php
│ │ │ ├── UpdateCodeOfConduct.php
│ │ │ ├── UpdateComposerJson.php
│ │ │ ├── UpdateContributing.php
│ │ │ ├── UpdateFunding.php
│ │ │ ├── UpdateLicense.php
│ │ │ ├── UpdateNamespace.php
│ │ │ ├── UpdateReadme.php
│ │ │ ├── UpdateSecurityPolicy.php
│ │ │ └── UpdateSourceFileHeaders.php
│ │ └── Builder.php
│ └── Wizard.php
└── tests/
├── ExampleTest.php
├── LibraryStarterKit/
│ ├── AnswersTest.php
│ ├── Console/
│ │ ├── InstallQuestionsTest.php
│ │ ├── Question/
│ │ │ ├── AuthorEmailTest.php
│ │ │ ├── AuthorHoldsCopyrightTest.php
│ │ │ ├── AuthorNameTest.php
│ │ │ ├── AuthorUrlTest.php
│ │ │ ├── CodeOfConductCommitteeTest.php
│ │ │ ├── CodeOfConductEmailTest.php
│ │ │ ├── CodeOfConductPoliciesUrlTest.php
│ │ │ ├── CodeOfConductReportingUrlTest.php
│ │ │ ├── CodeOfConductTest.php
│ │ │ ├── CopyrightEmailTest.php
│ │ │ ├── CopyrightHolderTest.php
│ │ │ ├── CopyrightUrlTest.php
│ │ │ ├── CopyrightYearTest.php
│ │ │ ├── EmailValidatorToolTest.php
│ │ │ ├── GithubUsernameTest.php
│ │ │ ├── LicenseTest.php
│ │ │ ├── PackageDescriptionTest.php
│ │ │ ├── PackageKeywordsTest.php
│ │ │ ├── PackageNameTest.php
│ │ │ ├── PackageNamespaceTest.php
│ │ │ ├── QuestionTestCase.php
│ │ │ ├── SecurityPolicyContactEmailTest.php
│ │ │ ├── SecurityPolicyContactFormUrlTest.php
│ │ │ ├── SecurityPolicyTest.php
│ │ │ ├── UrlValidatorToolTest.php
│ │ │ └── VendorNameTest.php
│ │ └── StyleFactoryTest.php
│ ├── FilesystemTest.php
│ ├── ProjectTest.php
│ ├── SetupTest.php
│ ├── SnapshotsTool.php
│ ├── Task/
│ │ ├── BuildTest.php
│ │ ├── Builder/
│ │ │ ├── CleanupTest.php
│ │ │ ├── FixStyleTest.php
│ │ │ ├── InstallDependenciesTest.php
│ │ │ ├── RenameTemplatesTest.php
│ │ │ ├── RunTestsTest.php
│ │ │ ├── SetupRepositoryTest.php
│ │ │ ├── UpdateChangelogTest.php
│ │ │ ├── UpdateCodeOfConductTest.php
│ │ │ ├── UpdateComposerJsonTest.php
│ │ │ ├── UpdateContributingTest.php
│ │ │ ├── UpdateFundingTest.php
│ │ │ ├── UpdateLicenseTest.php
│ │ │ ├── UpdateNamespaceTest.php
│ │ │ ├── UpdateReadmeTest.php
│ │ │ ├── UpdateSecurityPolicyTest.php
│ │ │ ├── UpdateSourceFileHeadersTest.php
│ │ │ ├── __snapshots__/
│ │ │ │ ├── UpdateComposerJsonTest__testBuildWithMinimalComposerJson__1.txt
│ │ │ │ ├── UpdateComposerJsonTest__testBuild__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__6.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__6.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__6.txt
│ │ │ │ ├── UpdateReadmeTest__testBuildWhenCodeOfConductIsNullAndSecurityPolicyIsFalse__1.txt
│ │ │ │ ├── UpdateReadmeTest__testBuildWhenCodeOfConductIsNull__1.txt
│ │ │ │ ├── UpdateReadmeTest__testBuild__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__0__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__0__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__10__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__10__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__11__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__11__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__1__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__1__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__2__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__2__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__3__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__3__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__4__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__4__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__5__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__5__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__6__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__6__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__7__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__7__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__8__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__8__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__9__1.txt
│ │ │ │ └── UpdateSourceFileHeadersTest__testBuild_with_data_set__9__2.txt
│ │ │ └── fixtures/
│ │ │ ├── composer-full.json
│ │ │ ├── composer-minimal.json
│ │ │ ├── readme-full.md
│ │ │ ├── update-namespace-test.php
│ │ │ ├── update-source-file-headers-test-1.php
│ │ │ └── update-source-file-headers-test-2.php
│ │ └── BuilderTest.php
│ ├── TestCase.php
│ ├── WindowsSafeTextDriver.php
│ ├── WizardTest.php
│ └── answers-test.json
└── TestCase.php
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
# EditorConfig http://EditorConfig.org
# top-most EditorConfig file
root = true
# This applies to all files
[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8
indent_style = space
indent_size = 4
[*.{yml,yaml}]
indent_size = 2
================================================
FILE: .gitattributes.template
================================================
/.allowed-licenses export-ignore
/.editorconfig export-ignore
/.gitattributes export-ignore
/.github/ export-ignore
/.gitignore export-ignore
/bin/ export-ignore
/build/ export-ignore
/captainhook.json export-ignore
/CHANGELOG.md export-ignore
/codecov.yml export-ignore
/CODE_OF_CONDUCT.md export-ignore
/CONTRIBUTING.md export-ignore
/conventional-commits.json export-ignore
/docs/ export-ignore
/phpcs.xml.dist export-ignore
/phpstan.neon.dist export-ignore
/phpunit.xml.dist export-ignore
/psalm-baseline.xml export-ignore
/psalm.xml export-ignore
/resources/ export-ignore
/SECURITY.md export-ignore
/tests/ export-ignore
================================================
FILE: .github/CODEOWNERS
================================================
================================================
FILE: .github/ISSUE_TEMPLATE/Bug_Report.md
================================================
---
name: Bug Report
about: Create a bug report to help us improve
labels: bug
assignees:
---
<!--- Provide a general summary of the issue you're having in the title above. -->
## Description
<!-- Provide a short and clear description of the bug. -->
## Steps to reproduce
<!--
Provide steps to reproduce the behavior you are experiencing. Please try to keep
this as short as possible. If able, create a reproducible script outside of any
framework you are using. This will help us to quickly debug the issue.
-->
1. Step one...
2. Step two...
3. Step three...
## Expected behavior
<!-- Provide a short and clear description of what you expect to happen. -->
## Screenshots or output
<!-- If applicable, add screenshots or program output to help explain your problem. -->
## Environment details
<!-- Provide details about the system where you're using this package. -->
- version of this package: *e.g. 1.0.0, 1.0.1, 1.1.0*
- PHP version: *e.g. 7.3.16, 7.4.4*
- OS: *e.g. Windows 10, Linux (Ubuntu 18.04.1), macOS Catalina (10.15.3)*
## Additional context
<!-- Provide any additional context that may help us debug the problem. -->
================================================
FILE: .github/ISSUE_TEMPLATE/Feature_Request.md
================================================
---
name: Feature Request
about: Suggest a feature for this project
labels: enhancement
assignees:
---
<!--- Provide a general summary of your feature request in the title above. -->
<!-- Give your feature a short title here. -->
## My feature title
<!-- Provide a short and clear description of the feature. -->
## Background/problem
<!--
Provide background details to show why this feature is necessary. Is your
feature request related to a problem? If so, please describe the problem.
Provide as much detail as possible.
-->
## Proposal/solution
<!--
Provide a short and clear description of the solution you'd like. Include code
examples, if possible. Feel free to use pseudo-code to show how you think the
feature should work.
-->
## Alternatives
<!-- Describe any alternative solutions or features you've considered. -->
## Additional context
<!-- Please provide any other context or code examples that may help. -->
================================================
FILE: .github/ISSUE_TEMPLATE/Question.md
================================================
---
name: Question
about: Ask a question about how to use this library
labels: question
assignees:
---
<!--- Provide a general summary of your question in the title above. -->
<!-- Write your question here. -->
## How do I... ?
<!-- Provide any additional context that may help us answer your question. -->
## Example code
<!--
If your question is about code that you've written, provide a short and clear
example of what you're trying to accomplish. Try to keep this as short as
possible. If able, please provide an example outside of any framework you are
using. This will help us to quickly respond to your question.
-->
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: "composer"
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
================================================
FILE: .github/pull_request_template.md
================================================
<!--- Provide a general summary of your changes in the title above. -->
## Description
<!--- Describe your changes in detail. -->
## Motivation and context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
## How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## PR checklist
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING.md** document.
- [ ] I have added tests to cover my changes.
================================================
FILE: .github/workflows/continuous-integration.yml
================================================
# GitHub Actions Documentation: https://docs.github.com/en/actions
name: "Continuous Integration"
on:
push:
branches:
- "main"
tags:
- "*"
pull_request:
branches:
- "main"
# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
# The concurrency group contains the workflow name and the branch name.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
COMPOSER_ROOT_VERSION: "1.99.99"
jobs:
coding-standards:
name: "Coding standards"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout repository"
uses: "actions/checkout@v5"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "latest"
coverage: "none"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v3"
- name: "Check syntax (php-parallel-lint)"
run: "composer dev:lint:syntax"
- name: "Check coding standards (PHP_CodeSniffer)"
run: "composer dev:lint:style"
static-analysis:
name: "Static analysis"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout repository"
uses: "actions/checkout@v5"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "latest"
coverage: "none"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v3"
- name: "Statically analyze code (PHPStan)"
run: "composer dev:analyze:phpstan"
- name: "Statically analyze code (Psalm)"
run: "composer dev:analyze:psalm -- --shepherd"
security-analysis:
name: "Security analysis"
needs: ["coding-standards", "static-analysis"]
runs-on: "ubuntu-latest"
# If you encounter "Resource not accessible by integration" errors on
# GitHub Actions for this job, uncomment the following lines. Your
# organization permissions may not be set to allow writing security events.
permissions:
security-events: write
steps:
- name: "Checkout repository"
uses: "actions/checkout@v5"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "latest"
coverage: "none"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v3"
- name: "Analyze security of code (Psalm)"
run: "./vendor/bin/psalm --taint-analysis --report=build/logs/psalm.sarif"
- name: "Upload security analysis results to GitHub"
uses: "github/codeql-action/upload-sarif@v4"
with:
sarif_file: "build/logs/psalm.sarif"
code-coverage:
name: "Code coverage"
needs: ["coding-standards", "static-analysis"]
runs-on: "ubuntu-latest"
steps:
- name: "Checkout repository"
uses: "actions/checkout@v5"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "latest"
coverage: "pcov"
ini-values: "memory_limit=-1"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v3"
- name: "Run unit tests (PHPUnit)"
run: "composer dev:test:coverage:ci"
- name: "Publish coverage report to Codecov"
uses: "codecov/codecov-action@v5"
unit-tests:
name: "Unit tests"
needs: ["code-coverage"]
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
php:
- "8.1"
- "8.2"
- "8.3"
- "8.4"
os:
- "macos-latest"
- "ubuntu-latest"
- "windows-latest"
composer-deps:
- "lowest"
- "highest"
steps:
- name: "Configure Git (for Windows)"
if: ${{ matrix.os == 'windows-latest' }}
shell: "bash"
run: |
git config --system core.autocrlf false
git config --system core.eol lf
- name: "Checkout repository"
uses: "actions/checkout@v5"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "${{ matrix.php }}"
coverage: "none"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "${{ matrix.composer-deps }}"
- name: "Run unit tests (PHPUnit)"
shell: "bash"
run: "composer dev:test:unit"
================================================
FILE: .github/workflows/merge-me.yml
================================================
# Merge Me! Documentation: https://github.com/ridedott/merge-me-action/
name: "Merge Dependabot PRs"
on:
workflow_run:
types:
- "completed"
workflows:
- "Continuous Integration"
jobs:
merge-me:
name: "Merge me!"
runs-on: "ubuntu-latest"
steps:
- name: "Auto-merge"
if: ${{ github.event.workflow_run.conclusion == 'success' }}
uses: "ridedott/merge-me-action@v2"
with:
# This must be used as GitHub Actions token does not support pushing
# to protected branches.
#
# Create a token with repository permissions:
# https://github.com/settings/tokens/new?scopes=repo&description=Merge+Me!+GitHub+Actions+Workflow
#
# Set MERGE_TOKEN as an environment variable on your repository:
# https://github.com/yourname/repo-name/settings/secrets/actions/new
GITHUB_TOKEN: ${{ secrets.MERGE_TOKEN }}
================================================
FILE: .gitignore
================================================
.phpunit.result.cache
/captainhook.config.json
/composer.lock
/phpcs.xml
/phpunit.xml
/vendor/
================================================
FILE: CHANGELOG.md
================================================
# ramsey/php-library-starter-kit Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## 3.5.6 - 2025-03-07
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Partially revert commit dbec32c337e4bab527ca829db3d8cef3e7f08536; the attempt to define the full Symfony Question interface on the custom StarterKitQuestion interface caused problems when using older versions of symfony/console.
## 3.5.5 - 2025-03-07
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Modernize and update type declarations and annotations throughout (no BC breaks).
- Ensure all tests and static analysis tools pass on PHP 8.3 and 8.4.
- Update symfony/finder dependency to `^6.4 || ^7.2`.
- Update twig/twig dependency to `^3.20`.
## 3.5.4 - 2023-10-31
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Add missing instructions for creating `MERGE_TOKEN` to `merge-me.yml` GitHub Action file.
## 3.5.3 - 2023-10-31
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- By default, assign permissions to upload security reports
## 3.5.2 - 2023-05-25
### Added
- Add comment about permissions for security events to continuous integration workflow file.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Disable rendering Code of Conduct messages if None selected.
## 3.5.1 - 2023-04-27
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Remove code supporting old versions of symfony/process.
- Improve checks for line-endings.
## 3.5.0 - 2023-04-27
### Added
- Add an option for version 2.1 of the Contributor Covenant
- Update GitHub workflows to support auto-merging of Dependabot pull requests
### Changed
- Update ramsey/devtools to version 2.0
- Increase minimum PHP version to 8.1
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Stop passing `starter-kit` command name to avoid confusing newer versions of symfony/console.
## 3.4.2 - 2022-01-27
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Use a new instance of the Symfony Finder for each use.
## 3.4.1 - 2022-01-02
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Bump codecov/codecov-action to v2.1.0
## 3.4.0 - 2022-01-02
### Added
- Add the `allow-plugins` property to composer.json.
- Tell Dependabot to update GitHub Actions.
- Run GitHub Actions CI builds only on pushes to `main` and PRs based on `main`.
### Changed
- Remove "deps" as a type from conventional commits configuration.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Use v2 of ramsey/composer-install.
- Fix a few package compatibility issues with PHP 8.1.
## 3.3.0 - 2021-09-26
### Added
- Allow use of an existing answers file when creating new projects.
When using Composer's `create-project` command, users may now provide an environment variable (`STARTER_KIT_ANSWERS_FILE`) to indicate the location of an already-existing answers file to use when setting up a new library. This must be a JSON file including properties defined in `Ramsey\Dev\LibraryStarterKit\Answers`. To completely turn off the question prompts, include the property `skipPrompts: true`.
For example:
```shell
STARTER_KIT_ANSWERS_FILE=/path/to/answers.json composer create-project ramsey/php-library-starter-kit YOUR-PROJECT-NAME
```
- Include a builder task (`Ramsey\Dev\LibraryStarterKit\Task\Builder\FixStyle`) that fixes any style issues before instantiating the new repository. This avoids coding standards errors caused by out-of-order `use` statements, etc.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
## 3.2.2 - 2021-08-11
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Remove description case from Conventional Commits configuration, since the lowercase requirement causes confusion
- Remove PHPStan and Psalm checks from pre-commit hook, since these can result in false positives/negatives when analyzing only a few files at a time
- Use https in URLs
- Use the correct branch name in GitHub URLs
## 3.2.1 - 2021-08-07
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fix link to SECURITY.md
## 3.2.0 - 2021-08-06
### Added
- Provide Creative Commons Zero v1.0 Universal as a license option
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Write a Coordinated Disclosure section to the README if choosing to include a security policy
- Move the pull request template so that GitHub will use it
## 3.1.1 - 2021-08-05
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Detect author name and email using Git config
## 3.1.0 - 2021-08-05
### Added
- Use the author name and email address for git config, if necessary
- Require the author email address
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Set the branch name *after* the initial commit to avoid errors on older versions of Git
## 3.0.3 - 2021-08-04
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Support older versions of Git that do not implement the `-b` option for `git init`
- Improve exception handling to aid with debugging
## 3.0.2 - 2021-07-18
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Add missing newline to end of generated composer.json file
## 3.0.1 - 2021-07-18
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Make sure CaptainHook installation runs after the repository initialization
## 3.0.0 - 2021-07-14
### Added
- Allow users to exit the wizard and restart it later, saving their answers
- Use ramsey/devtools instead of `vnd:*` scripts in the local `composer.json`
- Use [CaptainHook](https://github.com/captainhookphp/captainhook) to manage Git hooks
- Enforce the use of [Conventional Commits](https://www.conventionalcommits.org)
- Validate and check normalization of `composer.json` in pre-commit hook
- Run syntax, style, and static analysis checks in pre-commit hook
- Run `composer install` on post-merge and post-checkout hooks
- Run `composer test` in pre-push hook
- Add option to include a security policy (vulnerability disclosure policy) as part of the wizard
- Add [GitHub Actions](https://docs.github.com/en/actions) configuration for CI workflows
- Add [Codecov](https://about.codecov.io) configuration for viewing code coverage reports
- Use ramsey/coding-standard
### Changed
- Rename from ramsey/php-library-skeleton to ramsey/php-library-starter-kit
- Major re-working of the library to use [symfony/console](https://symfony.com/doc/current/components/console.html)
### Deprecated
- Nothing.
### Removed
- Remove dependencies on NodeJS and npm packages
- Remove all `vnd:*` scripts from `composer.json`
- Remove `bin/repl`, since ramsey/devtools uses ramsey/composer-repl
- Remove Travis CI configuration, in favor of GitHub Actions
- Remove Coveralls configuration, in favor of Codecov
### Fixed
- Nothing.
## 2.1.4 - 2020-05-29
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Remove package name from license file, since it caused conflicts with GitHub's automatic license-detection software
## 2.1.3 - 2020-05-29
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fix case of incorrect license used in generated package.json
## 2.1.2 - 2020-05-29
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fix typo in `export-ignore` directives in `.gitattributes`
## 2.1.1 - 2020-05-29
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fix links to code of conduct and contributing guide
## 2.1.0 - 2020-05-29
### Added
- Nothing.
### Changed
- Rename phpstan.neon to phpstan.neon.dist
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
## 2.0.1 - 2020-05-29
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fix typo in CONTRIBUTING.md.
## 2.0.0 - 2020-05-29
### Added
- Nothing.
### Changed
- Pretty much a full re-write
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
## 1.1.1 - 2019-10-23
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fixed PSR-12 coding standards violations.
## 1.1.0 - 2019-05-27
### Added
- Nothing.
### Changed
- Moved the `README.md` file to the project root to support packages that will not be placed on GitHub.
- Upgraded to the latest versions of dev tools:
- PHPStan `^0.11`
- PHPUnit `^8`
- Now using `--no-suggest` when installing packages after finishing the wizard.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
## 1.0.2 - 2019-01-03
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- The `.gitattributes` file continues to be problematic when using the zip distribution, so this release removes the file entirely.
## 1.0.1 - 2019-01-03
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Fixed a problem where using `composer create-project` was not properly creating a project from the 1.0.0 release because the `.gitattributes` file was too liberal, failing to include important skeleton files in the release zip bundle.
## 1.0.0 - 2019-01-02
This is the initial release of ramsey/php-library-starter-kit, with the ability to
quickly generate a PHP library including all the starting files that I
([@ramsey][]) prefer to have in my projects. Future versions of this project may
expand on this and allow for more generic options.
To create the starting point for a PHP library using this project, run the
following:
``` bash
composer create-project --remove-vcs ramsey/php-library-starter-kit target-directory
```
You will be walked through a series of questions, and your PHP library source
files will be located in `target-directory`, when completed. Change to that
directory, `git init`, and off you go!
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
[@ramsey]: https://github.com/ramsey
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at ben@benramsey.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing
Contributions are welcome. This project accepts pull requests on [GitHub][].
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). By
participating in this project and its community, you are expected to uphold this
code.
## Communication Channels
You can find help and discussion in the following places:
* GitHub Issues: <https://github.com/ramsey/php-library-starter-kit/issues>
## Reporting Bugs
Report bugs using the project's [issue tracker][issues].
⚠️ _**ATTENTION!!!** DO NOT include passwords or other sensitive information in
your bug report._
When submitting a bug report, please include enough information to reproduce the
bug. A good bug report includes the following sections:
* **Description**
Provide a short and clear description of the bug.
* **Steps to reproduce**
Provide steps to reproduce the behavior you are experiencing. Please try to
keep this as short as possible. If able, create a reproducible script outside
of any framework you are using. This will help us to quickly debug the issue.
* **Expected behavior**
Provide a short and clear description of what you expect to happen.
* **Screenshots or output**
If applicable, add screenshots or program output to help explain your problem.
* **Environment details**
Provide details about the system where you're using this package, such as PHP
version and operating system.
* **Additional context**
Provide any additional context that may help us debug the problem.
## Fixing Bugs
This project welcomes pull requests to fix bugs!
If you see a bug report that you'd like to fix, please feel free to do so.
Following the directions and guidelines described in the "Adding New Features"
section below, you may create bugfix branches and send pull requests.
## Adding New Features
If you have an idea for a new feature, it's a good idea to check out the
[issues][] or active [pull requests][] first to see if anyone is already working
on the feature. If not, feel free to submit an issue first, asking whether the
feature is beneficial to the project. This will save you from doing a lot of
development work only to have your feature rejected. We don't enjoy rejecting
your hard work, but some features don't fit with the goals of the project.
When you do begin working on your feature, here are some guidelines to consider:
* Your pull request description should clearly detail the changes you have made.
We will use this description to update the CHANGELOG. If there is no
description, or it does not adequately describe your feature, we may ask you
to update the description.
* ramsey/php-library-starter-kit follows a superset of **[PSR-12 coding standard][psr-12]**.
Please ensure your code does, too. _Hint: run `composer dev:lint` to check._
* Please **write tests** for any new features you add.
* Please **ensure that tests pass** before submitting your pull request.
ramsey/php-library-starter-kit automatically runs tests for pull requests. However,
running the tests locally will help save time. _Hint: run `composer test`._
* **Use topic/feature branches.** Please do not ask to pull from your main branch.
* For more information, see "[Understanding the GitHub flow][gh-flow]."
* **Submit one feature per pull request.** If you have multiple features you
wish to submit, please break them into separate pull requests.
* **Write good commit messages.** This project follows the
[Conventional Commits][] specification and uses Git hooks to ensure all
commits follow this standard. Running `composer install` will set up the Git
hooks, so when you run `git commit`, you'll be prompted to create a commit
using the Conventional Commits rules.
## Developing
To develop this project, you will need [PHP](https://www.php.net) 7.4 or greater
and [Composer](https://getcomposer.org).
After cloning this repository locally, execute the following commands:
``` bash
cd /path/to/repository
composer install
```
Now, you are ready to develop!
### Tooling
This project uses [CaptainHook](https://github.com/CaptainHookPhp/captainhook)
to validate all staged changes prior to commit.
### Commands
To see all the commands available for contributing to this project:
``` bash
composer list dev
```
### Coding Standards
This project follows a superset of [PSR-12](https://www.php-fig.org/psr/psr-12/)
coding standards, enforced by [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
CaptainHook will run coding standards checks before committing.
You may lint the codebase manually using the following commands:
``` bash
# Lint
composer dev:lint
# Attempt to auto-fix coding standards issues
composer dev:lint:fix
```
### Static Analysis
This project uses a combination of [PHPStan](https://github.com/phpstan/phpstan)
and [Psalm](https://github.com/vimeo/psalm) to provide static analysis of PHP
code.
CaptainHook will run static analysis checks before committing.
You may run static analysis manually across the whole codebase with the
following command:
``` bash
# Static analysis
composer dev:analyze
```
### Project Structure
This project uses [pds/skeleton](https://github.com/php-pds/skeleton) as its
base folder structure and layout.
### Running Tests
The following must pass before we will accept a pull request. If this does not
pass, it will result in a complete build failure. Before you can run this, be
sure to `composer install`.
To run all the tests and coding standards checks, execute the following from the
command line, while in the project root directory:
```
composer test
```
CaptainHook will automatically run all tests before pushing to the remote
repository.
### Running `create-project` Locally
You can test Composer's `create-project` command locally to make sure the
starter kit wizard runs properly with your changes. To do so, use a command
similar to the following:
```shell
composer create-project ramsey/php-library-starter-kit YOUR-PROJECT-NAME \
--repository='{ "type": "path", "url": "/path/to/local/php-library-starter-kit", "options": { "symlink": false } }' \
--remove-vcs \
--stability=dev
```
[github]: https://github.com/ramsey/php-library-starter-kit
[issues]: https://github.com/ramsey/php-library-starter-kit/issues
[pull requests]: https://github.com/ramsey/php-library-starter-kit/pulls
[psr-12]: https://www.php-fig.org/psr/psr-12/
[gh-flow]: https://guides.github.com/introduction/flow/
[conventional commits]: https://www.conventionalcommits.org/
================================================
FILE: LICENSE
================================================
Copyright (c) 2019-2025 Ben Ramsey <ben@benramsey.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
<h1 align="center"><!-- NAME_START -->PHP Library Starter Kit<!-- NAME_END --></h1>
<!-- BADGES_START -->
<p align="center">
<strong>A starter kit for quickly setting up a new PHP library package.</strong>
</p>
<p align="center">
<a href="https://github.com/ramsey/php-library-starter-kit"><img src="http://img.shields.io/badge/source-ramsey/php--library--starter--kit-blue.svg?style=flat-square" alt="Source Code"></a>
<a href="https://packagist.org/packages/ramsey/php-library-starter-kit"><img src="https://img.shields.io/packagist/v/ramsey/php-library-starter-kit.svg?style=flat-square&label=release" alt="Download Package"></a>
<a href="https://php.net"><img src="https://img.shields.io/packagist/php-v/ramsey/php-library-starter-kit.svg?style=flat-square&colorB=%238892BF" alt="PHP Programming Language"></a>
<a href="https://github.com/ramsey/php-library-starter-kit/blob/main/LICENSE"><img src="https://img.shields.io/packagist/l/ramsey/php-library-starter-kit.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a>
<a href="https://github.com/ramsey/php-library-starter-kit/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/actions/workflow/status/ramsey/php-library-starter-kit/continuous-integration.yml?branch=main&style=flat-square&logo=github" alt="Build Status"></a>
<a href="https://codecov.io/gh/ramsey/php-library-starter-kit"><img src="https://img.shields.io/codecov/c/gh/ramsey/php-library-starter-kit?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
<a href="https://shepherd.dev/github/ramsey/php-library-starter-kit"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fphp-library-starter-kit%2Fcoverage" alt="Psalm Type Coverage"></a>
</p>
<!-- BADGES_END -->
<!-- DESC_START -->
## About
ramsey/php-library-starter-kit is a package that may be used to generate a basic
PHP library project directory structure, complete with many of the starting
files (i.e. README, LICENSE, GitHub issue templates, PHPUnit configuration,
etc.) that are commonly found in PHP libraries. You may use the project
directory that's created as a starting point for creating your own PHP libraries.
<!-- DESC_END -->
<!-- COC_START -->
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to
uphold this code.
<!-- COC_END -->
<!-- USAGE_START -->
## Usage
``` bash
composer create-project ramsey/php-library-starter-kit YOUR-PROJECT-NAME
```
Running this command will create a new repository containing the same files
and structure as this repository. Afterward, it will run the
`Ramsey\Dev\LibraryStarterKit\Wizard::start()` method to set up the project, which will
walk you through a series of questions and make changes to files based on your
answers. When complete, it will remove the `./src/LibraryStarterKit` and `./tests/LibraryStarterKit`
directories, leaving everything else in place with an initial commit.
### Using An Existing Answers File
When executing `create-project`, if you exit the program while in the middle of
the question prompts, you might notice it creates a `.starter-kit-answers` file
in the project directory. When you return later and run `composer starter-kit`,
it will use this file to pre-fill any questions you've already answered. Once
finished, the starter kit removes this file.
You may also use an existing answers file to provide all your answers to the
prompts, including skipping the question prompts. To do this, set an environment
variable with the path to your answers file:
```shell
STARTER_KIT_ANSWERS_FILE=/path/to/starter-kit-answers.json
```
To skip the question prompts, make sure you include the `skipPrompts` property
in the answers file, and set it to `true`.
The answers file is a JSON object, consisting of all the public properties found
in `Ramsey\Dev\LibraryStarterKit\Answers`.
For example:
```json
{
"authorEmail": "author@example.com",
"authorHoldsCopyright": true,
"authorName": "Author Smith",
"authorUrl": "https://example.com/",
"codeOfConduct": "Contributor-2.0",
"codeOfConductCommittee": null,
"codeOfConductEmail": "conduct@example.com",
"codeOfConductPoliciesUrl": null,
"codeOfConductReportingUrl": null,
"copyrightEmail": "author@example.com",
"copyrightHolder": "Acme, Inc.",
"copyrightUrl": "https://example.com/acme",
"copyrightYear": "2021",
"githubUsername": "example",
"license": "MIT",
"packageDescription": "An awesome library that does stuff.",
"packageKeywords": [
"awesome",
"stuff"
],
"packageName": "acme/awesome",
"packageNamespace": "Acme\\Awesome",
"projectName": "My Awesome Library",
"securityPolicy": true,
"securityPolicyContactEmail": "security@example.com",
"securityPolicyContactFormUrl": null,
"skipPrompts": true,
"vendorName": "acme"
}
```
<!-- USAGE_END -->
## Contributing
Contributions are welcome! To contribute, please familiarize yourself with
[CONTRIBUTING.md](CONTRIBUTING.md).
<!-- SECURITY_START -->
## Coordinated Disclosure
Keeping user information safe and secure is a top priority, and we welcome the
contribution of external security researchers. If you believe you've found a
security issue in software that is maintained in this repository, please read
[SECURITY.md](SECURITY.md) for instructions on submitting a vulnerability report.
<!-- SECURITY_END -->
<!-- FAQ_START -->
## FAQs
### Why did you include package/tool *x* and not *y*?
I created this project starter kit for my own uses, and these are the
common files, packages, and tools I use in my PHP libraries. If you like what
you see, feel free to use it. If you like some of it but not all, fork it and
customize it to fit your needs. I hope you find it helpful!
<!-- FAQ_END -->
<!-- COPYRIGHT_START -->
## Copyright and License
ramsey/php-library-starter-kit is copyright © [Ben Ramsey](https://benramsey.com)
and licensed for use under the terms of the
MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
<!-- COPYRIGHT_END -->
================================================
FILE: SECURITY.md
================================================
<!--
This policy template was created using the HackerOne Policy Builder [1],
with guidance from the National Telecommunications and Information
Administration Coordinated Vulnerability Disclosure Template [2].
-->
# Vulnerability Disclosure Policy (VDP)
## Brand Promise
<!--
This is your brand promise. Its objective is to "demonstrate a clear, good
faith commitment to customers and other stakeholders potentially impacted by
security vulnerabilities" [2].
-->
Keeping user information safe and secure is a top priority, and we welcome the
contribution of external security researchers.
## Scope
<!--
This is your initial scope. It tells vulnerability finders and reporters
"which systems and capabilities are 'fair game' versus 'off limits'" [2].
For software packages, this is often a list of currently maintained versions
of the package.
-->
If you believe you've found a security issue in software that is maintained in
this repository, we encourage you to notify us.
| Version | In scope | Source code |
| ------- | :------: | ----------- |
| latest | ✅ | https://github.com/ramsey/php-library-starter-kit |
## How to Submit a Report
<!--
This is your communication process. It tells security researchers how to
contact you to report a vulnerability. It may be a link to a web form that
uses HTTPS for secure communication, or it may be an email address.
Optionally, you may choose to include a PGP public key, so that researchers
may send you encrypted messages.
-->
To submit a vulnerability report, please contact us at security@ramsey.dev.
Your submission will be reviewed and validated by a member of our team.
## Safe Harbor
<!--
This section assures vulnerability finders and reporters that they will
receive good faith responses to their good faith acts. In other words,
"we will not take legal action if..." [2].
-->
We support safe harbor for security researchers who:
* Make a good faith effort to avoid privacy violations, destruction of data, and
interruption or degradation of our services.
* Only interact with accounts you own or with explicit permission of the account
holder. If you do encounter Personally Identifiable Information (PII) contact
us immediately, do not proceed with access, and immediately purge any local
information.
* Provide us with a reasonable amount of time to resolve vulnerabilities prior
to any disclosure to the public or a third party.
We will consider activities conducted consistent with this policy to constitute
"authorized" conduct and will not pursue civil action or initiate a complaint to
law enforcement. We will help to the extent we can if legal action is initiated
by a third party against you.
Please submit a report to us before engaging in conduct that may be inconsistent
with or unaddressed by this policy.
## Preferences
<!--
The preferences section sets expectations based on priority and submission
volume, rather than legal objection or restriction [2].
According to the NTIA [2]:
This section is a living document that sets expectations for preferences
and priorities, typically maintained by the support and engineering
team. This can outline classes of vulnerabilities, reporting style
(crash dumps, CVSS scoring, proof-of-concept, etc.), tools, etc. Too
many preferences can set the wrong tone or make reporting findings
difficult to navigate. This section also sets expectations to the
researcher community for what types of issues are considered important
or not.
-->
* Please provide detailed reports with reproducible steps and a clearly defined
impact.
* Include the version number of the vulnerable package in your report
* Social engineering (e.g. phishing, vishing, smishing) is prohibited.
<!--
References
[1] HackerOne. Policy builder. Retrieved from https://hackerone.com/policy-builder/
[2] NTIA Safety Working Group. 2016. "Early stage" coordinated vulnerability
disclosure template: Version 1.1. (15 December 2016). Retrieved from
https://www.ntia.doc.gov/files/ntia/publications/ntia_vuln_disclosure_early_stage_template.pdf
-->
## Encryption Key for security@ramsey.dev
For increased privacy when reporting sensitive issues, you may encrypt your
message using the following public key:
```
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF+Z9gEBEACbT/pIx8RR0K18t8Z2rDnmEV44YdT7HNsMdq+D6SAlx8UUb6AU
jGIbV9dgBgGNtOLU1pxloaJwL9bWIRbj+X/Qb2WNIP//Vz1Y40ox1dSpfCUrizXx
kb4p58Xml0PsB8dg3b4RDUgKwGC37ne5xmDnigyJPbiB2XJ6Xc46oPCjh86XROTK
wEBB2lY67ClBlSlvC2V9KmbTboRQkLdQDhOaUosMb99zRb0EWqDLaFkZVjY5HI7i
0pTveE6dI12NfHhTwKjZ5pUiAZQGlKA6J1dMjY2unxHZkQj5MlMfrLSyJHZxccdJ
xD94T6OTcTHt/XmMpI2AObpewZDdChDQmcYDZXGfAhFoJmbvXsmLMGXKgzKoZ/ls
RmLsQhh7+/r8E+Pn5r+A6Hh4uAc14ApyEP0ckKeIXw1C6pepHM4E8TEXVr/IA6K/
z6jlHORixIFX7iNOnfHh+qwOgZw40D6JnBfEzjFi+T2Cy+JzN2uy7I8UnecTMGo3
5t6astPy6xcH6kZYzFTV7XERR6LIIVyLAiMFd8kF5MbJ8N5ElRFsFHPW+82N2HDX
c60iSaTB85k6R6xd8JIKDiaKE4sSuw2wHFCKq33d/GamYezp1wO+bVUQg88efljC
2JNFyD+vl30josqhw1HcmbE1TP3DlYeIL5jQOlxCMsgai6JtTfHFM/5MYwARAQAB
tBNzZWN1cml0eUByYW1zZXkuZGV2iQJUBBMBCAA+FiEE4drPD+/ofZ570fAYq0bv
vXQCywIFAl+Z9gECGwMFCQeGH4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQ
q0bvvXQCywIkEA//Qcwv8MtTCy01LHZd9c7VslwhNdXQDYymcTyjcYw8x7O22m4B
3hXE6vqAplFhVxxkqXB2ef0tQuzxhPHNJgkCE4Wq4i+V6qGpaSVHQT2W6DN/NIhL
vS8OdScc6zddmIbIkSrzVVAtjwehFNEIrX3DnbbbK+Iku7vsKT5EclOluIsjlYoX
goW8IeReyDBqOe2H3hoCGw6EA0D/NYV2bJnfy53rXVIyarsXXeOLp7eNEH6Td7aW
PVSrMZJe1t+knrEGnEdrXWzlg4lCJJCtemGv+pKBUomnyISXSdqyoRCCzvQjqyig
2kRebUX8BXPW33p4OXPj9sIboUOjZwormWwqqbFMO+J4TiVCUoEoheI7emPFRcNN
QtPJrjbY1++OznBc0GRpfeUkGoU1cbRl1bnepnFIZMTDLkrVW6I1Y4q8ZVwX3BkE
N81ctFrRpHBlU36EdHvjPQmGtuiL77Qq3fWmMv7yTvK1wHJAXfEb0ZJWHZCbck3w
l0CVq0Z+UUAOM8Rp1N0N8m92xtapav0qCFU9qzf2J5qX6GRmWv+d29wPgFHzDWBm
nnrYYIA4wJLx00U6SMcVBSnNe91B+RfGY5XQhbWPjQQecOGCSDsxaFAq2MeOVJyZ
bIjLYfG9GxoLKr5R7oLRJvZI4nKKBc1Kci/crZbdiSdQhSQGlDz88F1OHeCIdQQQ
EQgAHRYhBOhdAxHd+lus86YQ57Atl5icjAcbBQJfmfdIAAoJELAtl5icjAcbFVcA
/1LqB3ZjsnXDAvvAXZVjSPqofSlpMLeRQP6IM/A9Odq0AQCZrtZc1knOMGEcjppK
Rk+sy/R0Mshy8TDuaZIRgh2Ux7kCDQRfmfYBARAAmchKzzVz7IaEq7PnZDb3szQs
T/+E9F3m39yOpV4fEB1YzObonFakXNT7Gw2tZEx0eitUMqQ/13jjfu3UdzlKl2bR
qA8LrSQRhB+PTC9A1XvwxCUYhhjGiLzJ9CZL6hBQB43qHOmE9XJPme90geLsF+gK
u39Waj1SNWzwGg+Gy1Gl5f2AJoDTxznreCuFGj+Vfaczt/hlfgqpOdb9jsmdoE7t
3DSWppA9dRHWwQSgE6J28rR4QySBcqyXS6IMykqaJn7Z26yNIaITLnHCZOSY8zhP
ha7GFsN549EOCgECbrnPt9dmI2+hQE0RO0e7SOBNsIf5sz/i7urhwuj0CbOqhjc2
X1AEVNFCVcb6HPi/AWefdFCRu0gaWQxn5g+9nkq5slEgvzCCiKYzaBIcr8qR6Hb4
FaOPVPxO8vndRouq57Ws8XpAwbPttioFuCqF4u9K+tK/8e2/R8QgRYJsE3Cz/Fu8
+pZFpMnqbDEbK3DL3ss+1ed1sky+mDV8qXXeI33XW5hMFnk1JWshUjHNlQmE6ftC
U0xSTMVUtwJhzH2zDp8lEdu7qi3EsNULOl68ozDr6soWAvCbHPeTdTOnFySGCleG
/3TonsoZJs/sSPPJnxFQ1DtgQL6EbhIwa0ZwU4eKYVHZ9tjxuMX3teFzRvOrJjgs
+ywGlsIURtEckT5Y6nMAEQEAAYkCPAQYAQgAJhYhBOHazw/v6H2ee9HwGKtG7710
AssCBQJfmfYBAhsMBQkHhh+AAAoJEKtG7710AssC8NcP/iDAcy1aZFvkA0EbZ85p
i7/+ywtE/1wF4U4/9OuLcoskqGGnl1pJNPooMOSBCfreoTB8HimT0Fln0CoaOm4Q
pScNq39JXmf4VxauqUJVARByP6zUfgYarqoaZNeuFF0S4AZJ2HhGzaQPjDz1uKVM
PE6tQSgQkFzdZ9AtRA4vElTH6yRAgmepUsOihk0b0gUtVnwtRYZ8e0Qt3ie97a73
DxLgAgedFRUbLRYiT0vNaYbainBsLWKpN/T8odwIg/smP0Khjp/ckV60cZTdBiPR
szBTPJESMUTu0VPntc4gWwGsmhZJg/Tt/qP08XYo3VxNYBegyuWwNR66zDWvwvGH
muMv5UchuDxp6Rt3JkIO4voMT1JSjWy9p8krkPEE4V6PxAagLjdZSkt92wVLiK5x
y5gNrtPhU45YdRAKHr36OvJBJQ42CDaZ6nzrzghcIp9CZ7ANHrI+QLRM/csz+AGA
szSp6S4mc1lnxxfbOhPPpebZPn0nIAXoZnnoVKdrxBVedPQHT59ZFvKTQ9Fs7gd3
sYNuc7tJGFGC2CxBH4ANDpOQkc5q9JJ1HSGrXU3juxIiRgfA26Q22S9c71dXjElw
Ri584QH+bL6kkYmm8xpKF6TVwhwu5xx/jBPrbWqFrtbvLNrnfPoapTihBfdIhkT6
nmgawbBHA02D5xEqB5SU3WJu
=eJNx
-----END PGP PUBLIC KEY BLOCK-----
```
================================================
FILE: bin/.gitkeep
================================================
================================================
FILE: build/.gitignore
================================================
*
!.gitignore
cache/*
!cache
!cache/.gitkeep
coverage/*
!coverage
!coverage/.gitkeep
logs/*
!logs
!logs/.gitkeep
================================================
FILE: build/cache/.gitkeep
================================================
================================================
FILE: build/coverage/.gitkeep
================================================
================================================
FILE: build/logs/.gitkeep
================================================
================================================
FILE: captainhook.json
================================================
{
"config": {
"ansi-colors": true,
"fail-on-first-error": false,
"plugins": [],
"verbosity": "normal"
},
"commit-msg": {
"enabled": true,
"actions": [
{
"action": "\\Ramsey\\CaptainHook\\ValidateConventionalCommit"
}
]
},
"pre-push": {
"enabled": true,
"actions": [
{
"action": "composer test"
}
]
},
"pre-commit": {
"enabled": true,
"actions": [
{
"action": "composer validate",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\Any",
"args": [["composer.json"]]
}
]
},
{
"action": "composer normalize --dry-run",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\Any",
"args": [["composer.json"]]
}
]
},
{
"action": "composer dev:lint:syntax -- {$STAGED_FILES|of-type:php}",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
"args": ["php"]
}
]
},
{
"action": "composer dev:lint:style -- {$STAGED_FILES|of-type:php}",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
"args": ["php"]
}
]
}
]
},
"prepare-commit-msg": {
"enabled": true,
"actions": [
{
"action": "\\Ramsey\\CaptainHook\\PrepareConventionalCommit"
}
]
},
"post-commit": {
"enabled": false,
"actions": []
},
"post-merge": {
"enabled": true,
"actions": [
{
"action": "composer install --ansi",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any",
"args": [["composer.json", "composer.lock"]]
}
]
}
]
},
"post-checkout": {
"enabled": true,
"actions": [
{
"action": "composer install --ansi",
"conditions": [
{
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any",
"args": [["composer.json", "composer.lock"]]
}
]
}
]
},
"post-rewrite": {
"enabled": false,
"actions": []
},
"post-change": {
"enabled": false,
"actions": []
}
}
================================================
FILE: codecov.yml
================================================
codecov:
require_ci_to_pass: yes
coverage:
precision: 2
round: down
range: "70...100"
status:
project:
default:
target: auto
threshold: 0%
patch:
default:
target: auto
threshold: 0%
parsers:
gcov:
branch_detection:
conditional: yes
loop: yes
method: no
macro: no
comment:
layout: "reach,diff,flags,tree"
behavior: default
require_changes: false
================================================
FILE: composer.json
================================================
{
"name": "ramsey/php-library-starter-kit",
"description": "A starter kit for quickly setting up a new PHP library package.",
"license": "MIT",
"type": "project",
"keywords": [
"builder",
"library",
"package",
"skeleton",
"template"
],
"authors": [
{
"name": "Ben Ramsey",
"email": "ben@benramsey.com",
"homepage": "https://benramsey.com"
}
],
"require": {
"php": "^8.1",
"symfony/finder": "^6.4 || ^7.2",
"twig/twig": "^3.20"
},
"require-dev": {
"ramsey/devtools": "^2.1",
"spatie/phpunit-snapshot-assertions": "^5.1"
},
"suggest": {
"ext-pcntl": "Provides the ability to quit and resume the starter kit wizard on POSIX systems"
},
"minimum-stability": "dev",
"prefer-stable": true,
"autoload": {
"psr-4": {
"Ramsey\\Dev\\LibraryStarterKit\\": "src/LibraryStarterKit/",
"Vendor\\SubNamespace\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Ramsey\\Test\\Dev\\LibraryStarterKit\\": "tests/LibraryStarterKit/",
"Vendor\\Test\\SubNamespace\\": "tests/"
}
},
"config": {
"allow-plugins": {
"captainhook/plugin-composer": true,
"dealerdirect/phpcodesniffer-composer-installer": true,
"ergebnis/composer-normalize": true,
"php-http/discovery": true,
"phpstan/extension-installer": true,
"ramsey/composer-repl": true,
"ramsey/devtools": true
},
"sort-packages": true
},
"extra": {
"captainhook": {
"force-install": true
},
"ramsey/conventional-commits": {
"configFile": "conventional-commits.json"
},
"ramsey/devtools": {
"command-prefix": "dev",
"memory-limit": "-1"
}
},
"scripts": {
"post-root-package-install": "git init",
"post-create-project-cmd": "Ramsey\\Dev\\LibraryStarterKit\\Wizard::start",
"starter-kit": "Ramsey\\Dev\\LibraryStarterKit\\Wizard::start"
},
"scripts-descriptions": {
"starter-kit": "Runs the PHP Library Starter Kit wizard."
}
}
================================================
FILE: conventional-commits.json
================================================
{
"typeCase": "kebab",
"types": [
"chore",
"ci",
"docs",
"feat",
"fix",
"refactor",
"security",
"style",
"test"
],
"scopeCase": "kebab",
"scopeRequired": false,
"scopes": [],
"descriptionCase": null,
"descriptionEndMark": "",
"bodyRequired": false,
"bodyWrapWidth": 72,
"requiredFooters": []
}
================================================
FILE: docs/.gitkeep
================================================
================================================
FILE: phpcs.xml.dist
================================================
<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
<arg name="extensions" value="php"/>
<arg name="colors"/>
<arg value="sp"/>
<file>./src</file>
<file>./tests</file>
<rule ref="Ramsey"/>
</ruleset>
================================================
FILE: phpstan.neon.dist
================================================
parameters:
tmpDir: ./build/cache/phpstan
treatPhpDocTypesAsCertain: false
level: max
paths:
- ./src
- ./tests
================================================
FILE: phpunit.xml.dist
================================================
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="./vendor/autoload.php"
colors="true"
cacheDirectory="./build/cache/phpunit">
<testsuites>
<testsuite name="unit-tests">
<directory>./tests</directory>
</testsuite>
</testsuites>
<coverage/>
<php>
<ini name="memory_limit" value="1G"/>
</php>
<source>
<include>
<directory suffix=".php">./src</directory>
</include>
</source>
</phpunit>
================================================
FILE: psalm.xml
================================================
<?xml version="1.0"?>
<psalm xmlns="https://getpsalm.org/schema/config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
cacheDirectory="./build/cache/psalm"
errorLevel="1"
findUnusedBaselineEntry="true"
findUnusedCode="false"
resolveFromConfigFile="true">
<projectFiles>
<directory name="./src"/>
<ignoreFiles>
<directory name="./tests"/>
<directory name="./vendor"/>
</ignoreFiles>
</projectFiles>
<plugins>
<pluginClass class="Psalm\MockeryPlugin\Plugin"/>
<pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
</plugins>
<issueHandlers>
<ClassMustBeFinal errorLevel="info"/>
<MissingOverrideAttribute errorLevel="info"/>
</issueHandlers>
</psalm>
================================================
FILE: resources/.gitkeep
================================================
================================================
FILE: resources/templates/CHANGELOG.md.twig
================================================
# {{ packageName }} Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## 0.1.0 - TBD
### Added
- Nothing.
### Changed
- Nothing.
### Deprecated
- Nothing.
### Removed
- Nothing.
### Fixed
- Nothing.
================================================
FILE: resources/templates/CONTRIBUTING.md.twig
================================================
# Contributing
Contributions are welcome. This project accepts pull requests on [GitHub][].
{% if codeOfConduct != 'None' %}
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). By
participating in this project and its community, you are expected to uphold this
code.
{% endif %}
## Communication Channels
You can find help and discussion in the following places:
* GitHub Issues: <https://github.com/{{ packageName }}/issues>
## Reporting Bugs
Report bugs using the project's [issue tracker][issues].
⚠️ _**ATTENTION!!!** DO NOT include passwords or other sensitive information in
your bug report._
When submitting a bug report, please include enough information to reproduce the
bug. A good bug report includes the following sections:
* **Description**
Provide a short and clear description of the bug.
* **Steps to reproduce**
Provide steps to reproduce the behavior you are experiencing. Please try to
keep this as short as possible. If able, create a reproducible script outside
of any framework you are using. This will help us to quickly debug the issue.
* **Expected behavior**
Provide a short and clear description of what you expect to happen.
* **Screenshots or output**
If applicable, add screenshots or program output to help explain your problem.
* **Environment details**
Provide details about the system where you're using this package, such as PHP
version and operating system.
* **Additional context**
Provide any additional context that may help us debug the problem.
## Fixing Bugs
This project welcomes pull requests to fix bugs!
If you see a bug report that you'd like to fix, please feel free to do so.
Following the directions and guidelines described in the "Adding New Features"
section below, you may create bugfix branches and send pull requests.
## Adding New Features
If you have an idea for a new feature, it's a good idea to check out the
[issues][] or active [pull requests][] first to see if anyone is already working
on the feature. If not, feel free to submit an issue first, asking whether the
feature is beneficial to the project. This will save you from doing a lot of
development work only to have your feature rejected. We don't enjoy rejecting
your hard work, but some features don't fit with the goals of the project.
When you do begin working on your feature, here are some guidelines to consider:
* Your pull request description should clearly detail the changes you have made.
We will use this description to update the CHANGELOG. If there is no
description, or it does not adequately describe your feature, we may ask you
to update the description.
* {{ packageName }} follows a superset of **[PSR-12 coding standard][psr-12]**.
Please ensure your code does, too. _Hint: run `composer dev:lint` to check._
* Please **write tests** for any new features you add.
* Please **ensure that tests pass** before submitting your pull request.
{{ packageName }} automatically runs tests for pull requests. However,
running the tests locally will help save time. _Hint: run `composer test`._
* **Use topic/feature branches.** Please do not ask to pull from your main branch.
* For more information, see "[Understanding the GitHub flow][gh-flow]."
* **Submit one feature per pull request.** If you have multiple features you
wish to submit, please break them into separate pull requests.
* **Write good commit messages.** This project follows the
[Conventional Commits][] specification and uses Git hooks to ensure all
commits follow this standard. Running `composer install` will set up the Git
hooks, so when you run `git commit`, you'll be prompted to create a commit
using the Conventional Commits rules.
## Developing
To develop this project, you will need [PHP](https://www.php.net) 7.4 or greater
and [Composer](https://getcomposer.org).
After cloning this repository locally, execute the following commands:
``` bash
cd /path/to/repository
composer install
```
Now, you are ready to develop!
### Tooling
This project uses [CaptainHook](https://github.com/CaptainHookPhp/captainhook)
to validate all staged changes prior to commit.
### Commands
To see all the commands available for contributing to this project:
``` bash
composer list dev
```
### Coding Standards
This project follows a superset of [PSR-12](https://www.php-fig.org/psr/psr-12/)
coding standards, enforced by [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
CaptainHook will run coding standards checks before committing.
You may lint the codebase manually using the following commands:
``` bash
# Lint
composer dev:lint
# Attempt to auto-fix coding standards issues
composer dev:lint:fix
```
### Static Analysis
This project uses a combination of [PHPStan](https://github.com/phpstan/phpstan)
and [Psalm](https://github.com/vimeo/psalm) to provide static analysis of PHP
code.
CaptainHook will run static analysis checks before committing.
You may run static analysis manually across the whole codebase with the
following command:
``` bash
# Static analysis
composer dev:analyze
```
### Project Structure
This project uses [pds/skeleton](https://github.com/php-pds/skeleton) as its
base folder structure and layout.
### Running Tests
The following must pass before we will accept a pull request. If this does not
pass, it will result in a complete build failure. Before you can run this, be
sure to `composer install`.
To run all the tests and coding standards checks, execute the following from the
command line, while in the project root directory:
```
composer test
```
CaptainHook will automatically run all tests before pushing to the remote
repository.
[github]: https://github.com/{{ packageName }}
[issues]: https://github.com/{{ packageName }}/issues
[pull requests]: https://github.com/{{ packageName }}/pulls
[psr-12]: https://www.php-fig.org/psr/psr-12/
[gh-flow]: https://guides.github.com/introduction/flow/
[conventional commits]: https://www.conventionalcommits.org/
================================================
FILE: resources/templates/FUNDING.yml.twig
================================================
================================================
FILE: resources/templates/code-of-conduct/Citizen-2.3.md.twig
================================================
# Citizen Code of Conduct
## 1. Purpose
A primary goal of {{ packageName }} is to be inclusive to the largest number of
contributors, with the most varied and diverse backgrounds possible. As such, we
are committed to providing a friendly, safe and welcoming environment for all,
regardless of gender, sexual orientation, ability, ethnicity, socioeconomic
status, and religion (or lack thereof).
This code of conduct outlines our expectations for all those who participate in
our community, as well as the consequences for unacceptable behavior.
We invite all those who participate in {{ packageName }} to help us create safe and
positive experiences for everyone.
## 2. Open \[Source/Culture/Tech\] Citizenship
A supplemental goal of this Code of Conduct is to increase open
\[source/culture/tech\] citizenship by encouraging participants to recognize and
strengthen the relationships between our actions and their effects on our
community.
Communities mirror the societies in which they exist and positive action is
essential to counteract the many forms of inequality and abuses of power that
exist in society.
If you see someone who is making an extra effort to ensure our community is
welcoming, friendly, and encourages all participants to contribute to the
fullest extent, we want to know.
## 3. Expected Behavior
The following behaviors are expected and requested of all community members:
* Participate in an authentic and active way. In doing so, you contribute to
the health and longevity of this community.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants. Alert
community leaders if you notice a dangerous situation, someone in distress,
or violations of this Code of Conduct, even if they seem inconsequential.
* Remember that community event venues may be shared with members of the
public; please be respectful to all patrons of these locations.
## 4. Unacceptable Behavior
The following behaviors are considered harassment and are unacceptable within
our community:
* Violence, threats of violence or violent language directed against another
person.
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory
jokes and language.
* Posting or displaying sexually explicit or violent material.
* Posting or threatening to post other people's personally identifying
information ("doxing").
* Personal insults, particularly those related to gender, sexual orientation,
race, religion, or disability.
* Inappropriate photography or recording.
* Inappropriate physical contact. You should have someone's consent before
touching them.
* Unwelcome sexual attention. This includes, sexualized comments or jokes;
inappropriate touching, groping, and unwelcomed sexual advances.
* Deliberate intimidation, stalking or following (online or in person).
* Advocating for, or encouraging, any of the above behavior.
* Sustained disruption of community events, including talks and presentations.
## 5. Weapons Policy
No weapons will be allowed at {{ packageName }} events, community spaces, or in other
spaces covered by the scope of this Code of Conduct. Weapons include but are not
limited to guns, explosives (including fireworks), and large knives such as
those used for hunting or display, as well as any other item used for the
purpose of causing injury or harm to others. Anyone seen in possession of one of
these items will be asked to leave immediately, and will only be allowed to
return without the weapon. Community members are further expected to comply with
all state and local laws on this matter.
## 6. Consequences of Unacceptable Behavior
Unacceptable behavior from any community member, including sponsors and those
with decision-making authority, will not be tolerated.
Anyone asked to stop unacceptable behavior is expected to comply immediately.
If a community member engages in unacceptable behavior, the community organizers
may take any action they deem appropriate, up to and including a temporary ban
or permanent expulsion from the community without warning (and without refund in
the case of a paid event).
## 7. Reporting Guidelines
If you are subject to or witness unacceptable behavior, or have any other
concerns, please notify a community organizer as soon as possible.
{{ codeOfConductEmail }}
{% if codeOfConductReportingUrl %}
{{ codeOfConductReportingUrl }}
{% else %}
<!-- Provide a URL or instructions for reporting code of conduct issues. -->
{% endif %}
Additionally, community organizers are available to help community members
engage with local law enforcement or to otherwise help those experiencing
unacceptable behavior feel safe. In the context of in-person events, organizers
will also provide escorts as desired by the person experiencing distress.
## 8. Addressing Grievances
If you feel you have been falsely or unfairly accused of violating this Code of
Conduct, you should notify {% if codeOfConductCommittee %}{{ codeOfConductCommittee }}{% else %}the {{ packageName }} project lead(s) <!-- Provide the name of your code of conduct committee. -->{% endif %} with
a concise description of your grievance. Your grievance will be handled in
accordance with our existing governing policies.
{% if codeOfConductPoliciesUrl %}
{{ codeOfConductPoliciesUrl }}
{% else %}
<!-- Provide a URL or details for governing polcies. -->
{% endif %}
<!--
NOTE: Every organization's governing policies should dictate how you handle
warnings and expulsions of community members. It is strongly recommended that
you mention those policies here or in Section 7 and that you include a mechanism
for addressing grievances.
-->
## 9. Scope
We expect all community participants (contributors, paid or otherwise; sponsors;
and other guests) to abide by this Code of Conduct in all community
venues--online and in-person--as well as in all one-on-one communications
pertaining to community business.
This code of conduct and its related procedures also applies to unacceptable
behavior occurring outside the scope of community activities when such behavior
has the potential to adversely affect the safety and well-being of community
members.
## 10. Contact info
{{ codeOfConductEmail }}
## 11. License and attribution
The Citizen Code of Conduct is distributed by
[Stumptown Syndicate](http://stumptownsyndicate.org) under a
[Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
Portions of text derived from the
[Django Code of Conduct](https://www.djangoproject.com/conduct/) and the
[Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
*Revision 2.3. Posted 6 March 2017.*
*Revision 2.2. Posted 4 February 2016.*
*Revision 2.1. Posted 23 June 2014.*
*Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org)
board on 10 January 2013. Posted 17 March 2013.*
================================================
FILE: resources/templates/code-of-conduct/Contributor-1.4.md.twig
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at {{ codeOfConductEmail }}. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
================================================
FILE: resources/templates/code-of-conduct/Contributor-2.0.md.twig
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
{{ codeOfConductEmail }}.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
================================================
FILE: resources/templates/code-of-conduct/Contributor-2.1.md.twig
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
{{ codeOfConductEmail }}.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
================================================
FILE: resources/templates/header/AGPL-3.0-or-later.twig
================================================
{{ packageName }} is free software: you can redistribute it
and/or modify it under the terms of the GNU Affero General Public
License as published by the Free Software Foundation, either version
3 of the License, or (at your option) any later version.
{{ packageName }} is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public
License along with {{ packageName }}.
If not, see <https://www.gnu.org/licenses/>.
@copyright {{ copyright }}
@license https://opensource.org/license/agpl-v3/ GNU Affero General Public License version 3 or later
================================================
FILE: resources/templates/header/Apache-2.0.twig
================================================
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.
@copyright {{ copyright }}
@license https://opensource.org/license/apache-2-0/ Apache License, Version 2.0
================================================
FILE: resources/templates/header/BSD-2-Clause.twig
================================================
@copyright {{ copyright }}
@license https://opensource.org/license/bsd-2-clause/ BSD 2-Clause "Simplified" License
================================================
FILE: resources/templates/header/BSD-3-Clause.twig
================================================
@copyright {{ copyright }}
@license https://opensource.org/license/bsd-3-clause/ BSD 3-Clause "New" or "Revised" License
================================================
FILE: resources/templates/header/CC0-1.0.twig
================================================
To the extent possible under law, {{ copyrightHolder }}
has waived all copyright and related or neighboring rights to
{{ packageName }}.
@license https://creativecommons.org/publicdomain/zero/1.0/ CC0 1.0 Universal
================================================
FILE: resources/templates/header/GPL-3.0-or-later.twig
================================================
{{ packageName }} is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
{{ packageName }} is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with {{ packageName }}.
If not, see <https://www.gnu.org/licenses/>.
@copyright {{ copyright }}
@license https://opensource.org/license/gpl-3-0/ GNU General Public License version 3 or later
================================================
FILE: resources/templates/header/Hippocratic-2.1.twig
================================================
@copyright {{ copyright }}
@license https://spdx.org/licenses/Hippocratic-2.1.html Hippocratic License 2.1
================================================
FILE: resources/templates/header/LGPL-3.0-or-later.twig
================================================
{{ packageName }} is free software: you can redistribute it
and/or modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation, either version
3 of the License, or (at your option) any later version.
{{ packageName }} is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with {{ packageName }}.
If not, see <https://www.gnu.org/licenses/>.
@copyright {{ copyright }}
@license https://opensource.org/license/lgpl-3-0/ GNU Lesser General Public License version 3 or later
================================================
FILE: resources/templates/header/MIT-0.twig
================================================
@copyright {{ copyright }}
@license https://opensource.org/license/mit-0/ MIT No Attribution
================================================
FILE: resources/templates/header/MIT.twig
================================================
@copyright {{ copyright }}
@license https://opensource.org/license/mit/ MIT License
================================================
FILE: resources/templates/header/MPL-2.0.twig
================================================
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at https://mozilla.org/MPL/2.0/.
@copyright {{ copyright }}
@license https://opensource.org/license/mpl-2-0/ Mozilla Public License 2.0
================================================
FILE: resources/templates/header/Proprietary.twig
================================================
@copyright {{ copyright }}. All rights reserved.
================================================
FILE: resources/templates/header/Unlicense.twig
================================================
{{ packageName }} is free and unencumbered software released
into the public domain. For more information, please view the
UNLICENSE file that was distributed with this source code.
@license https://opensource.org/license/unlicense/ The Unlicense
================================================
FILE: resources/templates/header/source-file-header.twig
================================================
{% set headerTemplate %}header/{{ license }}.twig{% endset %}
{% set copyright %}Copyright (c) {{ copyrightHolder }}{% if copyrightEmail %} <{{ copyrightEmail }}>{% elseif copyrightUrl %} <{{ copyrightUrl }}>{% endif %}{% endset %}
{% set licenseStatement %}{{ include(headerTemplate) }}{% endset %}
/**
* This file is part of {{ packageName }}
*
{{ licenseStatement|preg_replace('/^/m', ' * ')|preg_replace('/\\s+$/m', '')|trim }}
*/
================================================
FILE: resources/templates/license/AGPL-3.0-or-later-NOTICE.twig
================================================
{{ include('license/copyright-statement.twig') }}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
================================================
FILE: resources/templates/license/AGPL-3.0-or-later.twig
================================================
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
================================================
FILE: resources/templates/license/Apache-2.0-NOTICE.twig
================================================
{{ include('license/copyright-statement.twig') }}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: resources/templates/license/Apache-2.0.twig
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: resources/templates/license/BSD-2-Clause.twig
================================================
{{ include('license/copyright-statement.twig') }}
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.
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.
================================================
FILE: resources/templates/license/BSD-3-Clause.twig
================================================
{{ include('license/copyright-statement.twig') }}
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.
================================================
FILE: resources/templates/license/CC0-1.0.twig
================================================
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
================================================
FILE: resources/templates/license/GPL-3.0-or-later-NOTICE.twig
================================================
{{ include('license/copyright-statement.twig') }}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
================================================
FILE: resources/templates/license/GPL-3.0-or-later.twig
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: resources/templates/license/Hippocratic-2.1.twig
================================================
{{ include('license/copyright-statement.twig') }} (“Licensor”)
Hippocratic License Version Number: 2.1.
Purpose. The purpose of this License is for the Licensor named above to permit
the Licensee (as defined below) broad permission, if consistent with Human
Rights Laws and Human Rights Principles (as each is defined below), to use and
work with the Software (as defined below) within the full scope of Licensor’s
copyright and patent rights, if any, in the Software, while ensuring
attribution and protecting the Licensor from liability.
Permission and Conditions. The Licensor grants permission by this license
(“License”), free of charge, to the extent of Licensor’s rights under applicable
copyright and patent law, to any person or entity (the “Licensee”) obtaining a
copy of this software and associated documentation files (the “Software”), to do
everything with the Software that would otherwise infringe (i) the Licensor’s
copyright in the Software or (ii) any patent claims to the Software that the
Licensor can license or becomes able to license, subject to all of the
following terms and conditions:
* Acceptance. This License is automatically offered to every person and entity
subject to its terms and conditions. Licensee accepts this License and agrees
to its terms and conditions by taking any action with the Software that, absent
this License, would infringe any intellectual property right held by Licensor.
* Notice. Licensee must ensure that everyone who gets a copy of any part of
this Software from Licensee, with or without changes, also receives the License
and the above copyright notice (and if included by the Licensor, patent,
trademark and attribution notice). Licensee must cause any modified versions of
the Software to carry prominent notices stating that Licensee changed the
Software. For clarity, although Licensee is free to create modifications of the
Software and distribute only the modified portion created by Licensee with
additional or different terms, the portion of the Software not modified must be
distributed pursuant to this License. If anyone notifies Licensee in writing
that Licensee has not complied with this Notice section, Licensee can keep this
License by taking all practical steps to comply within 30 days after the
notice. If Licensee does not do so, Licensee’s License (and all rights licensed
hereunder) shall end immediately.
* Compliance with Human Rights Principles and Human Rights Laws.
1. Human Rights Principles.
(a) Licensee is advised to consult the articles of the United Nations
Universal Declaration of Human Rights and the United Nations Global Compact
that define recognized principles of international human rights (the “Human
Rights Principles”). Licensee shall use the Software in a manner consistent with
Human Rights Principles.
(b) Unless the Licensor and Licensee agree otherwise, any dispute,
controversy, or claim arising out of or relating to (i) Section 1(a) regarding
Human Rights Principles, including the breach of Section 1(a), termination of
this License for breach of the Human Rights Principles, or invalidity of
Section 1(a) or (ii) a determination of whether any Law is consistent or in
conflict with Human Rights Principles pursuant to Section 2, below, shall be
settled by arbitration in accordance with the Hague Rules on Business and Human
Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not
to participate in such arbitration, in which event this License (and all rights
licensed hereunder) shall end immediately. The number of arbitrators shall be
one unless the Rules require otherwise.
Unless both the Licensor and Licensee agree to the contrary: (1) All
documents and information concerning the arbitration shall be public and may be
disclosed by any party; (2) The repository referred to under Article 43 of the
Rules shall make available to the public in a timely manner all documents
concerning the arbitration which are communicated to it, including all
submissions of the parties, all evidence admitted into the record of the
proceedings, all transcripts or other recordings of hearings and all orders,
decisions and awards of the arbitral tribunal, subject only to the arbitral
tribunal's powers to take such measures as may be necessary to safeguard the
integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the
Rules; and (3) Article 26(6) of the Rules shall not apply.
2. Human Rights Laws. The Software shall not be used by any person or
entity for any systems, activities, or other uses that violate any Human Rights
Laws. “Human Rights Laws” means any applicable laws, regulations, or rules
(collectively, “Laws”) that protect human, civil, labor, privacy, political,
environmental, security, economic, due process, or similar rights; provided,
however, that such Laws are consistent and not in conflict with Human Rights
Principles (a dispute over the consistency or a conflict between Laws and Human
Rights Principles shall be determined by arbitration as stated above). Where
the Human Rights Laws of more than one jurisdiction are applicable or in
conflict with respect to the use of the Software, the Human Rights Laws that
are most protective of the individuals or groups harmed shall apply.
3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any
other contributor) against all losses, damages, liabilities, deficiencies,
claims, actions, judgments, settlements, interest, awards, penalties, fines,
costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’
fees, arising out of or relating to Licensee’s use of the Software in violation
of Human Rights Laws or Human Rights Principles.
* Failure to Comply. Any failure of Licensee to act according to the terms and
conditions of this License is both a breach of the License and an infringement
of the intellectual property rights of the Licensor (subject to exceptions
under Laws, e.g., fair use). In the event of a breach or infringement, the
terms and conditions of this License may be enforced by Licensor under the Laws
of any jurisdiction to which Licensee is subject. Licensee also agrees that the
Licensor may enforce the terms and conditions of this License against Licensee
through specific performance (or similar remedy under Laws) to the extent
permitted by Laws. For clarity, except in the event of a breach of this
License, infringement, or as otherwise stated in this License, Licensor may not
terminate this License with Licensee.
* Enforceability and Interpretation. If any term or provision of this License
is determined to be invalid, illegal, or unenforceable by a court of competent
jurisdiction, then such invalidity, illegality, or unenforceability shall not
affect any other term or provision of this License or invalidate or render
unenforceable such term or provision in any other jurisdiction; provided,
however, subject to a court modification pursuant to the immediately following
sentence, if any term or provision of this License pertaining to Human Rights
Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable
against Licensee by a court of competent jurisdiction, all rights in the
Software granted to Licensee shall be deemed null and void as between Licensor
and Licensee. Upon a determination that any term or provision is invalid,
illegal, or unenforceable, to the extent permitted by Laws, the court may
modify this License to affect the original purpose that the Software be used in
compliance with Human Rights Principles and Human Rights Laws as closely as
possible. The language in this License shall be interpreted as to its fair
meaning and not strictly for or against any party.
* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,”
WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER
CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY
ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER
ANY KIND OF LEGAL CLAIM.
This Hippocratic License is an Ethical Source license
(https://ethicalsource.dev) and is offered for use by licensors and licensees
at their own risk, on an “AS IS” basis, and with no warranties express or
implied, to the maximum extent permitted by Laws.
================================================
FILE: resources/templates/license/LGPL-3.0-or-later-NOTICE.twig
================================================
{{ include('license/copyright-statement.twig') }}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
================================================
FILE: resources/templates/license/LGPL-3.0-or-later.twig
================================================
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is
gitextract_7g50z4tk/
├── .editorconfig
├── .gitattributes.template
├── .github/
│ ├── CODEOWNERS
│ ├── ISSUE_TEMPLATE/
│ │ ├── Bug_Report.md
│ │ ├── Feature_Request.md
│ │ ├── Question.md
│ │ └── config.yml
│ ├── dependabot.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── continuous-integration.yml
│ └── merge-me.yml
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── bin/
│ └── .gitkeep
├── build/
│ ├── .gitignore
│ ├── cache/
│ │ └── .gitkeep
│ ├── coverage/
│ │ └── .gitkeep
│ └── logs/
│ └── .gitkeep
├── captainhook.json
├── codecov.yml
├── composer.json
├── conventional-commits.json
├── docs/
│ └── .gitkeep
├── phpcs.xml.dist
├── phpstan.neon.dist
├── phpunit.xml.dist
├── psalm.xml
├── resources/
│ ├── .gitkeep
│ └── templates/
│ ├── CHANGELOG.md.twig
│ ├── CONTRIBUTING.md.twig
│ ├── FUNDING.yml.twig
│ ├── code-of-conduct/
│ │ ├── Citizen-2.3.md.twig
│ │ ├── Contributor-1.4.md.twig
│ │ ├── Contributor-2.0.md.twig
│ │ └── Contributor-2.1.md.twig
│ ├── header/
│ │ ├── AGPL-3.0-or-later.twig
│ │ ├── Apache-2.0.twig
│ │ ├── BSD-2-Clause.twig
│ │ ├── BSD-3-Clause.twig
│ │ ├── CC0-1.0.twig
│ │ ├── GPL-3.0-or-later.twig
│ │ ├── Hippocratic-2.1.twig
│ │ ├── LGPL-3.0-or-later.twig
│ │ ├── MIT-0.twig
│ │ ├── MIT.twig
│ │ ├── MPL-2.0.twig
│ │ ├── Proprietary.twig
│ │ ├── Unlicense.twig
│ │ └── source-file-header.twig
│ ├── license/
│ │ ├── AGPL-3.0-or-later-NOTICE.twig
│ │ ├── AGPL-3.0-or-later.twig
│ │ ├── Apache-2.0-NOTICE.twig
│ │ ├── Apache-2.0.twig
│ │ ├── BSD-2-Clause.twig
│ │ ├── BSD-3-Clause.twig
│ │ ├── CC0-1.0.twig
│ │ ├── GPL-3.0-or-later-NOTICE.twig
│ │ ├── GPL-3.0-or-later.twig
│ │ ├── Hippocratic-2.1.twig
│ │ ├── LGPL-3.0-or-later-NOTICE.twig
│ │ ├── LGPL-3.0-or-later.twig
│ │ ├── MIT-0.twig
│ │ ├── MIT.twig
│ │ ├── MPL-2.0-NOTICE.twig
│ │ ├── MPL-2.0.twig
│ │ ├── Proprietary.twig
│ │ ├── Unlicense.twig
│ │ └── copyright-statement.twig
│ ├── readme/
│ │ ├── badges.md.twig
│ │ ├── code-of-conduct.md.twig
│ │ ├── copyright.md.twig
│ │ ├── description.md.twig
│ │ ├── security.md.twig
│ │ └── usage.md.twig
│ └── security-policy/
│ └── HackerOne.md.twig
├── src/
│ ├── Example.php
│ └── LibraryStarterKit/
│ ├── Answers.php
│ ├── Console/
│ │ ├── InstallQuestions.php
│ │ ├── Question/
│ │ │ ├── AnswersTool.php
│ │ │ ├── AuthorEmail.php
│ │ │ ├── AuthorHoldsCopyright.php
│ │ │ ├── AuthorName.php
│ │ │ ├── AuthorUrl.php
│ │ │ ├── CodeOfConduct.php
│ │ │ ├── CodeOfConductCommittee.php
│ │ │ ├── CodeOfConductEmail.php
│ │ │ ├── CodeOfConductPoliciesUrl.php
│ │ │ ├── CodeOfConductReportingUrl.php
│ │ │ ├── CopyrightEmail.php
│ │ │ ├── CopyrightHolder.php
│ │ │ ├── CopyrightUrl.php
│ │ │ ├── CopyrightYear.php
│ │ │ ├── EmailValidatorTool.php
│ │ │ ├── GithubUsername.php
│ │ │ ├── License.php
│ │ │ ├── PackageDescription.php
│ │ │ ├── PackageKeywords.php
│ │ │ ├── PackageName.php
│ │ │ ├── PackageNamespace.php
│ │ │ ├── SecurityPolicy.php
│ │ │ ├── SecurityPolicyContactEmail.php
│ │ │ ├── SecurityPolicyContactFormUrl.php
│ │ │ ├── SkippableQuestion.php
│ │ │ ├── StarterKitQuestion.php
│ │ │ ├── UrlValidatorTool.php
│ │ │ └── VendorName.php
│ │ ├── Style.php
│ │ └── StyleFactory.php
│ ├── Exception/
│ │ ├── InvalidConsoleInput.php
│ │ └── StarterKitException.php
│ ├── Filesystem.php
│ ├── Project.php
│ ├── Setup.php
│ ├── Task/
│ │ ├── Build.php
│ │ ├── Builder/
│ │ │ ├── Cleanup.php
│ │ │ ├── FixStyle.php
│ │ │ ├── InstallDependencies.php
│ │ │ ├── RenameTemplates.php
│ │ │ ├── RunTests.php
│ │ │ ├── SetupRepository.php
│ │ │ ├── UpdateChangelog.php
│ │ │ ├── UpdateCodeOfConduct.php
│ │ │ ├── UpdateComposerJson.php
│ │ │ ├── UpdateContributing.php
│ │ │ ├── UpdateFunding.php
│ │ │ ├── UpdateLicense.php
│ │ │ ├── UpdateNamespace.php
│ │ │ ├── UpdateReadme.php
│ │ │ ├── UpdateSecurityPolicy.php
│ │ │ └── UpdateSourceFileHeaders.php
│ │ └── Builder.php
│ └── Wizard.php
└── tests/
├── ExampleTest.php
├── LibraryStarterKit/
│ ├── AnswersTest.php
│ ├── Console/
│ │ ├── InstallQuestionsTest.php
│ │ ├── Question/
│ │ │ ├── AuthorEmailTest.php
│ │ │ ├── AuthorHoldsCopyrightTest.php
│ │ │ ├── AuthorNameTest.php
│ │ │ ├── AuthorUrlTest.php
│ │ │ ├── CodeOfConductCommitteeTest.php
│ │ │ ├── CodeOfConductEmailTest.php
│ │ │ ├── CodeOfConductPoliciesUrlTest.php
│ │ │ ├── CodeOfConductReportingUrlTest.php
│ │ │ ├── CodeOfConductTest.php
│ │ │ ├── CopyrightEmailTest.php
│ │ │ ├── CopyrightHolderTest.php
│ │ │ ├── CopyrightUrlTest.php
│ │ │ ├── CopyrightYearTest.php
│ │ │ ├── EmailValidatorToolTest.php
│ │ │ ├── GithubUsernameTest.php
│ │ │ ├── LicenseTest.php
│ │ │ ├── PackageDescriptionTest.php
│ │ │ ├── PackageKeywordsTest.php
│ │ │ ├── PackageNameTest.php
│ │ │ ├── PackageNamespaceTest.php
│ │ │ ├── QuestionTestCase.php
│ │ │ ├── SecurityPolicyContactEmailTest.php
│ │ │ ├── SecurityPolicyContactFormUrlTest.php
│ │ │ ├── SecurityPolicyTest.php
│ │ │ ├── UrlValidatorToolTest.php
│ │ │ └── VendorNameTest.php
│ │ └── StyleFactoryTest.php
│ ├── FilesystemTest.php
│ ├── ProjectTest.php
│ ├── SetupTest.php
│ ├── SnapshotsTool.php
│ ├── Task/
│ │ ├── BuildTest.php
│ │ ├── Builder/
│ │ │ ├── CleanupTest.php
│ │ │ ├── FixStyleTest.php
│ │ │ ├── InstallDependenciesTest.php
│ │ │ ├── RenameTemplatesTest.php
│ │ │ ├── RunTestsTest.php
│ │ │ ├── SetupRepositoryTest.php
│ │ │ ├── UpdateChangelogTest.php
│ │ │ ├── UpdateCodeOfConductTest.php
│ │ │ ├── UpdateComposerJsonTest.php
│ │ │ ├── UpdateContributingTest.php
│ │ │ ├── UpdateFundingTest.php
│ │ │ ├── UpdateLicenseTest.php
│ │ │ ├── UpdateNamespaceTest.php
│ │ │ ├── UpdateReadmeTest.php
│ │ │ ├── UpdateSecurityPolicyTest.php
│ │ │ ├── UpdateSourceFileHeadersTest.php
│ │ │ ├── __snapshots__/
│ │ │ │ ├── UpdateComposerJsonTest__testBuildWithMinimalComposerJson__1.txt
│ │ │ │ ├── UpdateComposerJsonTest__testBuild__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__0__6.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__1__6.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__1.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__2.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__3.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__4.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__5.txt
│ │ │ │ ├── UpdateNamespaceTest__testBuild_with_data_set__2__6.txt
│ │ │ │ ├── UpdateReadmeTest__testBuildWhenCodeOfConductIsNullAndSecurityPolicyIsFalse__1.txt
│ │ │ │ ├── UpdateReadmeTest__testBuildWhenCodeOfConductIsNull__1.txt
│ │ │ │ ├── UpdateReadmeTest__testBuild__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__0__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__0__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__10__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__10__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__11__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__11__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__1__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__1__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__2__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__2__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__3__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__3__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__4__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__4__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__5__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__5__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__6__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__6__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__7__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__7__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__8__1.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__8__2.txt
│ │ │ │ ├── UpdateSourceFileHeadersTest__testBuild_with_data_set__9__1.txt
│ │ │ │ └── UpdateSourceFileHeadersTest__testBuild_with_data_set__9__2.txt
│ │ │ └── fixtures/
│ │ │ ├── composer-full.json
│ │ │ ├── composer-minimal.json
│ │ │ ├── readme-full.md
│ │ │ ├── update-namespace-test.php
│ │ │ ├── update-source-file-headers-test-1.php
│ │ │ └── update-source-file-headers-test-2.php
│ │ └── BuilderTest.php
│ ├── TestCase.php
│ ├── WindowsSafeTextDriver.php
│ ├── WizardTest.php
│ └── answers-test.json
└── TestCase.php
SYMBOL INDEX (539 symbols across 116 files)
FILE: src/Example.php
class Example (line 17) | class Example
method greet (line 22) | public function greet(string $name = 'World'): string
FILE: src/LibraryStarterKit/Answers.php
class Answers (line 32) | final class Answers
method __construct (line 63) | public function __construct(
method getTokens (line 75) | public function getTokens(): array
method getValues (line 85) | public function getValues(): array
method getArrayCopy (line 95) | public function getArrayCopy(): array
method saveToFile (line 112) | public function saveToFile(): void
method loadFile (line 127) | private function loadFile(): void
FILE: src/LibraryStarterKit/Console/InstallQuestions.php
class InstallQuestions (line 44) | class InstallQuestions
method getQuestions (line 49) | public function getQuestions(Answers $answers): array
FILE: src/LibraryStarterKit/Console/Question/AnswersTool.php
type AnswersTool (line 16) | trait AnswersTool
method getAnswers (line 20) | public function getAnswers(): Answers
FILE: src/LibraryStarterKit/Console/Question/AuthorEmail.php
class AuthorEmail (line 20) | class AuthorEmail extends Question implements StarterKitQuestion
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/AuthorHoldsCopyright.php
class AuthorHoldsCopyright (line 20) | class AuthorHoldsCopyright extends ConfirmationQuestion implements Start...
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/AuthorName.php
class AuthorName (line 20) | class AuthorName extends Question implements StarterKitQuestion
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/AuthorUrl.php
class AuthorUrl (line 20) | class AuthorUrl extends Question implements StarterKitQuestion
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/CodeOfConduct.php
class CodeOfConduct (line 28) | class CodeOfConduct extends ChoiceQuestion implements StarterKitQuestion
method getName (line 50) | public function getName(): string
method __construct (line 55) | public function __construct(Answers $answers)
method getNormalizer (line 69) | public function getNormalizer(): callable
method getValidator (line 85) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/CodeOfConductCommittee.php
class CodeOfConductCommittee (line 20) | class CodeOfConductCommittee extends Question implements SkippableQuesti...
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
method getValidator (line 42) | public function getValidator(): callable
method shouldSkip (line 47) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CodeOfConductEmail.php
class CodeOfConductEmail (line 20) | class CodeOfConductEmail extends Question implements SkippableQuestion, ...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method shouldSkip (line 40) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CodeOfConductPoliciesUrl.php
class CodeOfConductPoliciesUrl (line 20) | class CodeOfConductPoliciesUrl extends Question implements SkippableQues...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method shouldSkip (line 40) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CodeOfConductReportingUrl.php
class CodeOfConductReportingUrl (line 20) | class CodeOfConductReportingUrl extends Question implements SkippableQue...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method shouldSkip (line 40) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CopyrightEmail.php
class CopyrightEmail (line 20) | class CopyrightEmail extends Question implements SkippableQuestion, Star...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method getDefault (line 37) | public function getDefault(): float | bool | int | string | null
method shouldSkip (line 42) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CopyrightHolder.php
class CopyrightHolder (line 20) | class CopyrightHolder extends Question implements SkippableQuestion, Sta...
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
method getDefault (line 36) | public function getDefault(): float | bool | int | string | null
method shouldSkip (line 41) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CopyrightUrl.php
class CopyrightUrl (line 20) | class CopyrightUrl extends Question implements SkippableQuestion, Starte...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method getDefault (line 37) | public function getDefault(): float | bool | int | string | null
method shouldSkip (line 42) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/CopyrightYear.php
class CopyrightYear (line 25) | class CopyrightYear extends Question implements StarterKitQuestion
method getName (line 31) | public function getName(): string
method __construct (line 36) | public function __construct(Answers $answers)
method getDefault (line 43) | public function getDefault(): float | bool | int | string | null
method getValidator (line 51) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/EmailValidatorTool.php
type EmailValidatorTool (line 24) | trait EmailValidatorTool
method getValidator (line 31) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/GithubUsername.php
class GithubUsername (line 20) | class GithubUsername extends Question implements StarterKitQuestion
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/License.php
class License (line 28) | class License extends ChoiceQuestion implements StarterKitQuestion
method getName (line 66) | public function getName(): string
method __construct (line 71) | public function __construct(Answers $answers)
method getNormalizer (line 85) | public function getNormalizer(): callable
method getValidator (line 101) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/PackageDescription.php
class PackageDescription (line 20) | class PackageDescription extends Question implements StarterKitQuestion
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
method getValidator (line 42) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/PackageKeywords.php
class PackageKeywords (line 27) | class PackageKeywords extends Question implements StarterKitQuestion
method getName (line 31) | public function getName(): string
method __construct (line 36) | public function __construct(Answers $answers)
method getNormalizer (line 49) | public function getNormalizer(): callable
FILE: src/LibraryStarterKit/Console/Question/PackageName.php
class PackageName (line 26) | class PackageName extends Question implements StarterKitQuestion
method getName (line 32) | public function getName(): string
method __construct (line 37) | public function __construct(Answers $answers)
method getDefault (line 44) | public function getDefault(): float | bool | int | string | null
method getValidator (line 61) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/PackageNamespace.php
class PackageNamespace (line 31) | class PackageNamespace extends Question implements StarterKitQuestion
method getName (line 37) | public function getName(): string
method __construct (line 42) | public function __construct(Answers $answers)
method getQuestion (line 49) | public function getQuestion(): string
method getDefault (line 60) | public function getDefault(): float | bool | int | string | null
method getValidator (line 81) | public function getValidator(): callable
method namify (line 98) | private function namify(): callable
FILE: src/LibraryStarterKit/Console/Question/SecurityPolicy.php
class SecurityPolicy (line 20) | class SecurityPolicy extends ConfirmationQuestion implements StarterKitQ...
method getName (line 24) | public function getName(): string
method __construct (line 29) | public function __construct(Answers $answers)
FILE: src/LibraryStarterKit/Console/Question/SecurityPolicyContactEmail.php
class SecurityPolicyContactEmail (line 20) | class SecurityPolicyContactEmail extends Question implements SkippableQu...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method shouldSkip (line 40) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/SecurityPolicyContactFormUrl.php
class SecurityPolicyContactFormUrl (line 20) | class SecurityPolicyContactFormUrl extends Question implements Skippable...
method getName (line 25) | public function getName(): string
method __construct (line 30) | public function __construct(Answers $answers)
method shouldSkip (line 40) | public function shouldSkip(): bool
FILE: src/LibraryStarterKit/Console/Question/SkippableQuestion.php
type SkippableQuestion (line 14) | interface SkippableQuestion
method shouldSkip (line 16) | public function shouldSkip(): bool;
FILE: src/LibraryStarterKit/Console/Question/StarterKitQuestion.php
type StarterKitQuestion (line 16) | interface StarterKitQuestion
method getAnswers (line 18) | public function getAnswers(): Answers;
method getName (line 20) | public function getName(): string;
FILE: src/LibraryStarterKit/Console/Question/UrlValidatorTool.php
type UrlValidatorTool (line 25) | trait UrlValidatorTool
method getValidator (line 32) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Question/VendorName.php
class VendorName (line 24) | class VendorName extends Question implements StarterKitQuestion
method getName (line 30) | public function getName(): string
method __construct (line 35) | public function __construct(Answers $answers)
method getDefault (line 42) | public function getDefault(): float | bool | int | string | null
method getValidator (line 47) | public function getValidator(): callable
FILE: src/LibraryStarterKit/Console/Style.php
class Style (line 16) | class Style extends SymfonyStyle
FILE: src/LibraryStarterKit/Console/StyleFactory.php
class StyleFactory (line 20) | class StyleFactory
method factory (line 22) | public function factory(InputInterface $input, OutputInterface $output...
FILE: src/LibraryStarterKit/Exception/InvalidConsoleInput.php
class InvalidConsoleInput (line 16) | class InvalidConsoleInput extends RuntimeException implements StarterKit...
FILE: src/LibraryStarterKit/Exception/StarterKitException.php
type StarterKitException (line 16) | interface StarterKitException extends PhpThrowable
FILE: src/LibraryStarterKit/Filesystem.php
class Filesystem (line 20) | class Filesystem extends SymfonyFilesystem
method getFile (line 25) | public function getFile(string $path): SplFileInfo
FILE: src/LibraryStarterKit/Project.php
class Project (line 14) | class Project
method __construct (line 16) | public function __construct(
method getName (line 22) | public function getName(): string
method getPath (line 27) | public function getPath(): string
FILE: src/LibraryStarterKit/Setup.php
class Setup (line 28) | class Setup
method __construct (line 33) | public function __construct(
method getAppPath (line 45) | public function getAppPath(): string
method getEvent (line 53) | public function getEvent(): Event
method getFilesystem (line 61) | public function getFilesystem(): Filesystem
method getFinder (line 69) | public function getFinder(): Finder
method getProjectName (line 77) | public function getProjectName(): string
method getProject (line 85) | public function getProject(): Project
method getVerbosity (line 95) | public function getVerbosity(): int
method getProcess (line 105) | public function getProcess(array $command): Process
method path (line 113) | public function path(string $fileName): string
method getBuild (line 121) | public function getBuild(SymfonyStyle $console, Answers $answers): Build
method getTwigEnvironment (line 133) | public function getTwigEnvironment(): TwigEnvironment
method run (line 160) | public function run(SymfonyStyle $console, Answers $answers): void
FILE: src/LibraryStarterKit/Task/Build.php
class Build (line 37) | class Build
method __construct (line 39) | public function __construct(
method getAnswers (line 46) | public function getAnswers(): Answers
method getConsole (line 51) | public function getConsole(): SymfonyStyle
method getSetup (line 56) | public function getSetup(): Setup
method run (line 64) | public function run(): void
method getBuilders (line 76) | public function getBuilders(): array
FILE: src/LibraryStarterKit/Task/Builder.php
class Builder (line 21) | abstract class Builder
method __construct (line 23) | public function __construct(private readonly Build $buildTask)
method build (line 30) | abstract public function build(): void;
method getAnswers (line 32) | public function getAnswers(): Answers
method getEnvironment (line 37) | public function getEnvironment(): Setup
method getConsole (line 42) | public function getConsole(): SymfonyStyle
method streamProcessOutput (line 52) | public function streamProcessOutput(): callable
FILE: src/LibraryStarterKit/Task/Builder/Cleanup.php
class Cleanup (line 23) | class Cleanup extends Builder
method build (line 36) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/FixStyle.php
class FixStyle (line 19) | class FixStyle extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/InstallDependencies.php
class InstallDependencies (line 19) | class InstallDependencies extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/RenameTemplates.php
class RenameTemplates (line 27) | class RenameTemplates extends Builder
method build (line 29) | public function build(): void
method getTemplatesFinder (line 38) | private function getTemplatesFinder(): Finder
method removeTemplateExtension (line 55) | private function removeTemplateExtension(SplFileInfo $file): void
FILE: src/LibraryStarterKit/Task/Builder/RunTests.php
class RunTests (line 19) | class RunTests extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/SetupRepository.php
class SetupRepository (line 23) | class SetupRepository extends Builder
method build (line 28) | public function build(): void
method getDefaultBranch (line 42) | private function getDefaultBranch(): string
method getUserName (line 55) | private function getUserName(): string
method getUserEmail (line 66) | private function getUserEmail(): string
method initializeRepository (line 77) | private function initializeRepository(): self
method installHooks (line 91) | private function installHooks(): self
method cleanBuildDir (line 103) | private function cleanBuildDir(): self
method gitAddAllFiles (line 113) | private function gitAddAllFiles(): self
method gitInitialCommit (line 123) | private function gitInitialCommit(): self
method setGitBranchName (line 139) | private function setGitBranchName(): self
method gitConfigUser (line 149) | private function gitConfigUser(): self
FILE: src/LibraryStarterKit/Task/Builder/UpdateChangelog.php
class UpdateChangelog (line 19) | class UpdateChangelog extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateCodeOfConduct.php
class UpdateCodeOfConduct (line 22) | class UpdateCodeOfConduct extends Builder
method build (line 24) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateComposerJson.php
class UpdateComposerJson (line 35) | class UpdateComposerJson extends Builder
method build (line 55) | public function build(): void
method filterPropertiesByAllowlist (line 95) | private function filterPropertiesByAllowlist(array $data, array $allow...
method getComposerContents (line 100) | private function getComposerContents(): string
method buildAuthors (line 127) | private function buildAuthors(array &$composer): void
method buildRequire (line 146) | private function buildRequire(array &$composer): void
method buildRequireDev (line 161) | private function buildRequireDev(array &$composer): void
method buildAutoload (line 176) | private function buildAutoload(array &$composer): void
method buildAutoloadDev (line 191) | private function buildAutoloadDev(array &$composer): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateContributing.php
class UpdateContributing (line 19) | class UpdateContributing extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateFunding.php
class UpdateFunding (line 19) | class UpdateFunding extends Builder
method build (line 21) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateLicense.php
class UpdateLicense (line 23) | class UpdateLicense extends Builder
method build (line 25) | public function build(): void
method hasNoticeFile (line 41) | private function hasNoticeFile(string $license): bool
method getLicenseFilename (line 55) | private function getLicenseFilename(string $license): string
method handleLicenseFile (line 72) | private function handleLicenseFile(string $license): void
method handleNoticeFile (line 89) | private function handleNoticeFile(string $license): void
method includeGplWithLesserGpl (line 102) | private function includeGplWithLesserGpl(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateNamespace.php
class UpdateNamespace (line 29) | class UpdateNamespace extends Builder
method build (line 31) | public function build(): void
method getSourceFiles (line 62) | private function getSourceFiles(): array
method replaceNamespace (line 99) | private function replaceNamespace(SplFileInfo $file, array $replacemen...
FILE: src/LibraryStarterKit/Task/Builder/UpdateReadme.php
class UpdateReadme (line 25) | class UpdateReadme extends Builder
method build (line 27) | public function build(): void
method getReadmeContents (line 62) | private function getReadmeContents(): string
method getBadges (line 86) | private function getBadges(): string
method getDescription (line 94) | private function getDescription(): string
method getCodeOfConduct (line 102) | private function getCodeOfConduct(): string
method getUsage (line 114) | private function getUsage(): string
method getCopyright (line 122) | private function getCopyright(): string
method getSecurityStatement (line 130) | private function getSecurityStatement(): string
FILE: src/LibraryStarterKit/Task/Builder/UpdateSecurityPolicy.php
class UpdateSecurityPolicy (line 21) | class UpdateSecurityPolicy extends Builder
method build (line 23) | public function build(): void
FILE: src/LibraryStarterKit/Task/Builder/UpdateSourceFileHeaders.php
class UpdateSourceFileHeaders (line 27) | class UpdateSourceFileHeaders extends Builder
method build (line 31) | public function build(): void
method getSourceFilesFinder (line 49) | private function getSourceFilesFinder(): Finder
method replaceSourceFileHeader (line 64) | private function replaceSourceFileHeader(SplFileInfo $file, string $ne...
FILE: src/LibraryStarterKit/Wizard.php
class Wizard (line 39) | class Wizard extends Command
method __construct (line 47) | public function __construct(
method getSetup (line 71) | public function getSetup(): Setup
method getAnswersFile (line 76) | public function getAnswersFile(): string
method execute (line 82) | protected function execute(InputInterface $input, OutputInterface $out...
method getGitUserName (line 129) | private function getGitUserName(): ?string
method getGitUserEmail (line 140) | private function getGitUserEmail(): ?string
method confirmStart (line 151) | private function confirmStart(SymfonyStyle $console): bool
method askQuestions (line 167) | private function askQuestions(SymfonyStyle $console): void
method exitEarly (line 183) | private function exitEarly(SymfonyStyle $console): void
method registerInterruptHandler (line 203) | private function registerInterruptHandler(SymfonyStyle $console): void
method handleException (line 220) | private function handleException(Throwable $throwable, SymfonyStyle $c...
method newApplication (line 244) | public static function newApplication(): Application
method start (line 249) | public static function start(Event $event): void
method determineVerbosityLevel (line 274) | public static function determineVerbosityLevel(Event $event): int
FILE: tests/ExampleTest.php
class ExampleTest (line 9) | class ExampleTest extends TestCase
method testGreet (line 11) | public function testGreet(): void
FILE: tests/LibraryStarterKit/AnswersTest.php
class AnswersTest (line 13) | class AnswersTest extends TestCase
method setUp (line 17) | protected function setUp(): void
method testGetTokens (line 24) | public function testGetTokens(): void
method testGetValues (line 62) | public function testGetValues(): void
method testGetArrayCopy (line 100) | public function testGetArrayCopy(): void
method testLoadsExistingFileUponInstantiation (line 138) | public function testLoadsExistingFileUponInstantiation(): void
method testSaveToFile (line 175) | public function testSaveToFile(): void
FILE: tests/LibraryStarterKit/Console/InstallQuestionsTest.php
class InstallQuestionsTest (line 12) | class InstallQuestionsTest extends TestCase
method testGetQuestions (line 14) | public function testGetQuestions(): void
FILE: tests/LibraryStarterKit/Console/Question/AuthorEmailTest.php
class AuthorEmailTest (line 9) | class AuthorEmailTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
FILE: tests/LibraryStarterKit/Console/Question/AuthorHoldsCopyrightTest.php
class AuthorHoldsCopyrightTest (line 9) | class AuthorHoldsCopyrightTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
method getQuestionDefault (line 26) | protected function getQuestionDefault(): bool
method testGetDefaultWhenAnswerAlreadySet (line 31) | public function testGetDefaultWhenAnswerAlreadySet(): void
FILE: tests/LibraryStarterKit/Console/Question/AuthorNameTest.php
class AuthorNameTest (line 9) | class AuthorNameTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
FILE: tests/LibraryStarterKit/Console/Question/AuthorUrlTest.php
class AuthorUrlTest (line 9) | class AuthorUrlTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
FILE: tests/LibraryStarterKit/Console/Question/CodeOfConductCommitteeTest.php
class CodeOfConductCommitteeTest (line 10) | class CodeOfConductCommitteeTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testValidator (line 27) | public function testValidator(): void
method testShouldSkip (line 35) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 48) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CodeOfConductEmailTest.php
class CodeOfConductEmailTest (line 10) | class CodeOfConductEmailTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testShouldSkip (line 27) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 40) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CodeOfConductPoliciesUrlTest.php
class CodeOfConductPoliciesUrlTest (line 10) | class CodeOfConductPoliciesUrlTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testShouldSkip (line 27) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 40) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CodeOfConductReportingUrlTest.php
class CodeOfConductReportingUrlTest (line 10) | class CodeOfConductReportingUrlTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testShouldSkip (line 27) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 40) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CodeOfConductTest.php
class CodeOfConductTest (line 11) | class CodeOfConductTest extends QuestionTestCase
method getTestClass (line 13) | protected function getTestClass(): string
method getQuestionName (line 18) | protected function getQuestionName(): string
method getQuestionText (line 23) | protected function getQuestionText(): string
method getQuestionDefault (line 28) | protected function getQuestionDefault(): int
method testGetDefaultWhenAnswerAlreadySet (line 33) | public function testGetDefaultWhenAnswerAlreadySet(): void
method testGetChoices (line 42) | public function testGetChoices(): void
method testNormalizer (line 58) | #[DataProvider('provideNormalizerTestValues')]
method provideNormalizerTestValues (line 69) | public static function provideNormalizerTestValues(): array
method testValidator (line 88) | #[DataProvider('provideValidValues')]
method provideValidValues (line 99) | public static function provideValidValues(): array
method testValidatorThrowsExceptionForInvalidValues (line 125) | #[DataProvider('provideInvalidValues')]
method provideInvalidValues (line 139) | public static function provideInvalidValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CopyrightEmailTest.php
class CopyrightEmailTest (line 10) | class CopyrightEmailTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testGetDefaultWhenAuthorEmailIsSet (line 27) | public function testGetDefaultWhenAuthorEmailIsSet(): void
method testShouldSkip (line 36) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 49) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CopyrightHolderTest.php
class CopyrightHolderTest (line 10) | class CopyrightHolderTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testGetDefaultWhenAuthorNameIsSet (line 27) | public function testGetDefaultWhenAuthorNameIsSet(): void
method testShouldSkip (line 36) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 49) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CopyrightUrlTest.php
class CopyrightUrlTest (line 10) | class CopyrightUrlTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testGetDefaultWhenAuthorNameIsSet (line 27) | public function testGetDefaultWhenAuthorNameIsSet(): void
method testShouldSkip (line 36) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 49) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/CopyrightYearTest.php
class CopyrightYearTest (line 13) | class CopyrightYearTest extends QuestionTestCase
method getTestClass (line 15) | protected function getTestClass(): string
method getQuestionName (line 20) | protected function getQuestionName(): string
method getQuestionText (line 25) | protected function getQuestionText(): string
method testGetDefault (line 30) | public function testGetDefault(): void
method testValidatorReturnsValidValue (line 38) | public function testValidatorReturnsValidValue(): void
method testValidatorThrowsExceptionForInvalidValue (line 45) | #[DataProvider('provideInvalidDateValues')]
method provideInvalidDateValues (line 59) | public static function provideInvalidDateValues(): array
FILE: tests/LibraryStarterKit/Console/Question/EmailValidatorToolTest.php
class EmailValidatorToolTest (line 12) | class EmailValidatorToolTest extends TestCase
method testValidatorThrowsExceptionForEmptyValuesWhenQuestionIsNotOptional (line 14) | #[DataProvider('provideNullableValues')]
method testValidatorReturnsNullWhenQuestionIsOptional (line 34) | #[DataProvider('provideNullableValues')]
method provideNullableValues (line 49) | public static function provideNullableValues(): array
method testValidatorReturnsValueWhenValid (line 58) | public function testValidatorReturnsValueWhenValid(): void
method testValidatorThrowsExceptionWhenNotValid (line 69) | public function testValidatorThrowsExceptionWhenNotValid(): void
FILE: tests/LibraryStarterKit/Console/Question/GithubUsernameTest.php
class GithubUsernameTest (line 9) | class GithubUsernameTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
FILE: tests/LibraryStarterKit/Console/Question/LicenseTest.php
class LicenseTest (line 13) | class LicenseTest extends QuestionTestCase
method getTestClass (line 15) | protected function getTestClass(): string
method getQuestionName (line 20) | protected function getQuestionName(): string
method getQuestionText (line 25) | protected function getQuestionText(): string
method getQuestionDefault (line 30) | protected function getQuestionDefault(): int
method testGetDefaultWhenAnswerAlreadySet (line 35) | public function testGetDefaultWhenAnswerAlreadySet(): void
method testGetChoices (line 44) | public function testGetChoices(): void
method testNormalizer (line 68) | #[DataProvider('provideNormalizerTestValues')]
method provideNormalizerTestValues (line 79) | public static function provideNormalizerTestValues(): array
method testValidator (line 114) | #[DataProvider('provideValidValues')]
method provideValidValues (line 125) | public static function provideValidValues(): array
method testValidatorThrowsExceptionForInvalidValues (line 130) | #[DataProvider('provideInvalidValues')]
method provideInvalidValues (line 144) | public static function provideInvalidValues(): array
FILE: tests/LibraryStarterKit/Console/Question/PackageDescriptionTest.php
class PackageDescriptionTest (line 9) | class PackageDescriptionTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
method testValidator (line 26) | public function testValidator(): void
FILE: tests/LibraryStarterKit/Console/Question/PackageKeywordsTest.php
class PackageKeywordsTest (line 10) | class PackageKeywordsTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testGetDefaultWhenAnswerAlreadySet (line 27) | public function testGetDefaultWhenAnswerAlreadySet(): void
method testNormalizer (line 39) | #[DataProvider('provideNormalizerTestValues')]
method provideNormalizerTestValues (line 50) | public static function provideNormalizerTestValues(): array
FILE: tests/LibraryStarterKit/Console/Question/PackageNameTest.php
class PackageNameTest (line 11) | class PackageNameTest extends QuestionTestCase
method getTestClass (line 13) | protected function getTestClass(): string
method getQuestionName (line 18) | protected function getQuestionName(): string
method getQuestionText (line 23) | protected function getQuestionText(): string
method testDefaultWithVendorAndProjectNames (line 28) | public function testDefaultWithVendorAndProjectNames(): void
method testValidator (line 38) | public function testValidator(): void
method testValidatorWithVendorPrefix (line 45) | public function testValidatorWithVendorPrefix(): void
method testValidatorWithoutVendorPrefix (line 54) | public function testValidatorWithoutVendorPrefix(): void
method testValidatorThrowsExceptionForInvalidPackageNames (line 63) | #[DataProvider('provideInvalidPackageNames')]
method provideInvalidPackageNames (line 79) | public static function provideInvalidPackageNames(): array
FILE: tests/LibraryStarterKit/Console/Question/PackageNamespaceTest.php
class PackageNamespaceTest (line 10) | class PackageNamespaceTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testDefaultWithEmptyPackageName (line 27) | public function testDefaultWithEmptyPackageName(): void
method testDefaultWithPackageName (line 36) | public function testDefaultWithPackageName(): void
method testDefaultWithOddlyNamedPackageName (line 46) | public function testDefaultWithOddlyNamedPackageName(): void
method testValidator (line 56) | public function testValidator(): void
method testValidatorThrowsExceptionForInvalidNamespaceName (line 63) | public function testValidatorThrowsExceptionForInvalidNamespaceName():...
FILE: tests/LibraryStarterKit/Console/Question/QuestionTestCase.php
class QuestionTestCase (line 11) | abstract class QuestionTestCase extends TestCase
method getTestClass (line 16) | abstract protected function getTestClass(): string;
method getQuestionName (line 18) | abstract protected function getQuestionName(): string;
method getQuestionText (line 20) | abstract protected function getQuestionText(): string;
method getQuestionDefault (line 22) | protected function getQuestionDefault(): mixed
method testGetName (line 27) | public function testGetName(): void
method testGetQuestion (line 37) | public function testGetQuestion(): void
method testGetAnswers (line 47) | public function testGetAnswers(): void
method testGetDefault (line 57) | public function testGetDefault(): void
method testGetDefaultWhenAnswerAlreadySet (line 67) | public function testGetDefaultWhenAnswerAlreadySet(): void
FILE: tests/LibraryStarterKit/Console/Question/SecurityPolicyContactEmailTest.php
class SecurityPolicyContactEmailTest (line 10) | class SecurityPolicyContactEmailTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testShouldSkip (line 27) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 40) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/SecurityPolicyContactFormUrlTest.php
class SecurityPolicyContactFormUrlTest (line 10) | class SecurityPolicyContactFormUrlTest extends QuestionTestCase
method getTestClass (line 12) | protected function getTestClass(): string
method getQuestionName (line 17) | protected function getQuestionName(): string
method getQuestionText (line 22) | protected function getQuestionText(): string
method testShouldSkip (line 27) | #[DataProvider('provideSkipValues')]
method provideSkipValues (line 40) | public static function provideSkipValues(): array
FILE: tests/LibraryStarterKit/Console/Question/SecurityPolicyTest.php
class SecurityPolicyTest (line 9) | class SecurityPolicyTest extends QuestionTestCase
method getTestClass (line 11) | protected function getTestClass(): string
method getQuestionName (line 16) | protected function getQuestionName(): string
method getQuestionText (line 21) | protected function getQuestionText(): string
method getQuestionDefault (line 26) | protected function getQuestionDefault(): bool
method testGetDefaultWhenAnswerAlreadySet (line 31) | public function testGetDefaultWhenAnswerAlreadySet(): void
FILE: tests/LibraryStarterKit/Console/Question/UrlValidatorToolTest.php
class UrlValidatorToolTest (line 12) | class UrlValidatorToolTest extends TestCase
method testValidatorThrowsExceptionForEmptyValuesWhenQuestionIsNotOptional (line 14) | #[DataProvider('provideNullableValues')]
method testValidatorReturnsNullWhenQuestionIsOptional (line 34) | #[DataProvider('provideNullableValues')]
method provideNullableValues (line 49) | public static function provideNullableValues(): array
method testValidatorReturnsValueWhenValid (line 58) | public function testValidatorReturnsValueWhenValid(): void
method testValidatorThrowsExceptionWhenNotValid (line 69) | public function testValidatorThrowsExceptionWhenNotValid(): void
FILE: tests/LibraryStarterKit/Console/Question/VendorNameTest.php
class VendorNameTest (line 11) | class VendorNameTest extends QuestionTestCase
method getTestClass (line 13) | protected function getTestClass(): string
method getQuestionName (line 18) | protected function getQuestionName(): string
method getQuestionText (line 23) | protected function getQuestionText(): string
method testGetDefaultWhenGitHubNameProvided (line 28) | public function testGetDefaultWhenGitHubNameProvided(): void
method testValidatorReturnsValidValue (line 37) | public function testValidatorReturnsValidValue(): void
method testValidatorThrowsExceptionForInvalidValue (line 44) | #[DataProvider('provideInvalidValues')]
method provideInvalidValues (line 58) | public static function provideInvalidValues(): array
FILE: tests/LibraryStarterKit/Console/StyleFactoryTest.php
class StyleFactoryTest (line 13) | class StyleFactoryTest extends TestCase
method testFactory (line 15) | public function testFactory(): void
FILE: tests/LibraryStarterKit/FilesystemTest.php
class FilesystemTest (line 10) | class FilesystemTest extends TestCase
method testGetFile (line 12) | public function testGetFile(): void
FILE: tests/LibraryStarterKit/ProjectTest.php
class ProjectTest (line 9) | class ProjectTest extends TestCase
method testProject (line 11) | public function testProject(): void
FILE: tests/LibraryStarterKit/SetupTest.php
class SetupTest (line 24) | class SetupTest extends TestCase
method setUp (line 29) | public function setUp(): void
method testGetAppPath (line 58) | public function testGetAppPath(): void
method testGetEvent (line 63) | public function testGetEvent(): void
method testGetFilesystem (line 69) | public function testGetFilesystem(): void
method testGetFinder (line 75) | public function testGetFinder(): void
method testGetProjectName (line 81) | public function testGetProjectName(): void
method testGetVerbosity (line 86) | public function testGetVerbosity(): void
method testGetBuild (line 91) | public function testGetBuild(): void
method testGetTwigEnvironment (line 103) | public function testGetTwigEnvironment(): void
method testRun (line 109) | public function testRun(): void
method testGetProcessForCommand (line 126) | public function testGetProcessForCommand(): void
method testPath (line 134) | public function testPath(): void
FILE: tests/LibraryStarterKit/SnapshotsTool.php
type SnapshotsTool (line 12) | trait SnapshotsTool
method getSnapshotId (line 16) | protected function getSnapshotId(): string
FILE: tests/LibraryStarterKit/Task/BuildTest.php
class BuildTest (line 14) | class BuildTest extends TestCase
method testGetAnswers (line 16) | public function testGetAnswers(): void
method testGetSetup (line 29) | public function testGetSetup(): void
method testGetConsole (line 42) | public function testGetConsole(): void
method testGetBuilders (line 55) | public function testGetBuilders(): void
method testRun (line 71) | public function testRun(): void
FILE: tests/LibraryStarterKit/Task/Builder/CleanupTest.php
class CleanupTest (line 17) | class CleanupTest extends TestCase
method testBuild (line 19) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/FixStyleTest.php
class FixStyleTest (line 16) | class FixStyleTest extends TestCase
method testBuild (line 18) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/InstallDependenciesTest.php
class InstallDependenciesTest (line 19) | class InstallDependenciesTest extends TestCase
method testBuild (line 21) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/RenameTemplatesTest.php
class RenameTemplatesTest (line 22) | class RenameTemplatesTest extends TestCase
method testBuild (line 24) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/RunTestsTest.php
class RunTestsTest (line 16) | class RunTestsTest extends TestCase
method testBuild (line 18) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/SetupRepositoryTest.php
class SetupRepositoryTest (line 20) | class SetupRepositoryTest extends TestCase
method buildProvider (line 34) | public static function buildProvider(): array
method testBuild (line 90) | #[DataProvider('buildProvider')]
FILE: tests/LibraryStarterKit/Task/Builder/UpdateChangelogTest.php
class UpdateChangelogTest (line 16) | class UpdateChangelogTest extends TestCase
method testBuild (line 18) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/UpdateCodeOfConductTest.php
class UpdateCodeOfConductTest (line 18) | class UpdateCodeOfConductTest extends TestCase
method testBuild (line 20) | public function testBuild(): void
method testBuildRemovesCodeOfConductFile (line 73) | public function testBuildRemovesCodeOfConductFile(): void
FILE: tests/LibraryStarterKit/Task/Builder/UpdateComposerJsonTest.php
class UpdateComposerJsonTest (line 23) | class UpdateComposerJsonTest extends TestCase
method testBuild (line 27) | public function testBuild(): void
method testBuildThrowsExceptionWhenComposerContentsContainInvalidJson (line 86) | public function testBuildThrowsExceptionWhenComposerContentsContainInv...
method testBuildThrowsExceptionWhenComposerJsonCannotBeFound (line 122) | public function testBuildThrowsExceptionWhenComposerJsonCannotBeFound(...
method testBuildWithMinimalComposerJson (line 154) | public function testBuildWithMinimalComposerJson(): void
method composerContentsOriginal (line 209) | private function composerContentsOriginal(): string
method composerContentsOriginalMinimal (line 214) | private function composerContentsOriginalMinimal(): string
FILE: tests/LibraryStarterKit/Task/Builder/UpdateContributingTest.php
class UpdateContributingTest (line 16) | class UpdateContributingTest extends TestCase
method testBuild (line 18) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/UpdateFundingTest.php
class UpdateFundingTest (line 16) | class UpdateFundingTest extends TestCase
method testBuild (line 18) | public function testBuild(): void
FILE: tests/LibraryStarterKit/Task/Builder/UpdateLicenseTest.php
class UpdateLicenseTest (line 21) | class UpdateLicenseTest extends TestCase
method testBuild (line 23) | #[DataProvider('provideLicensesForTesting')]
method provideLicensesForTesting (line 80) | public static function provideLicensesForTesting(): array
FILE: tests/LibraryStarterKit/Task/Builder/UpdateNamespaceTest.php
class UpdateNamespaceTest (line 23) | class UpdateNamespaceTest extends TestCase
method testBuild (line 27) | #[DataProvider('provideNamespaceTestValues')]
method provideNamespaceTestValues (line 117) | public static function provideNamespaceTestValues(): array
method getFileContents (line 138) | private function getFileContents(): string
FILE: tests/LibraryStarterKit/Task/Builder/UpdateReadmeTest.php
class UpdateReadmeTest (line 25) | class UpdateReadmeTest extends TestCase
method testBuild (line 29) | public function testBuild(): void
method testBuildWhenCodeOfConductIsNullAndSecurityPolicyIsFalse (line 117) | public function testBuildWhenCodeOfConductIsNullAndSecurityPolicyIsFal...
method testBuildThrowsExceptionWhenReadmeCannotBeFound (line 206) | public function testBuildThrowsExceptionWhenReadmeCannotBeFound(): void
method readmeContentsOriginal (line 239) | private function readmeContentsOriginal(): string
FILE: tests/LibraryStarterKit/Task/Builder/UpdateSecurityPolicyTest.php
class UpdateSecurityPolicyTest (line 18) | class UpdateSecurityPolicyTest extends TestCase
method testBuild (line 20) | public function testBuild(): void
method testBuildRemovesSecurityPolicyFile (line 71) | public function testBuildRemovesSecurityPolicyFile(): void
FILE: tests/LibraryStarterKit/Task/Builder/UpdateSourceFileHeadersTest.php
class UpdateSourceFileHeadersTest (line 26) | class UpdateSourceFileHeadersTest extends TestCase
method testBuild (line 30) | #[DataProvider('licenseProvider')]
method licenseProvider (line 111) | public static function licenseProvider(): array
method getFile1OriginalContents (line 140) | private function getFile1OriginalContents(): string
method getFile2OriginalContents (line 145) | private function getFile2OriginalContents(): string
FILE: tests/LibraryStarterKit/Task/Builder/fixtures/update-namespace-test.php
class Foo (line 15) | class Foo
FILE: tests/LibraryStarterKit/Task/Builder/fixtures/update-source-file-headers-test-1.php
class Bar (line 18) | class Bar
FILE: tests/LibraryStarterKit/Task/Builder/fixtures/update-source-file-headers-test-2.php
class Baz (line 19) | class Baz
method __construct (line 24) | public function __construct()
FILE: tests/LibraryStarterKit/Task/BuilderTest.php
class BuilderTest (line 14) | class BuilderTest extends TestCase
method setUp (line 22) | protected function setUp(): void
method testGetAnswers (line 37) | public function testGetAnswers(): void
method testGetEnvironment (line 42) | public function testGetEnvironment(): void
method testGetConsole (line 47) | public function testGetConsole(): void
method testStreamProcessOutput (line 52) | public function testStreamProcessOutput(): void
FILE: tests/LibraryStarterKit/TestCase.php
class TestCase (line 11) | class TestCase extends BaseTestCase
method setUp (line 15) | protected function setUp(): void
FILE: tests/LibraryStarterKit/WindowsSafeTextDriver.php
class WindowsSafeTextDriver (line 18) | class WindowsSafeTextDriver implements Driver
method serialize (line 20) | public function serialize(mixed $data): string
method extension (line 28) | public function extension(): string
method match (line 33) | public function match(mixed $expected, mixed $actual): void
FILE: tests/LibraryStarterKit/WizardTest.php
class WizardTest (line 36) | class WizardTest extends TestCase
method testGetSetup (line 38) | public function testGetSetup(): void
method testGetAnswersFileReturnsPathToLocalAnswersFile (line 66) | public function testGetAnswersFileReturnsPathToLocalAnswersFile(): void
method testGetAnswersFileReturnsPathToEnvironmentAnswersFile (line 95) | public function testGetAnswersFileReturnsPathToEnvironmentAnswersFile(...
method testRunWhenUserChoosesNotToStart (line 115) | public function testRunWhenUserChoosesNotToStart(): void
method testRunWhenUserConfirmsStart (line 170) | public function testRunWhenUserConfirmsStart(): void
method testRunWhenUsingAnswersFileWhenSkipPromptsIsTrue (line 252) | public function testRunWhenUsingAnswersFileWhenSkipPromptsIsTrue(): void
method testNewApplicationReturnsAnInstanceOfApplication (line 309) | public function testNewApplicationReturnsAnInstanceOfApplication(): void
method testStart (line 315) | public function testStart(): void
method testRunWhenExceptionIsThrownWithVerbosity (line 354) | #[DataProvider('runWhenExceptionIsThrownWithVerbosityProvider')]
method runWhenExceptionIsThrownWithVerbosityProvider (line 441) | public static function runWhenExceptionIsThrownWithVerbosityProvider()...
method testDetermineVerbosityLevel (line 467) | #[DataProvider('determineVerbosityLevelProvider')]
method determineVerbosityLevelProvider (line 487) | public static function determineVerbosityLevelProvider(): array
FILE: tests/TestCase.php
class TestCase (line 12) | class TestCase extends BaseTestCase
Condensed preview — 247 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (545K chars).
[
{
"path": ".editorconfig",
"chars": 276,
"preview": "# EditorConfig http://EditorConfig.org\n\n# top-most EditorConfig file\nroot = true\n\n# This applies to all files\n[*]\nend_of"
},
{
"path": ".gitattributes.template",
"chars": 924,
"preview": "/.allowed-licenses export-ignore\n/.editorconfig export-ignore\n/.gitattributes export-i"
},
{
"path": ".github/CODEOWNERS",
"chars": 0,
"preview": ""
},
{
"path": ".github/ISSUE_TEMPLATE/Bug_Report.md",
"chars": 1138,
"preview": "---\nname: Bug Report\nabout: Create a bug report to help us improve\nlabels: bug\nassignees:\n---\n<!--- Provide a general su"
},
{
"path": ".github/ISSUE_TEMPLATE/Feature_Request.md",
"chars": 928,
"preview": "---\nname: Feature Request\nabout: Suggest a feature for this project\nlabels: enhancement\nassignees:\n---\n<!--- Provide a g"
},
{
"path": ".github/ISSUE_TEMPLATE/Question.md",
"chars": 626,
"preview": "---\nname: Question\nabout: Ask a question about how to use this library\nlabels: question\nassignees:\n---\n<!--- Provide a g"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 28,
"preview": "blank_issues_enabled: false\n"
},
{
"path": ".github/dependabot.yml",
"chars": 213,
"preview": "version: 2\nupdates:\n - package-ecosystem: \"composer\"\n directory: \"/\"\n schedule:\n interval: \"monthly\"\n\n - pa"
},
{
"path": ".github/pull_request_template.md",
"chars": 1267,
"preview": "<!--- Provide a general summary of your changes in the title above. -->\n\n## Description\n<!--- Describe your changes in d"
},
{
"path": ".github/workflows/continuous-integration.yml",
"chars": 4512,
"preview": "# GitHub Actions Documentation: https://docs.github.com/en/actions\n\nname: \"Continuous Integration\"\n\non:\n push:\n bran"
},
{
"path": ".github/workflows/merge-me.yml",
"chars": 945,
"preview": "# Merge Me! Documentation: https://github.com/ridedott/merge-me-action/\n\nname: \"Merge Dependabot PRs\"\n\non:\n workflow_ru"
},
{
"path": ".gitignore",
"chars": 95,
"preview": ".phpunit.result.cache\n/captainhook.config.json\n/composer.lock\n/phpcs.xml\n/phpunit.xml\n/vendor/\n"
},
{
"path": "CHANGELOG.md",
"chars": 11285,
"preview": "# ramsey/php-library-starter-kit Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe fo"
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 3366,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, w"
},
{
"path": "CONTRIBUTING.md",
"chars": 6523,
"preview": "# Contributing\n\nContributions are welcome. This project accepts pull requests on [GitHub][].\n\nThis project adheres to a "
},
{
"path": "LICENSE",
"chars": 1079,
"preview": "Copyright (c) 2019-2025 Ben Ramsey <ben@benramsey.com>\n\nPermission is hereby granted, free of charge, to any person obta"
},
{
"path": "README.md",
"chars": 6218,
"preview": "<h1 align=\"center\"><!-- NAME_START -->PHP Library Starter Kit<!-- NAME_END --></h1>\n\n<!-- BADGES_START -->\n<p align=\"cen"
},
{
"path": "SECURITY.md",
"chars": 7695,
"preview": "<!--\n This policy template was created using the HackerOne Policy Builder [1],\n with guidance from the National Te"
},
{
"path": "bin/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "build/.gitignore",
"chars": 117,
"preview": "\n*\n!.gitignore\n\ncache/*\n!cache\n!cache/.gitkeep\n\ncoverage/*\n!coverage\n!coverage/.gitkeep\n\nlogs/*\n!logs\n!logs/.gitkeep\n"
},
{
"path": "build/cache/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "build/coverage/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "build/logs/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "captainhook.json",
"chars": 3136,
"preview": "{\n \"config\": {\n \"ansi-colors\": true,\n \"fail-on-first-error\": false,\n \"plugins\": [],\n \"ver"
},
{
"path": "codecov.yml",
"chars": 446,
"preview": "codecov:\n require_ci_to_pass: yes\n\ncoverage:\n precision: 2\n round: down\n range: \"70...100\"\n status:\n project:\n "
},
{
"path": "composer.json",
"chars": 2317,
"preview": "{\n \"name\": \"ramsey/php-library-starter-kit\",\n \"description\": \"A starter kit for quickly setting up a new PHP libra"
},
{
"path": "conventional-commits.json",
"chars": 410,
"preview": "{\n \"typeCase\": \"kebab\",\n \"types\": [\n \"chore\",\n \"ci\",\n \"docs\",\n \"feat\",\n \"fix\",\n"
},
{
"path": "docs/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "phpcs.xml.dist",
"chars": 337,
"preview": "<?xml version=\"1.0\"?>\n<ruleset xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"vend"
},
{
"path": "phpstan.neon.dist",
"chars": 143,
"preview": "parameters:\n tmpDir: ./build/cache/phpstan\n treatPhpDocTypesAsCertain: false\n level: max\n paths:\n - ."
},
{
"path": "phpunit.xml.dist",
"chars": 650,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<phpunit xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xsi:noNam"
},
{
"path": "psalm.xml",
"chars": 895,
"preview": "<?xml version=\"1.0\"?>\n<psalm xmlns=\"https://getpsalm.org/schema/config\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSche"
},
{
"path": "resources/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "resources/templates/CHANGELOG.md.twig",
"chars": 409,
"preview": "# {{ packageName }} Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based"
},
{
"path": "resources/templates/CONTRIBUTING.md.twig",
"chars": 6025,
"preview": "# Contributing\n\nContributions are welcome. This project accepts pull requests on [GitHub][].\n\n{% if codeOfConduct != 'No"
},
{
"path": "resources/templates/FUNDING.yml.twig",
"chars": 0,
"preview": ""
},
{
"path": "resources/templates/code-of-conduct/Citizen-2.3.md.twig",
"chars": 7150,
"preview": "# Citizen Code of Conduct\n\n## 1. Purpose\n\nA primary goal of {{ packageName }} is to be inclusive to the largest number o"
},
{
"path": "resources/templates/code-of-conduct/Contributor-1.4.md.twig",
"chars": 3373,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, w"
},
{
"path": "resources/templates/code-of-conduct/Contributor-2.0.md.twig",
"chars": 5226,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participa"
},
{
"path": "resources/templates/code-of-conduct/Contributor-2.1.md.twig",
"chars": 5489,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participa"
},
{
"path": "resources/templates/header/AGPL-3.0-or-later.twig",
"chars": 777,
"preview": "{{ packageName }} is free software: you can redistribute it\nand/or modify it under the terms of the GNU Affero General P"
},
{
"path": "resources/templates/header/Apache-2.0.twig",
"chars": 632,
"preview": "Licensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the "
},
{
"path": "resources/templates/header/BSD-2-Clause.twig",
"chars": 115,
"preview": "@copyright {{ copyright }}\n@license https://opensource.org/license/bsd-2-clause/ BSD 2-Clause \"Simplified\" License\n"
},
{
"path": "resources/templates/header/BSD-3-Clause.twig",
"chars": 121,
"preview": "@copyright {{ copyright }}\n@license https://opensource.org/license/bsd-3-clause/ BSD 3-Clause \"New\" or \"Revised\" License"
},
{
"path": "resources/templates/header/CC0-1.0.twig",
"chars": 216,
"preview": "To the extent possible under law, {{ copyrightHolder }}\nhas waived all copyright and related or neighboring rights to\n{{"
},
{
"path": "resources/templates/header/GPL-3.0-or-later.twig",
"chars": 749,
"preview": "{{ packageName }} is free software: you can redistribute it\nand/or modify it under the terms of the GNU General Public L"
},
{
"path": "resources/templates/header/Hippocratic-2.1.twig",
"chars": 107,
"preview": "@copyright {{ copyright }}\n@license https://spdx.org/licenses/Hippocratic-2.1.html Hippocratic License 2.1\n"
},
{
"path": "resources/templates/header/LGPL-3.0-or-later.twig",
"chars": 778,
"preview": "{{ packageName }} is free software: you can redistribute it\nand/or modify it under the terms of the GNU Lesser General P"
},
{
"path": "resources/templates/header/MIT-0.twig",
"chars": 93,
"preview": "@copyright {{ copyright }}\n@license https://opensource.org/license/mit-0/ MIT No Attribution\n"
},
{
"path": "resources/templates/header/MIT.twig",
"chars": 84,
"preview": "@copyright {{ copyright }}\n@license https://opensource.org/license/mit/ MIT License\n"
},
{
"path": "resources/templates/header/MPL-2.0.twig",
"chars": 298,
"preview": "This Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distri"
},
{
"path": "resources/templates/header/Proprietary.twig",
"chars": 49,
"preview": "@copyright {{ copyright }}. All rights reserved.\n"
},
{
"path": "resources/templates/header/Unlicense.twig",
"chars": 248,
"preview": "{{ packageName }} is free and unencumbered software released\ninto the public domain. For more information, please view t"
},
{
"path": "resources/templates/header/source-file-header.twig",
"chars": 440,
"preview": "{% set headerTemplate %}header/{{ license }}.twig{% endset %}\n{% set copyright %}Copyright (c) {{ copyrightHolder }}{% i"
},
{
"path": "resources/templates/license/AGPL-3.0-or-later-NOTICE.twig",
"chars": 685,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nThis program is free software: you can redistribute it and/or modify\n"
},
{
"path": "resources/templates/license/AGPL-3.0-or-later.twig",
"chars": 34523,
"preview": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C)"
},
{
"path": "resources/templates/license/Apache-2.0-NOTICE.twig",
"chars": 579,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou m"
},
{
"path": "resources/templates/license/Apache-2.0.twig",
"chars": 11358,
"preview": "\n Apache License\n Version 2.0, January 2004\n "
},
{
"path": "resources/templates/license/BSD-2-Clause.twig",
"chars": 1317,
"preview": "{{ include('license/copyright-statement.twig') }}\nAll rights reserved.\n\nRedistribution and use in source and binary form"
},
{
"path": "resources/templates/license/BSD-3-Clause.twig",
"chars": 1515,
"preview": "{{ include('license/copyright-statement.twig') }}\nAll rights reserved.\n\nRedistribution and use in source and binary form"
},
{
"path": "resources/templates/license/CC0-1.0.twig",
"chars": 7048,
"preview": "Creative Commons Legal Code\n\nCC0 1.0 Universal\n\n CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE\n"
},
{
"path": "resources/templates/license/GPL-3.0-or-later-NOTICE.twig",
"chars": 664,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nThis program is free software: you can redistribute it and/or modify\n"
},
{
"path": "resources/templates/license/GPL-3.0-or-later.twig",
"chars": 35149,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "resources/templates/license/Hippocratic-2.1.twig",
"chars": 8354,
"preview": "{{ include('license/copyright-statement.twig') }} (“Licensor”)\n\nHippocratic License Version Number: 2.1.\n\nPurpose. The p"
},
{
"path": "resources/templates/license/LGPL-3.0-or-later-NOTICE.twig",
"chars": 685,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nThis program is free software: you can redistribute it and/or modify\n"
},
{
"path": "resources/templates/license/LGPL-3.0-or-later.twig",
"chars": 7652,
"preview": " GNU LESSER GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007"
},
{
"path": "resources/templates/license/MIT-0.twig",
"chars": 909,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nPermission is hereby granted, free of charge, to any person obtaining"
},
{
"path": "resources/templates/license/MIT.twig",
"chars": 1074,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nPermission is hereby granted, free of charge, to any person obtaining"
},
{
"path": "resources/templates/license/MPL-2.0-NOTICE.twig",
"chars": 244,
"preview": "{{ include('license/copyright-statement.twig') }}\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nL"
},
{
"path": "resources/templates/license/MPL-2.0.twig",
"chars": 16725,
"preview": "Mozilla Public License Version 2.0\n==================================\n\n1. Definitions\n--------------\n\n1.1. \"Contributor\""
},
{
"path": "resources/templates/license/Proprietary.twig",
"chars": 72,
"preview": "{{ include('license/copyright-statement.twig') }}. All rights reserved.\n"
},
{
"path": "resources/templates/license/Unlicense.twig",
"chars": 1211,
"preview": "This is free and unencumbered software released into the public domain.\n\nAnyone is free to copy, modify, publish, use, c"
},
{
"path": "resources/templates/license/copyright-statement.twig",
"chars": 161,
"preview": "Copyright (c) {{ 'now'|date('Y') }} {{ copyrightHolder }}{% if copyrightEmail %} <{{ copyrightEmail }}>{% elseif copyrig"
},
{
"path": "resources/templates/readme/badges.md.twig",
"chars": 1962,
"preview": "{% if packageDescription %}\n<p align=\"center\">\n <strong>{{ packageDescription }}</strong>\n</p>\n{% endif %}\n\n<!--\nTODO"
},
{
"path": "resources/templates/readme/code-of-conduct.md.twig",
"chars": 155,
"preview": "This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).\nBy participating in this project and its community, you"
},
{
"path": "resources/templates/readme/copyright.md.twig",
"chars": 2593,
"preview": "{% set copyright %}{% if copyrightUrl %}[{{ copyrightHolder }}]({{ copyrightUrl }}){% elseif copyrightEmail %}[{{ copyri"
},
{
"path": "resources/templates/readme/description.md.twig",
"chars": 241,
"preview": "## About\n\n<!--\nTODO: Use this space to provide more details about your package. Try to be\n concise. This is the int"
},
{
"path": "resources/templates/readme/security.md.twig",
"chars": 343,
"preview": "## Coordinated Disclosure\n\nKeeping user information safe and secure is a top priority, and we welcome the\ncontribution o"
},
{
"path": "resources/templates/readme/usage.md.twig",
"chars": 472,
"preview": "## Installation\n\nInstall this package as a dependency using [Composer](https://getcomposer.org).\n\n``` bash\ncomposer requ"
},
{
"path": "resources/templates/security-policy/HackerOne.md.twig",
"chars": 4569,
"preview": "<!--\n This policy template was created using the HackerOne Policy Builder [1],\n with guidance from the National Te"
},
{
"path": "src/Example.php",
"chars": 532,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Answers.php",
"chars": 4160,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/InstallQuestions.php",
"chars": 3283,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/AnswersTool.php",
"chars": 458,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/AuthorEmail.php",
"chars": 928,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/AuthorHoldsCopyright.php",
"chars": 888,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/AuthorName.php",
"chars": 796,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/AuthorUrl.php",
"chars": 829,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CodeOfConduct.php",
"chars": 2692,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CodeOfConductCommittee.php",
"chars": 1367,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CodeOfConductEmail.php",
"chars": 1088,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CodeOfConductPoliciesUrl.php",
"chars": 1189,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CodeOfConductReportingUrl.php",
"chars": 1202,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CopyrightEmail.php",
"chars": 1122,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CopyrightHolder.php",
"chars": 1069,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CopyrightUrl.php",
"chars": 1104,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/CopyrightYear.php",
"chars": 1471,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/EmailValidatorTool.php",
"chars": 1049,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/GithubUsername.php",
"chars": 869,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/License.php",
"chars": 3178,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/PackageDescription.php",
"chars": 1030,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/PackageKeywords.php",
"chars": 1563,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/PackageName.php",
"chars": 2240,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/PackageNamespace.php",
"chars": 3268,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/SecurityPolicy.php",
"chars": 884,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/SecurityPolicyContactEmail.php",
"chars": 1105,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/SecurityPolicyContactFormUrl.php",
"chars": 1077,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/SkippableQuestion.php",
"chars": 349,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/StarterKitQuestion.php",
"chars": 436,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/UrlValidatorTool.php",
"chars": 1221,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Question/VendorName.php",
"chars": 1500,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/Style.php",
"chars": 356,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Console/StyleFactory.php",
"chars": 594,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Exception/InvalidConsoleInput.php",
"chars": 379,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Exception/StarterKitException.php",
"chars": 357,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Filesystem.php",
"chars": 667,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Project.php",
"chars": 561,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Setup.php",
"chars": 3941,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Build.php",
"chars": 2948,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/Cleanup.php",
"chars": 1327,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/FixStyle.php",
"chars": 710,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/InstallDependencies.php",
"chars": 1058,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/RenameTemplates.php",
"chars": 1777,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/RunTests.php",
"chars": 678,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/SetupRepository.php",
"chars": 4418,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateChangelog.php",
"chars": 869,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateCodeOfConduct.php",
"chars": 1525,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateComposerJson.php",
"chars": 6014,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateContributing.php",
"chars": 891,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateFunding.php",
"chars": 894,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateLicense.php",
"chars": 3276,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateNamespace.php",
"chars": 3261,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateReadme.php",
"chars": 4129,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateSecurityPolicy.php",
"chars": 1361,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder/UpdateSourceFileHeaders.php",
"chars": 2121,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Task/Builder.php",
"chars": 1362,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "src/LibraryStarterKit/Wizard.php",
"chars": 8882,
"preview": "<?php\n\n/**\n * This file is part of ramsey/php-library-starter-kit\n *\n * @copyright Copyright (c) Ben Ramsey <ben@benrams"
},
{
"path": "tests/ExampleTest.php",
"chars": 373,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Vendor\\Test\\SubNamespace;\n\nuse Vendor\\SubNamespace\\Example;\n\nclass ExampleTes"
},
{
"path": "tests/LibraryStarterKit/AnswersTest.php",
"chars": 9629,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit;\n\nuse Mockery\\MockInterface;\nuse Ramsey\\Dev"
},
{
"path": "tests/LibraryStarterKit/Console/InstallQuestionsTest.php",
"chars": 764,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console;\n\nuse Ramsey\\Dev\\LibraryStarterKit\\"
},
{
"path": "tests/LibraryStarterKit/Console/Question/AuthorEmailTest.php",
"chars": 504,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/AuthorHoldsCopyrightTest.php",
"chars": 873,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/AuthorNameTest.php",
"chars": 491,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/AuthorUrlTest.php",
"chars": 498,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CodeOfConductCommitteeTest.php",
"chars": 1934,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CodeOfConductEmailTest.php",
"chars": 1642,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CodeOfConductPoliciesUrlTest.php",
"chars": 1662,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CodeOfConductReportingUrlTest.php",
"chars": 1672,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CodeOfConductTest.php",
"chars": 5025,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CopyrightEmailTest.php",
"chars": 1522,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CopyrightHolderTest.php",
"chars": 1498,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CopyrightUrlTest.php",
"chars": 1529,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/CopyrightYearTest.php",
"chars": 1800,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/EmailValidatorToolTest.php",
"chars": 2226,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/GithubUsernameTest.php",
"chars": 546,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/LicenseTest.php",
"chars": 5839,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/PackageDescriptionTest.php",
"chars": 876,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/PackageKeywordsTest.php",
"chars": 1834,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/PackageNameTest.php",
"chars": 3174,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/PackageNamespaceTest.php",
"chars": 2152,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/QuestionTestCase.php",
"chars": 2115,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/SecurityPolicyContactEmailTest.php",
"chars": 1334,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/SecurityPolicyContactFormUrlTest.php",
"chars": 1330,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/SecurityPolicyTest.php",
"chars": 849,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse Ramsey\\Dev\\LibrarySt"
},
{
"path": "tests/LibraryStarterKit/Console/Question/UrlValidatorToolTest.php",
"chars": 2278,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/Question/VendorNameTest.php",
"chars": 1757,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console\\Question;\n\nuse PHPUnit\\Framework\\At"
},
{
"path": "tests/LibraryStarterKit/Console/StyleFactoryTest.php",
"chars": 701,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Console;\n\nuse Ramsey\\Dev\\LibraryStarterKit\\"
},
{
"path": "tests/LibraryStarterKit/FilesystemTest.php",
"chars": 451,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit;\n\nuse Ramsey\\Dev\\LibraryStarterKit\\Filesyst"
},
{
"path": "tests/LibraryStarterKit/ProjectTest.php",
"chars": 414,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit;\n\nuse Ramsey\\Dev\\LibraryStarterKit\\Project;"
},
{
"path": "tests/LibraryStarterKit/SetupTest.php",
"chars": 3975,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit;\n\nuse Composer\\IO\\IOInterface;\nuse Composer"
},
{
"path": "tests/LibraryStarterKit/SnapshotsTool.php",
"chars": 537,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit;\n\nuse ReflectionClass;\nuse Spatie\\Snapshots"
},
{
"path": "tests/LibraryStarterKit/Task/BuildTest.php",
"chars": 2627,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task;\n\nuse Mockery\\MockInterface;\nuse Ramse"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/CleanupTest.php",
"chars": 2375,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/FixStyleTest.php",
"chars": 1238,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Hamcrest\\Type\\IsCallable"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/InstallDependenciesTest.php",
"chars": 1945,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Hamcrest\\Type\\IsCallable"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/RenameTemplatesTest.php",
"chars": 2414,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse ArrayObject;\nuse Mockery"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/RunTestsTest.php",
"chars": 1240,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Hamcrest\\Type\\IsCallable"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/SetupRepositoryTest.php",
"chars": 7819,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Closure;\nuse Hamcrest\\Ty"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateChangelogTest.php",
"chars": 1923,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateCodeOfConductTest.php",
"chars": 3351,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateComposerJsonTest.php",
"chars": 7716,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse ArrayObject;\nuse Mockery"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateContributingTest.php",
"chars": 1944,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateFundingTest.php",
"chars": 1923,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateLicenseTest.php",
"chars": 8354,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Closure;\nuse Mockery\\Moc"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateNamespaceTest.php",
"chars": 4757,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse ArrayObject;\nuse Mockery"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateReadmeTest.php",
"chars": 8342,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse ArrayObject;\nuse Mockery"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateSecurityPolicyTest.php",
"chars": 3313,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse Mockery\\MockInterface;\nu"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/UpdateSourceFileHeadersTest.php",
"chars": 5183,
"preview": "<?php\n\ndeclare(strict_types=1);\n\nnamespace Ramsey\\Test\\Dev\\LibraryStarterKit\\Task\\Builder;\n\nuse ArrayObject;\nuse Compose"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateComposerJsonTest__testBuildWithMinimalComposerJson__1.txt",
"chars": 230,
"preview": "{\n \"name\": \"a-vendor/package-name\",\n \"type\": \"library\",\n \"description\": \"This is a test package.\",\n \"keyword"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateComposerJsonTest__testBuild__1.txt",
"chars": 1004,
"preview": "{\n \"name\": \"a-vendor/package-name\",\n \"type\": \"library\",\n \"description\": \"This is a test package.\",\n \"keyword"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__1.txt",
"chars": 24,
"preview": "/path/to/app/src/Foo.php"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__2.txt",
"chars": 267,
"preview": "<?php\n\n/**\n * File header comment for acme/foo-bar\n *\n * phpcs:disable\n */\n\ndeclare(strict_types=1);\n\nnamespace Acme\\Foo"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__3.txt",
"chars": 24,
"preview": "/path/to/app/src/Bar.php"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__4.txt",
"chars": 267,
"preview": "<?php\n\n/**\n * File header comment for acme/foo-bar\n *\n * phpcs:disable\n */\n\ndeclare(strict_types=1);\n\nnamespace Acme\\Foo"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__5.txt",
"chars": 26,
"preview": "/path/to/app/composer.json"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__0__6.txt",
"chars": 267,
"preview": "<?php\n\n/**\n * File header comment for acme/foo-bar\n *\n * phpcs:disable\n */\n\ndeclare(strict_types=1);\n\nnamespace Acme\\Foo"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__1__1.txt",
"chars": 24,
"preview": "/path/to/app/src/Foo.php"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__1__2.txt",
"chars": 227,
"preview": "<?php\n\n/**\n * File header comment for acme/foo\n *\n * phpcs:disable\n */\n\ndeclare(strict_types=1);\n\nnamespace Acme;\n\nuse A"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__1__3.txt",
"chars": 24,
"preview": "/path/to/app/src/Bar.php"
},
{
"path": "tests/LibraryStarterKit/Task/Builder/__snapshots__/UpdateNamespaceTest__testBuild_with_data_set__1__4.txt",
"chars": 227,
"preview": "<?php\n\n/**\n * File header comment for acme/foo\n *\n * phpcs:disable\n */\n\ndeclare(strict_types=1);\n\nnamespace Acme;\n\nuse A"
}
]
// ... and 47 more files (download for full content)
About this extraction
This page contains the full source code of the ramsey/php-library-starter-kit GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 247 files (492.1 KB), approximately 123.2k tokens, and a symbol index with 539 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.