|Matthieu Marcillaud d4a6d8ea80||10 months ago|
|src||10 months ago|
|LICENSE.md||5 years ago|
|README.md||2 years ago|
|composer.json||10 months ago|
|scss.inc.php||2 years ago|
scssphp is a compiler for SCSS written in PHP.
Checkout the homepage, https://scssphp.github.io/scssphp, for directions on how to use.
scssphp uses PHPUnit for testing.
Run the following command from the root directory to run every test:
There are several tests in the
ApiTest.phpcontains various unit tests that test the PHP interface.
ExceptionTest.phpcontains unit tests that test for exceptions thrown by the parser and compiler.
FailingTest.phpcontains tests reported in Github issues that demonstrate compatibility bugs.
.scssfile in the
tests/inputsdirectory then compares to the respective
.cssfile in the
SassSpecTest.phpextracts tests from the
When changing any of the tests in
tests/inputs, the tests will most likely
fail because the output has changed. Once you verify that the output is correct
you can run the following command to rebuild all the tests:
BUILD=1 vendor/bin/phpunit tests
This will compile all the tests, and save results into
tests/outputs. It also
updates the list of excluded specs from sass-spec.
To enable the full
sass-spec compatibility tests:
TEST_SASS_SPEC=1 vendor/bin/phpunit tests
scssphp source conforms to PSR12.
Run the following command from the root directory to check the code for "sniffs".
vendor/bin/phpcs --standard=PSR12 --extensions=php bin src tests *.php
scssphp uses phpstan for static analysis.
Run the following command from the root directory to analyse the codebase:
As most of the codebase is composed of legacy code which cannot be type-checked fully, the setup contains a baseline file with all errors we want to ignore. In particular, we ignore all errors related to not specifying the types inside arrays when these arrays correspond to the representation of Sass values and Sass AST nodes in the parser and compiler. When contributing, the proper process to deal with static analysis is the following:
- Make your change in the codebase
- Fix errors reported by phpstan when possible
- Repeat step 2 and 3 until nothing gets fixed anymore at step 3
make phpstan-baselineto regenerate the phpstan baseline
Additions to the baseline will be reviewed to avoid ignoring errors that should have been fixed.