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.

Sign up for GitHub

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

Jump to bottom

Fix docs generation locally on Windows. #34629

Draft
wants to merge 5 commits into
base: current
Choose a base branch
from
Draft

Fix docs generation locally on Windows. #34629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8a09681
Fix docs generation locally on Windows.
Sergeus Sep 8, 2024
f4d35e9
Merge branch 'current' into windows-local-gen
Sergeus Sep 12, 2024
cf971d8
Merge branch 'current' into windows-local-gen
Sergeus Sep 15, 2024
1258dfc
Merge branch 'current' into windows-local-gen
Sergeus Sep 20, 2024
bbc8909
Merge branch 'current' into windows-local-gen
Sergeus Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ group :development do
gem 'compass', '1.0.3'
gem 'sass-globbing', '1.1.5'
gem 'stringex', '2.8.6'
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
gem 'sassc', '2.1.0'
gem 'sassc', '2.4.0'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve version update but recommend sorting gems alphabetically.

The update of sassc from 2.1.0 to 2.4.0 is crucial for resolving compatibility issues and should be approved. However, to adhere to best practices and maintain consistency within the Gemfile, it's recommended to sort the gems alphabetically within their section as suggested by rubocop.

Consider rearranging the gems to maintain alphabetical order:

  gem 'rubocop', '1.66.1'
  gem 'ruby-lsp', '0.17.17'
  gem 'rackup', '2.1.0'
+ gem 'sassc', '2.4.0'
  gem 'sass-globbing', '1.1.5'
- gem 'sassc', '2.4.0'
  gem 'stringex', '2.8.6'
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
gem 'sassc', '2.4.0'
gem 'rubocop', '1.66.1'
gem 'ruby-lsp', '0.17.17'
gem 'rackup', '2.1.0'
gem 'sassc', '2.4.0'
gem 'sass-globbing', '1.1.5'
gem 'stringex', '2.8.6'
Tools
rubocop

[convention] 11-11: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem sassc should appear before stringex.

(Bundler/OrderedGems)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot change this, as per the comment on the existing code.

See: sass/sassc-ruby#189

If this is problematic for Windows, I think it is better to start documenting you cannot use this on Windows.

../Frenck

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I completely misread the purpose of that comment! I'll try to sort this out with the older version - see if there's some other way to make that gem compatible to be installed at 2.1.0

gem 'rubocop', '1.66.1'
gem 'ruby-lsp', '0.18.3'
gem 'rackup', '2.1.0'
Expand All @@ -33,4 +32,4 @@ install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.0" if Gem.win_platform?
gem "wdm", "~> 0.2.0" if Gem.win_platform?
Sergeus marked this conversation as resolved.
Show resolved Hide resolved
17 changes: 13 additions & 4 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@ GEM
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.0-arm64-darwin)
ffi (1.17.0-x64-mingw-ucrt)
ffi (1.17.0-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (4.28.2-arm64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.28.0-x64-mingw-ucrt)
bigdecimal
rake (>= 13)
google-protobuf (4.28.2-x86_64-linux)
bigdecimal
rake (>= 13)
Expand Down Expand Up @@ -83,6 +87,8 @@ GEM
ruby2_keywords (~> 0.0.1)
nokogiri (1.16.7-arm64-darwin)
racc (~> 1.4)
nokogiri (1.16.7-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.16.7-x86_64-linux)
racc (~> 1.4)
parallel (1.26.3)
Expand Down Expand Up @@ -136,13 +142,13 @@ GEM
sass (3.4.25)
sass-embedded (1.79.3-arm64-darwin)
google-protobuf (~> 4.27)
sass-embedded (1.78.0-x64-mingw-ucrt)
google-protobuf (~> 4.27)
sass-embedded (1.79.3-x86_64-linux-gnu)
google-protobuf (~> 4.27)
sass-globbing (1.1.5)
sass (>= 3.1)
sassc (2.1.0)
ffi (~> 1.9)
sassc (2.1.0-x86_64-linux)
sassc (2.4.0)
ffi (~> 1.9)
sinatra (4.0.0)
mustermann (~> 3.0)
Expand All @@ -159,11 +165,13 @@ GEM
concurrent-ruby (~> 1.0)
tzinfo-data (1.2024.2)
tzinfo (>= 1.0.0)
wdm (0.2.0)
unicode-display_width (2.6.0)
webrick (1.8.2)

PLATFORMS
arm64-darwin-23
x64-mingw-ucrt
x86_64-linux

DEPENDENCIES
Expand All @@ -179,11 +187,12 @@ DEPENDENCIES
rubocop (= 1.66.1)
ruby-lsp (= 0.18.3)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sassc (= 2.4.0)
sinatra (= 4.0.0)
stringex (= 2.8.6)
tzinfo (~> 2.0)
tzinfo-data
wdm (~> 0.2.0)

RUBY VERSION
ruby 2.6.2p47
Expand Down