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

Add box phar compilation, make compile command, and installation notes #126

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
README.md:
doctoc README.md --github --notitle --maxlevel=3
doctoc README.md --github --notitle --maxlevel=3
compile:
box compile
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,17 @@ In this case, it will be installed into the `./tools` folder of your current dir

./tools/typoscript-lint path/to/your.typoscript

### Setup (using [box](https://github.com/box-project/box))

You can build a stand-alone `typoscript-lint.phar` file using box:

box compile

You can then make this available system wide:

sudo chmod a+x typoscript-lint.phar
sudo mv typoscript-lint.phar /usr/local/bin/typoscript-lint

### Usage

Call typo3-typoscript-lint as follows:
Expand Down
17 changes: 17 additions & 0 deletions box.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"directories": [
"src",
"vendor"
],
"files": [
"psalm.xml",
"services.yml",
"typoscript-lint.yml",
"LICENSE"
],
"main": "typoscript-lint",
"output": "typoscript-lint.phar",
"compression": "GZ",
"chmod": "0775",
"stub": true
}