mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-04 03:01:23 -06:00
c2ec3d89c2
This is a catch-all PR that modernizes and updates our Stylelint config, and resolves all open issues. This is a pretty big change - so I want to update all of our related dependencies in lockstep.
In particular, this PR
- [x] updates stylelint to `v14`
- [x] adds in the standard stylelint config for SCSS (`stylelint-config-standard-scss`)
- [x] swaps out `stylelint-config-prettier` for `stylelint-config-prettier-scss`
- [x] ~~properly update `@primer`-related plugins:~~ completely remove `primer` from our configuration
- [x] autofix, manually resolve, or disable all newly-introduced lint errors; **I've avoided manually resolving errors that would be a behavioural change**
- [x] re-runs `npm run format`
See the "next steps" section on some extra thoughts on disabling errors.
(implicitly, I'm also using node 16/the new package-lock format).
### disabling rules and next steps
I've introduced several new disabled rules. Let me quickly explain what's going on; there are two categories of rules I've disabled:
1. rules that were temporary disables; they were frequent enough that I couldn't manually resolve them, but should be simple. **I plan on opening issues to re-enable each of these rules**, just after this PR
- `declaration-block-no-redundant-longhand-properties`: this is just tedious and error-prone
- `no-descending-specificity`: this one is tricky since it could have impacts on the cascade (though that seems unlikely)
- `scss/no-global-function-names`: I think we need to [import map and then use `map.get`](https://stackoverflow.com/questions/64210390/sass-map-get-doesnt-work-map-get-does-what-gives), but I'll leave this as out of scope for now
2. rules that are long-term disables; due to the SASS-based nature of our theme, I think we'll keep these in limbo
- `alpha-value-notation` causes problems with SASS using the `modern` syntax - literals like `50%` are not properly interpolated, and they cause formatting issues on the site
- `color-function-notation` also causes problems with SASS, but in this case the `modern` syntax breaks SASS compilation; we're not alone (see this [SO post](https://stackoverflow.com/questions/71805735/error-function-rgb-is-missing-argument-green-in-sass)).
In addition, we have many inline `stylelint-disable` comments. I'd open a separate issue to audit them, especially since I think some disables are unnecessary.
### on Primer
**note: there hasn't been much other discussion, so I'm going to remove primer's stylelint config.**
If I do add `@primer/stylelint-config`, I get *a ton* of errors about now using `@primer`'s in-built SCSS variables. I imagine that we probably won't want to use these presets (though I could be wrong). In that case, I think we could either:
1. disable all of those rules
4. not use `@primer/stylelint-config`, since we're not actually using primer, and shift back to the standard SCSS config provided by Stylelint
~~Any thoughts here? I also don't have the original context as to why we do use the primer rules, perhaps @pmarsceill can chime in?~~
163 lines
3.7 KiB
SCSS
163 lines
3.7 KiB
SCSS
// Utility classes for margins and padding
|
|
|
|
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before
|
|
|
|
// Margin spacer utilities
|
|
|
|
.mx-auto {
|
|
margin-right: auto !important;
|
|
margin-left: auto !important;
|
|
}
|
|
|
|
@for $i from 1 through length($spacers) {
|
|
$size: #{map-get($spacers, sp-#{$i - 1})};
|
|
$scale: #{$i - 1};
|
|
|
|
// .m-0, .m-1, .m-2...
|
|
.m-#{$scale} {
|
|
margin: #{$size} !important;
|
|
}
|
|
.mt-#{$scale} {
|
|
margin-top: #{$size} !important;
|
|
}
|
|
.mr-#{$scale} {
|
|
margin-right: #{$size} !important;
|
|
}
|
|
.mb-#{$scale} {
|
|
margin-bottom: #{$size} !important;
|
|
}
|
|
.ml-#{$scale} {
|
|
margin-left: #{$size} !important;
|
|
}
|
|
|
|
.mx-#{$scale} {
|
|
margin-right: #{$size} !important;
|
|
margin-left: #{$size} !important;
|
|
}
|
|
|
|
.my-#{$scale} {
|
|
margin-top: #{$size} !important;
|
|
margin-bottom: #{$size} !important;
|
|
}
|
|
|
|
.mxn-#{$scale} {
|
|
margin-right: -#{$size} !important;
|
|
margin-left: -#{$size} !important;
|
|
}
|
|
.mx-#{$scale}-auto {
|
|
margin-right: auto !important;
|
|
margin-left: auto !important;
|
|
}
|
|
}
|
|
|
|
@each $media-query in map-keys($media-queries) {
|
|
@for $i from 1 through length($spacers) {
|
|
@include mq($media-query) {
|
|
$size: #{map-get($spacers, sp-#{$i - 1})};
|
|
$scale: #{$i - 1};
|
|
|
|
// .m-sm-0, .m-md-1, .m-lg-2...
|
|
.m-#{$media-query}-#{$scale} {
|
|
margin: #{$size} !important;
|
|
}
|
|
.mt-#{$media-query}-#{$scale} {
|
|
margin-top: #{$size} !important;
|
|
}
|
|
.mr-#{$media-query}-#{$scale} {
|
|
margin-right: #{$size} !important;
|
|
}
|
|
.mb-#{$media-query}-#{$scale} {
|
|
margin-bottom: #{$size} !important;
|
|
}
|
|
.ml-#{$media-query}-#{$scale} {
|
|
margin-left: #{$size} !important;
|
|
}
|
|
|
|
.mx-#{$media-query}-#{$scale} {
|
|
margin-right: #{$size} !important;
|
|
margin-left: #{$size} !important;
|
|
}
|
|
|
|
.my-#{$media-query}-#{$scale} {
|
|
margin-top: #{$size} !important;
|
|
margin-bottom: #{$size} !important;
|
|
}
|
|
|
|
.mxn-#{$media-query}-#{$scale} {
|
|
margin-right: -#{$size} !important;
|
|
margin-left: -#{$size} !important;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Padding spacer utilities
|
|
|
|
@for $i from 1 through length($spacers) {
|
|
$size: #{map-get($spacers, sp-#{$i - 1})};
|
|
$scale: #{$i - 1};
|
|
|
|
// .p-0, .p-1, .p-2...
|
|
.p-#{$scale} {
|
|
padding: #{$size} !important;
|
|
}
|
|
.pt-#{$scale} {
|
|
padding-top: #{$size} !important;
|
|
}
|
|
.pr-#{$scale} {
|
|
padding-right: #{$size} !important;
|
|
}
|
|
.pb-#{$scale} {
|
|
padding-bottom: #{$size} !important;
|
|
}
|
|
.pl-#{$scale} {
|
|
padding-left: #{$size} !important;
|
|
}
|
|
|
|
.px-#{$scale} {
|
|
padding-right: #{$size} !important;
|
|
padding-left: #{$size} !important;
|
|
}
|
|
|
|
.py-#{$scale} {
|
|
padding-top: #{$size} !important;
|
|
padding-bottom: #{$size} !important;
|
|
}
|
|
}
|
|
|
|
@each $media-query in map-keys($media-queries) {
|
|
@include mq($media-query) {
|
|
@for $i from 1 through length($spacers) {
|
|
$size: #{map-get($spacers, sp-#{$i - 1})};
|
|
$scale: #{$i - 1};
|
|
|
|
// .p-sm-0, .p-md-1, .p-lg-2...
|
|
.p-#{$media-query}-#{$scale} {
|
|
padding: #{$size} !important;
|
|
}
|
|
.pt-#{$media-query}-#{$scale} {
|
|
padding-top: #{$size} !important;
|
|
}
|
|
.pr-#{$media-query}-#{$scale} {
|
|
padding-right: #{$size} !important;
|
|
}
|
|
.pb-#{$media-query}-#{$scale} {
|
|
padding-bottom: #{$size} !important;
|
|
}
|
|
.pl-#{$media-query}-#{$scale} {
|
|
padding-left: #{$size} !important;
|
|
}
|
|
|
|
.px-#{$media-query}-#{$scale} {
|
|
padding-right: #{$size} !important;
|
|
padding-left: #{$size} !important;
|
|
}
|
|
|
|
.py-#{$media-query}-#{$scale} {
|
|
padding-top: #{$size} !important;
|
|
padding-bottom: #{$size} !important;
|
|
}
|
|
}
|
|
}
|
|
}
|