Add support for build scss files on hatch build

[oscarmcm]

Initial work for:

• Reorganize SCSS sources #1322

---

SCSS changes:

diff --git a/src/wiki/static/wiki/bootstrap/scss/wiki/wiki.scss b/src/wiki/static/wiki/bootstrap/scss/wiki/wiki.scss
index b12569d0..6d86709c 100644
--- a/src/wiki/static/wiki/bootstrap/scss/wiki/wiki.scss
+++ b/src/wiki/static/wiki/bootstrap/scss/wiki/wiki.scss
@@ -11,21 +11,23 @@ $danger:              #721817;
 {
     background: $info;
 }
 
 @mixin wiki-page-header{
     @extend .pb-2;
     @extend .mt-4;
     @extend .mb-2;
     @extend .border-bottom;
 }
-
+.some-very-long-class {
+  color: yellow;
+}
 .wiki-article .thumbnail
 {
     clear: both;
     margin-bottom: 15px;
     margin-left: 10px;
     margin-right: 10px;
     text-align: center;
 }

Output:

[oscarmcm]

I moved away from pure SCSS implementation and used PySCSS since those provide pre-built wheels for Linux and maxOS

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.75%. Comparing base (050f124) to head (176f6db).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1363   +/-   ##
=======================================
  Coverage   79.75%   79.75%           
=======================================
  Files         114      114           
  Lines        4737     4737           
  Branches      637      637           
=======================================
  Hits         3778     3778           
  Misses        748      748           
  Partials      211      211           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[oscarmcm]

@benjaoming I'll need help figuring out how to add libsassc inside of the read the docs CI

[benjaoming]

Awesome work!

This will make it much easier to build releases without maintaining the CSS artifact in git.

Maybe we can argue this way? "libsass" and "pysass" are build dependencies. So we need to define the build dependencies explicitly (not sure what is the "hatch way" of doing that)

For now, I've added it as a docs dependency... but maybe there's a better way?

[benjaoming]

Ah, this reminds me of when setup.py had a hack to specify that it needed some requirements to be installed BEFORE installing with setup_requires.

[benjaoming]

I think the current error is something about the build environment being isolated from the environment that the documentation dependencies are installed into. So I guess that whole approach won't work 😖

[oscarmcm]

Yeah, that's the thing!

Our approach works for CircleCI since we can have packages installed on each matrix environment. And since this is not allowed I dont think it will work with the RTD CI environment.

I dont think that marking this as a build dependency is a good idea, I really like the approach to have concerns separate and dont block Python development, just because a contributor doesn't have properly configured a SCSS installation.

Do you know if there's a way to check if the RDT CI has an environment variable that we can read and conditionally run the command?

[benjaoming]

Yes, you can define environment variables on RTD 👍

[benjaoming]

I really like the approach to have concerns separate and dont block Python development, just because a contributor doesn't have properly configured a SCSS installation.

Agreed!

[oscarmcm]

@benjaoming this should be good to go :)

[benjaoming]

Great! So I guess that it's not possible to list libsass here?

I've clicked "watching" on the hatch-build-scripts repo since it seems like it's a small project: https://github.com/rmorshea/hatch-build-scripts

[oscarmcm]

That's a good observation!!

Based on the PEP documentation, we can place it there (https://peps.python.org/pep-0518/) I could explore that just in case, the only thing I'm not OK is that using this solution will make the lib sass required for everything, since for each environment this is build on dev mode.

[benjaoming]

Not a bad idea. I don't have any strong opinions on this one, if the libsass dependency isn't really problematic and pysassc is fast to run, then it's okay for me. But we can easily just wait and see if the new setup causes any problems, it also seems fine as it is 👍

[benjaoming]

Great solution 👍