Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore!: rename ec to editorconfig-checker #321

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/vendor/
/Build/bin/
/bin/ec-*
/bin/editorconfig-checker-*
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
docker-run:
docker run -it --rm --volume=$$PWD:/usr/src/myapp -u $$(id -u):$$(id -g) --name ec ec /bin/bash
docker run -it --rm --volume=$$PWD:/usr/src/myapp -u $$(id -u):$$(id -g) --name editorconfig-checker editorconfig-checker /bin/bash
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This is a tool to check if your files consider your .editorconfig. Most tools -

## Important

This is only a wrapper for the core [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker).
This is only a wrapper for the core [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker).
You should have a look at this repository to know how this tool can be used and what possibilities/caveats are there.
This version can be used in the same way as the core as every argument is simply passed down to it.

Expand All @@ -40,7 +40,7 @@ composer require --dev editorconfig-checker/editorconfig-checker
## Usage

```
vendor/bin/ec
vendor/bin/editorconfig-checker
```

## Configuration
Expand All @@ -49,14 +49,8 @@ You can configure analysis in `.ecrc` json file, e.g.:

```json
{
"Exclude": [
"^vendor\/",
"^var\/",
"^\\.idea\/",
"\\.phar$"
]
"Exclude": ["^vendor/", "^var/", "^\\.idea/", "\\.phar$"]
}

```

Full list of config options is in [core docs](https://github.com/editorconfig-checker/editorconfig-checker?tab=readme-ov-file#configuration)
Expand All @@ -65,10 +59,9 @@ Full list of config options is in [core docs](https://github.com/editorconfig-ch

Please head to [core docs](https://github.com/editorconfig-checker/editorconfig-checker?tab=readme-ov-file#usage).


## Support

If you have any questions or just want to chat join #editorconfig-checker on
If you have any questions or just want to chat join #editorconfig-checker on
freenode(IRC).
If you don't have an IRC-client set up you can use the
If you don't have an IRC-client set up you can use the
[freenode webchat](https://webchat.freenode.net/?channels=editorconfig-checker).
2 changes: 1 addition & 1 deletion bin/editorconfig-checker
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#!/usr/bin/env bash
./$(dirname $0)/ec "$@"
./$(dirname $0)/editorconfig-checker "$@"
5 changes: 2 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,13 @@
"@lint:self"
],
"lint:psr2": "phpcs --standard=PSR2 src/**",
"lint:self": "./bin/ec",
"lint:self": "./bin/editorconfig-checker",
"test": "phpunit tests/ --bootstrap vendor/autoload.php --colors=always",
"test:coverage": "phpunit -c ./phpunit.xml.dist",
"check": "phpstan analyse -vvv"
},
"bin": [
"bin/editorconfig-checker",
"bin/ec"
"bin/editorconfig-checker"
],
"autoload": {
"psr-4": {
Expand Down
2 changes: 1 addition & 1 deletion src/EditorconfigChecker/Utilities.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public static function getCurrentOs(): string
*/
public static function getReleaseName(): string
{
return sprintf('ec-%s-%s', Utilities::getCurrentOs(), Utilities::getCurrentArch());
return sprintf('editorconfig-checker-%s-%s', Utilities::getCurrentOs(), Utilities::getCurrentArch());
}

/**
Expand Down
2 changes: 1 addition & 1 deletion tests/Cli/CliTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public function testRun(): void
$this->assertEquals(Cli::run([$this->basePath()]), 0);

// TestFiles should fail
system("cd ./Build && ../bin/ec", $return);
system("cd ./Build && ../bin/editorconfig-checker", $return);
$this->assertEquals($return, 1);
}

Expand Down
Loading