Skip to content

Commit 1017e1f

Browse files
mfrankruijtermfrankruijter
committed
The initial implementation of the package
0 parents  commit 1017e1f

33 files changed

Lines changed: 1291 additions & 0 deletions

‎.gitattributes‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/tests export-ignore
2+
/examples export-ignore
3+
/.gitignore export-ignore
4+
/.travis.yml export-ignore
5+
/phpunit.xml export-ignore
6+
/phpcs.xml export-ignore
7+
/PULL_REQUEST_TEMPLATE.md export-ignore
8+
/CODE_OF_CONDUCT.md export-ignore
9+
/CONTRIBUTING.md export-ignore

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
vendor/
2+
composer.lock
3+
var/

‎.travis.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
language: php
2+
php:
3+
- '7.2'
4+
- '7.3'
5+
6+
before_script:
7+
- yes '' | pecl install yaml
8+
- composer install
9+
10+
script:
11+
- composer validate --strict
12+
- vendor/bin/phpunit --coverage-text
13+
- vendor/bin/phpcs src/ tests/
14+
15+
cache:
16+
directories:
17+
- $HOME/.composer/cache

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## 1.0.0 - 2020-05-02
8+
9+
### Added
10+
- The initial implementation of the package.
11+
12+
# Versions
13+
- [1.0.0 > Unreleased](https://github.com/ulrack/kernel/compare/1.0.0...HEAD)

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
To contribute to this package, please keep to these guidelines.
4+
5+
- Fork the package.
6+
- Create a branch per feature.
7+
- Commit your changes to these branches.
8+
- Create a pull request per feature to the master branch of the original repository.
9+
10+
## Pull requests
11+
12+
Pull request should follow these rules, before they can get accepted.
13+
14+
- Follow the [pull request template](PULL_REQUEST_TEMPLATE.md).
15+
- Contains a short but complete description.
16+
- Has passed all test command listed bellow.
17+
18+
## Running Tests
19+
20+
``` bash
21+
$ vendor/bin/phpunit --coverage-text
22+
$ vendor/bin/phpcs src/ tests/
23+
```
24+
25+
## Notes
26+
27+
Multiple commits per feature are allowed, but please provide a good description in your pull request.
28+
This description will be used to squash your feature into the master branch.

‎LICENSE‎

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

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# (bugfix / feature / refactor / etc.): Short descriptive title
2+
3+
## Description
4+
5+
Fixes #
6+
7+
Changes proposed in this pull request:
8+
-
9+
-
10+
-
11+
12+
Make sure you can check the following boxes before submitting the pull request:
13+
- [] The proposed changes work with the dependencies from composer.
14+
- [] The proposed changes have been thoroughly tested.
15+
- [] The proposed changes don't alter the code in such a manner that it conflicts with the initial purpose of the package.
16+
17+
Optional checkbox
18+
- [] Backwards incompatible

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[![Build Status](https://travis-ci.com/ulrack/cli-application.svg?branch=master)](https://travis-ci.com/ulrack/cli-application)
2+
3+
# Ulrack CLI Application
4+
5+
This package contains an application for the
6+
[Ulrack Kernel](https://github.com/ulrack/kernel) which implements the
7+
[Ulrack Command](https://github.com/ulrack/command) package.
8+
9+
## Installation
10+
11+
To install the package run the following command:
12+
13+
```
14+
composer require ulrack/cli-application
15+
```
16+
17+
## Usage
18+
19+
Please see the [documentation](docs/index.md) for information on the usage of this package.
20+
21+
## Change log
22+
23+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
24+
25+
## Contributing
26+
27+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
28+
29+
## MIT License
30+
31+
Copyright (c) GrizzIT
32+
33+
Permission is hereby granted, free of charge, to any person obtaining a copy
34+
of this software and associated documentation files (the "Software"), to deal
35+
in the Software without restriction, including without limitation the rights
36+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
37+
copies of the Software, and to permit persons to whom the Software is
38+
furnished to do so, subject to the following conditions:
39+
40+
The above copyright notice and this permission notice shall be included in all
41+
copies or substantial portions of the Software.
42+
43+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
44+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
45+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
46+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
47+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
48+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
49+
SOFTWARE.

‎composer.json‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"name": "ulrack/cli-application",
3+
"description": "The Ulrack CLI application package.",
4+
"keywords": [
5+
"framework",
6+
"cli",
7+
"application"
8+
],
9+
"type": "library",
10+
"license": "MIT",
11+
"prefer-stable": true,
12+
"minimum-stability": "stable",
13+
"require": {
14+
"php": "^7.2",
15+
"grizz-it/configuration": "^1.0",
16+
"ulrack/command": "^1.0",
17+
"ulrack/kernel": "^1.0"
18+
},
19+
"authors": [
20+
{
21+
"name": "Ulrack",
22+
"homepage": "https://www.ulrack.com/",
23+
"role": "Developer"
24+
}
25+
],
26+
"config": {
27+
"sort-packages": true
28+
},
29+
"autoload": {
30+
"psr-4": {
31+
"Ulrack\\CliApplication\\": "src/"
32+
},
33+
"files": [
34+
"locator.php"
35+
]
36+
},
37+
"autoload-dev": {
38+
"psr-4": {
39+
"Ulrack\\CliApplication\\Tests\\": "tests/"
40+
}
41+
},
42+
"archive": {
43+
"exclude": [
44+
"/tests",
45+
"/.gitignore",
46+
"/.travis.yml",
47+
"/phpunit.xml",
48+
"/phpcs.xml",
49+
"/PULL_REQUEST_TEMPLATE.md",
50+
"/CODE_OF_CONDUCT.md",
51+
"/CONTRIBUTING.md"
52+
]
53+
},
54+
"require-dev": {
55+
"phpunit/phpunit": "^8.0",
56+
"squizlabs/php_codesniffer": "^3.4"
57+
}
58+
}

0 commit comments

Comments
 (0)