Skip to content

Commit fb2b019

Browse files
committed
feat: refactorize cli script
1 parent 9173e8d commit fb2b019

File tree

17 files changed

+2324
-1183
lines changed

17 files changed

+2324
-1183
lines changed

.dockerignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.git/
2+
nbproject/
3+
vendor/
4+
build/
5+
**/*.cache

.github/dependabot.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
version: 2
22
updates:
3-
- package-ecosystem: composer
4-
directory: "/"
5-
schedule:
6-
interval: weekly
7-
day: friday
8-
time: "04:00"
9-
open-pull-requests-limit: 10
10-
versioning-strategy: increase
3+
- package-ecosystem: composer
4+
directory: "/"
5+
schedule:
6+
interval: weekly
7+
day: friday
8+
versioning-strategy: increase
9+
- package-ecosystem: github-actions
10+
directory: "/"
11+
schedule:
12+
interval: weekly
13+
day: friday

.github/workflows/continuous-integration.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ jobs:
3939
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
4040
restore-keys: ${{ runner.os }}-composer-
4141

42+
- name: Cache PHPUnit cache
43+
uses: actions/cache@v1
44+
with:
45+
path: tests/.phpunit.result.cache
46+
key: ${{ runner.os }}-phpunit-${{ github.sha }}
47+
restore-keys: ${{ runner.os }}-phpunit-
48+
4249
- name: Install dependencies
4350
run: |
4451
composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
@@ -48,7 +55,7 @@ jobs:
4855
composer test:ci
4956
5057
- name: Upload coverage results to Coveralls
51-
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.php-versions == '7.4'
58+
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.php-versions == '8.0'
5259
uses: codecov/codecov-action@master
5360
with:
5461
file: ./build/logs/clover.xml

CONTRIBUTING.md

Lines changed: 86 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,92 @@
1-
# CONTRIBUTING
1+
# Contributing
22

3-
## Running tests
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
45

5-
```bash
6-
$ composer test
7-
```
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
87

9-
## Fix code linting
8+
## Pull Request Process
109

11-
```bash
12-
$ composer cbf
13-
```
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.
1418

15-
## Running CI scripts
19+
## Code of Conduct
1620

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

Dockerfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM php:cli
2+
3+
WORKDIR /app
4+
5+
RUN apt-get -yqq update && \
6+
apt-get install -yqq --no-install-recommends libzip-dev zip && docker-php-ext-install zip \
7+
&& pecl install pcov && docker-php-ext-enable pcov
8+
9+
RUN echo 'memory_limit = 512M' >> /usr/local/etc/php/conf.d/docker-php-memlimit.ini;
10+
11+
12+
COPY --from=composer /usr/bin/composer /usr/bin/composer
13+

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,30 @@
4444
2. [Usage](https://github.com/neilime/php-css-lint/wiki/Usage)
4545
3. [Code Coverage](https://codecov.io/gh/neilime/php-css-lint)
4646
4. [PHP Doc](https://neilime.github.io/php-css-lint/phpdoc)
47+
48+
# Development
49+
50+
## Setup
51+
52+
```sh
53+
docker build -t php-css-lint .
54+
docker run --rm -it -v $(pwd):/app php-css-lint composer install
55+
```
56+
57+
## Running tests
58+
59+
```sh
60+
docker run --rm -it -v $(pwd):/app php-css-lint composer test
61+
```
62+
63+
## Fix code linting
64+
65+
```sh
66+
docker run --rm -it -v $(pwd):/app php-css-lint composer cbf
67+
```
68+
69+
## Running CI scripts
70+
71+
```sh
72+
docker run --rm -it -v $(pwd):/app php-css-lint composer ci
73+
```

0 commit comments

Comments
 (0)