https://github.com/scssphp/server
Server for on-the-fly .scss compilation
https://github.com/scssphp/server
Last synced: 26 days ago
JSON representation
Server for on-the-fly .scss compilation
- Host: GitHub
- URL: https://github.com/scssphp/server
- Owner: scssphp
- Created: 2019-06-18T21:25:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T17:24:31.000Z (about 3 years ago)
- Last Synced: 2025-10-10T13:27:44.425Z (6 months ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 7
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Server Example
If you just want to start serving compiled `scss` files as quick as possible
then start here. The **scssphp/server** project provides an easy-to-use example
that demonstrates how to automatically compile `scss` files and serve them from
a directory that you specify.
Create a file, like `style.php`:
```
use ScssPhp\Server\Server;
$directory = "stylesheets";
$server = new Server($directory);
$server->serve();
```
Create the directory set in the script alongside the script, then add your
`scss` files to it.
By default, **scssphp** expects a `scss_cache` directory to exist inside the
stylesheets directory where it will cache the compiled output. This way it can
quickly serve the files if no modifications have been made. Your PHP script
must have permission to write in `scss_cache`.
Going to the URL `example.com/style.php/style.scss` will attempt to compile
`style.scss` from the `stylesheets` directory, and serve it as CSS.
If it can not find the file it will return an HTTP 404 page:
```
/* INPUT NOT FOUND scss v0.0.1 */
```
If the file can't be compiled due to an error, then an HTTP 500 page is
returned. Similar to the following:
```
Parse error: failed at 'height: ;' stylesheets/test.scss on line 8
```
Also, because SCSS server writes headers, make sure no output is written before
it runs.
### Constructor
Use the `Server` constructor to specify the cache directory and even the
instance of the `Compiler` that is used to compile SCSS.
* `new Server($sourceDir, $cacheDir, $scss)` creates a new server that
serves files from `$sourceDir`. The cache dir is where the cached compiled
files are placed. When `null`, `$sourceDir . '/scss_cache'` is used. `$scss`
is the instance of `scss` that is used to compile.
Just call the `serve` method to let it render its output.
Here's an example of creating a SCSS server that outputs compressed CSS:
```
use ScssPhp\ScssPhp\Compiler;
use ScssPhp\Server\Server;
$scss = new Compiler();
$scss->setOutputStyle(\ScssPhp\ScssPhp\OutputStyle::COMPRESSED);
$server = new Server('stylesheets', null, $scss);
$server->serve();
```