Task: Updates ruby-sass due to eol #92
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduces a detailed .gitignore file to exclude unnecessary files and directories from version control. - Includes configurations for Ruby, macOS, Linux, and Windows environments. - Improves repository cleanliness and reduces unnecessary storage.
- Replaces sass-rails with dartsass-rails due to EOL. - Updates the gemfile and gemspec files accordingly. - Removes sass-rails dependency.
- Updates the `bin/rails` file to follow current best practices - Ensures full Rails functionality is available during gem development/testing. - Includes explanation of all rails component inclusion.
- Introduces `dartsass-rails` to replace `ruby-sass` which is now end-of-life. - This ensures continued support for Sass compilation within the application.
- Updates header style file location to align with other partials.
- Extracts favicon related links into a partial. - Improves maintainability of the application layout. - Reduces duplication of favicon declarations.
- Updates stylesheet structure for compatibility with Propshaft. - Removes redundant imports from lr-common.scss. - Organises imports in lr_common_styles.scss for clarity.
- Uses `presence&.join(' ')` for more concise and readable code.
- Improves code clarity and maintainability by using modern Ruby syntax.
- Removes the `active_support.to_time_preserves_timezone` configuration from the dummy application.
- Configures the Rails engine to include asset paths from gem dependencies. - Ensures that stylesheet assets from gems like govuk_template, govuk_elements_rails, bootstrap-sass, font-awesome-rails and govuk_frontend_toolkit are discoverable by the asset pipeline. - Logs a debug message in development if a gem's asset path cannot be added, preventing errors if a gem is not present.
- Modifies asset precompilation logic to only execute when Sprockets is available. - Prevents errors in Rails 8+ which use Propshaft by default and no longer have `config.assets`. - Improves compatibility across different Rails versions and asset pipeline configurations.
- Tidies up unused asset reference to the `lr_common_styles` stylesheet from the asset manifest aligning with updates related to Ruby Sass deprecation and end-of-life
- Clarifies asset loading instructions for both Sprockets and Propshaft, promoting a consistent approach. - Removes framework dependency imports from the common styles file, instead requiring host applications to manage these dependencies. - Explains the automatic registration of asset paths, ensuring discoverability within host applications.
- Adds `sprockets-rails` gem to the test dummy application. - Resolves a dependency issue in the test environment, ensuring proper asset compilation and functionality during testing. - This change is necessary to maintain the integrity of the test suite following updates to related dependencies.
- Updates and clarifies Makefile targets for gem building, testing and publishing. - Adds a `help` target to display available make commands and environment variables. - Renames and adds descriptions for each other target.
- Updates the gem version to reflect pre-release status. - This change is due to ongoing modifications and the need for beta testing.
- Updates the `lr_common_styles` gem to version 2.4.0.beta. - This is to test compatibility issues arising from the end-of-life for Ruby Sass.
- Updates the `build` target to explicitly signal that it is an alias for the `gem` target. - Modifies the `gem` target to directly use `gem build` command with the `.spec` file, ensuring correct gem package creation. - Clarifies output messages for the `build` target.
- Introduces Propshaft asset pipeline support, ensuring compatibility with Rails 8+. - Registers framework gem asset paths automatically within the engine initialiser. - Replaces `sass-rails` with `dartsass-rails` as the primary SCSS compiler. - Refactors the SCSS entrypoint to streamline Common Styles imports. - Includes a `help` target in the Makefile to list available commands. - Updates the test dummy app configuration for Propshaft/Sprockets compatibility.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves asset management and updates dependencies to address end-of-life status for Ruby Sass.
Added
helptarget in the makefile to list available commands.Changed
sass-railswithdartsass-railsas the primary scss compiler dependency.app/assets/config/manifest.jsto remove an incorrect stylesheet directory link and duplicate build references.bin/railsfor gem development.Fixed
Other changes