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

Replace builtin blocks Sass with vanilla CSS #35570

Open
6 tasks
farhan opened this issue Oct 1, 2024 · 0 comments
Open
6 tasks

Replace builtin blocks Sass with vanilla CSS #35570

farhan opened this issue Oct 1, 2024 · 0 comments
Assignees
Labels
epic Large unit of work, consisting of multiple tasks

Comments

@farhan
Copy link
Contributor

farhan commented Oct 1, 2024

Copy the following tasks into the PR description of the XBlock and update the status on PR.

Tasks:

  • Convert Sass variable into css variables

  • Compile the css file of the block following given steps.

    • Change this line to the following to avoid adding comments in the compiled css files
           source_comments: int = SASS_COMMENTS_NONE
    • Compile the sass to uncompressed CSS using following command
            npm run compile-sass-dev
    • Copy the compiled XBlock linked CSS (lms/static/css/*Display.css and lms/static/css/*Editor.css) into xmodule/static/css-builtin-blocks.
    • Format the CSS files using the editor.
    • Add those CSS files to version control.
  • Replace add_sass_to_fragment to add_css_to_fragment in blocks .py file

  • Remove all .scss files linked to the block under xmodule/assets.

    • Make sure to remove the .scss file in a separate alone commit so reviewer could review scss changes and they stay in history.
    • Don't remove the scss file if its linked to some other block.

Testing Notes:

  • Run npm run build to run webpack and compile sass files.
  • Run ./manage.py lms collectstatic in lms shell to re-collect static files.
  • Run ./manage.py cms collectstatic in cms shell to re-collect static files.
  • Verify the block's compiled css and the css global variables in the LMS
  • Verify the block's compiled css and the css global variables in the Studio
  • Test the XBlock rendering and User Experience in LMS
  • Test the XBlock rendering and User Experience in Studio

Reference PR:

Here is initial reference PR [Some the changes are only 1 time changes so don't need them in next block PR's.]

@farhan farhan self-assigned this Oct 1, 2024
@farhan farhan added the epic Large unit of work, consisting of multiple tasks label Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Large unit of work, consisting of multiple tasks
Projects
Status: 🏗 In progress
Development

No branches or pull requests

1 participant