{"id":15023147,"url":"https://github.com/professionalwiki/scss","last_synced_at":"2025-08-10T07:11:44.523Z","repository":{"id":42628434,"uuid":"133152159","full_name":"ProfessionalWiki/SCSS","owner":"ProfessionalWiki","description":"Adds SCSS support to MediaWikis Resouce Loader","archived":false,"fork":false,"pushed_at":"2024-10-29T20:57:17.000Z","size":99,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T22:53:19.509Z","etag":null,"topics":["library","mediawiki","scss","skin"],"latest_commit_sha":null,"homepage":"https://www.mediawiki.org/wiki/Extension:SCSS","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProfessionalWiki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"JeroenDeDauw","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-05-12T14:10:03.000Z","updated_at":"2024-10-29T20:57:15.000Z","dependencies_parsed_at":"2024-06-21T14:18:37.366Z","dependency_job_id":"fbd7bf39-51c6-4cac-84e6-ae924f4d6a3e","html_url":"https://github.com/ProfessionalWiki/SCSS","commit_stats":{"total_commits":92,"total_committers":7,"mean_commits":"13.142857142857142","dds":0.6413043478260869,"last_synced_commit":"c0d24356a355bbce1e4f24129438406fee55292b"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessionalWiki%2FSCSS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessionalWiki%2FSCSS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessionalWiki%2FSCSS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessionalWiki%2FSCSS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProfessionalWiki","download_url":"https://codeload.github.com/ProfessionalWiki/SCSS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238259011,"owners_count":19442513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","mediawiki","scss","skin"],"created_at":"2024-09-24T19:58:46.467Z","updated_at":"2025-02-11T08:31:41.643Z","avatar_url":"https://github.com/ProfessionalWiki.png","language":"PHP","funding_links":["https://github.com/sponsors/JeroenDeDauw"],"categories":[],"sub_categories":[],"readme":"# MediaWiki SCSS library\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ProfessionalWiki/SCSS/ci.yml?branch=master)](https://github.com/ProfessionalWiki/SCSS/actions?query=workflow%3ACI)\n[![Latest Stable Version](https://poser.pugx.org/mediawiki/scss/v/stable)](https://packagist.org/packages/mediawiki/scss)\n[![License](https://poser.pugx.org/mediawiki/scss/license)](https://packagist.org/packages/mediawiki/scss)\n\nThe MediaWiki SCSS library provides a ResourceLoader module capable of compiling [SCSS].\n\n## Requirements\n\n- [PHP] 8.0 or later\n- [MediaWiki] 1.39 or later\n- [Composer]\n\n## Use\n\nAn SCSS module is defined much like any other style module. See the manual for\n[$wgResourceModules](https://www.mediawiki.org/wiki/Manual:$wgResourceModules).\nIt should also be possible to add the module definition to the `extension.json`\nof a MediaWiki extension. See\n[Developing_with_ResourceLoader](https://www.mediawiki.org/wiki/ResourceLoader/Developing_with_ResourceLoader)\n\nSome additional keys may be used:\n* `class`:\n\tThis is mandatory. It selects the class to be used for the module. For\n \tSCSS, the value has to be `'SCSS\\\\ResourceLoaderSCSSModule'`\n* `styles`:\n\tIt is not an additional key, but it has extended semantics. This key\n\tcontains the list of the module's style files. Each file can optionally be\n\tgiven a position to influence the order in which the files are compiled.\n\tAllowed values for the position are\n\t1. `beforeFunctions`\n\t2. `functions`\n\t3. `afterFunctions`\n    4. `beforeVariables`\n    5. `variables`\n    6. `afterVariables`\n    7. `beforeMain`\n    8. `main`\n    9. `afterMain`\n\n\tIf no position is given, `main` will be assumed.\n\n    All files of one module will be compiled together, i.e., variables, mixins\n    etc., will be shared between them.\n\n* `variables`:\n\tAn array of variables and values to override the SCSS variables in the\n\tstyle files. This allows changing values (e.g., colors, fonts, margins)\n\twithout having to modify the actual style files.\n* `cacheTriggers`:\n\tCompiling SCSS is expensive, so compiled results are cached. This option\n\tlists files that, when changed, will trigger flushing of the cache and\n\tre-compiling of the style files.\n\n\tAll files on this list will be checked for each web request. To minimizes the\n\tload on the file system and the time to build the page, it is not advisable\n\tto add all style files to this list.\n\nHere is an example definition:\n```php\n$wgResourceModules[ 'ext.MyExtension.styles' ] = [\n\n\t'class' =\u003e 'SCSS\\\\ResourceLoaderSCSSModule',\n\t'localBasePath' =\u003e $localBasePath,\n\t'remoteBasePath' =\u003e $remoteBasePath,\n\t'position' =\u003e 'top',\n\n\t'styles' =\u003e [\n\t\t'modules/ext.MyExtension.foo.scss' =\u003e 'main',\n\t\t'modules/ext.MyExtension.bar.scss'\n\t],\n\t'variables' =\u003e [\n\t\t'red' =\u003e '#ff0000',\n\t\t'green' =\u003e '#00ff00',\n\t\t'blue' =\u003e '#0000ff',\n\t],\n\t'cacheTriggers' =\u003e [\n\t\t'LocalSettings.php',\n\t\t'composer.lock',\n\t],\n];\n```\n\nThe extension uses the [scssphp/scssphp](https://github.com/scssphp/scssphp)\ncompiler, which has some limitations. See the\n[issue list](https://github.com/scssphp/scssphp/issues).\n\n\n### Cache type\n\n`$egScssCacheType` can be set to request a specific cache type for the compiled\nstyles. To disable caching of SCSS styles altogether (e.g., during development),\nset `$egScssCacheType = CACHE_NONE;`. This should never be done on a production\nsite.\n\n## Professional Support\n\nThe SCSS extension is maintained by [Professional Wiki](https://professional.wiki).\nYou can [contract us][contact-form] to help you install or customize SCSS.\nWe also do development work.\n\n## Running the tests\n\nThe tests can only be run when the library is loaded within MediaWiki.\nYou can add it via `composer.local.json` (probably using `dev-master`).\n\nInside your MediaWiki root directory\n\n    php tests/phpunit/phpunit.php -c vendor/mediawiki/scss/phpunit.xml.dist\n\n## License\n\nYou can use the SCSS extension under the [GNU General Public License,\nversion 3][license] (or any later version).\n\n[PHP]: https://php.net\n[MediaWiki]: https://www.mediawiki.org/wiki/MediaWiki\n[Composer]: https://getcomposer.org/\n[license]: https://www.gnu.org/copyleft/gpl.html\n[SCSS]: https://en.wikipedia.org/wiki/Sass_(stylesheet_language)\n[contact-form]: https://professional.wiki/en/contact\n\n## Release notes\n\n### Version 4.0.0\n\nReleased on 2024-04-25\n\n* Raised minimum MediaWiki version from 1.35 to 1.39\n* Raised minimum PHP version from 7.4.3 to 8.0\n* Raised minimum `scssphp` version from 1.10.2 to 1.12.1\n* Modernized coding standards\n\n### Version 3.0.1\n\nReleased on 2022-07-25\n\n* Added preliminary compatibility with MediaWiki 1.39\n\n### Version 3.0.0\n\nReleased on 2022-03-30\n\n* Raised minimum MediaWiki version from 1.27 to 1.35\n* Raised minimum PHP version from 5.6 to 7.4.3\n* Raised minimum `scssphp` version from 1.5.2 to 1.10.2\n\n### Version 2.0.8\n\nReleased on 2022-07-25\n\n* Added preliminary compatibility with MediaWiki 1.39\n\n### Version 2.0.7\n\nReleased on 2021-05-18\n\n* Increased minimum version of `scssphp`\n\n### Version 2.0.6\n\nReleased on 2021-05-15\n\n* Temporarily limit the version of `scssphp` below 1.5 to avoid breaking changes\n\n### Version 2.0.5\n\nReleased on 2020-12-27\n\n* Added compatibility with MediaWiki 1.36\n\n### Version 2.0.4\n\nReleased on 2020-09-07\n\n* Switched to new version of `scssphp`\n\n### Version 2.0.3\n\nReleased on 2020-09-07\n\n* Temporarily fixed the version of `scssphp` to 1.1.1 to avoid the 1.2 bug\n\n### Version 2.0\n\nReleased on 2020-04-19\n\n* Turned MediaWiki extension into a standard PHP/Composer library\n* Switched to new version of `scssphp`\n\n### Version 1.0\n\nReleased on 2019-04-28\n\n* Initial release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofessionalwiki%2Fscss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofessionalwiki%2Fscss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofessionalwiki%2Fscss/lists"}