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?~~
207 lines
3.3 KiB
SCSS
207 lines
3.3 KiB
SCSS
// The basic two column layout
|
|
|
|
.side-bar {
|
|
z-index: 0;
|
|
display: flex;
|
|
flex-wrap: wrap;
|
|
background-color: $sidebar-color;
|
|
|
|
@include mq(md) {
|
|
flex-wrap: nowrap;
|
|
position: fixed;
|
|
width: $nav-width-md;
|
|
height: 100%;
|
|
flex-direction: column;
|
|
border-right: $border $border-color;
|
|
align-items: flex-end;
|
|
}
|
|
|
|
@include mq(lg) {
|
|
width: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
|
|
min-width: $nav-width;
|
|
}
|
|
}
|
|
|
|
.main {
|
|
@include mq(md) {
|
|
position: relative;
|
|
max-width: $content-width;
|
|
margin-left: $nav-width-md;
|
|
}
|
|
|
|
@include mq(lg) {
|
|
margin-left: calc(
|
|
(100% - #{$nav-width + $content-width}) / 2 + #{$nav-width}
|
|
);
|
|
}
|
|
}
|
|
|
|
.main-content-wrap {
|
|
@include container;
|
|
|
|
padding-top: $gutter-spacing-sm;
|
|
padding-bottom: $gutter-spacing-sm;
|
|
|
|
@include mq(md) {
|
|
padding-top: $gutter-spacing;
|
|
padding-bottom: $gutter-spacing;
|
|
}
|
|
}
|
|
|
|
.main-header {
|
|
z-index: 0;
|
|
display: none;
|
|
background-color: $sidebar-color;
|
|
|
|
@include mq(md) {
|
|
display: flex;
|
|
justify-content: space-between;
|
|
height: $header-height;
|
|
background-color: $body-background-color;
|
|
border-bottom: $border $border-color;
|
|
}
|
|
|
|
&.nav-open {
|
|
display: block;
|
|
|
|
@include mq(md) {
|
|
display: flex;
|
|
}
|
|
}
|
|
}
|
|
|
|
.site-nav,
|
|
.site-header,
|
|
.site-footer {
|
|
width: 100%;
|
|
|
|
@include mq(lg) {
|
|
width: $nav-width;
|
|
}
|
|
}
|
|
|
|
.site-nav {
|
|
display: none;
|
|
|
|
&.nav-open {
|
|
display: block;
|
|
}
|
|
|
|
@include mq(md) {
|
|
display: block;
|
|
padding-top: $sp-8;
|
|
padding-bottom: $gutter-spacing-sm;
|
|
overflow-y: auto;
|
|
flex: 1 1 auto;
|
|
}
|
|
}
|
|
|
|
.site-header {
|
|
display: flex;
|
|
min-height: $header-height;
|
|
align-items: center;
|
|
|
|
@include mq(md) {
|
|
height: $header-height;
|
|
max-height: $header-height;
|
|
border-bottom: $border $border-color;
|
|
}
|
|
}
|
|
|
|
.site-title {
|
|
@include container;
|
|
|
|
flex-grow: 1;
|
|
display: flex;
|
|
height: 100%;
|
|
align-items: center;
|
|
padding-top: $sp-3;
|
|
padding-bottom: $sp-3;
|
|
color: $body-heading-color;
|
|
@include fs-6;
|
|
|
|
@include mq(md) {
|
|
padding-top: $sp-2;
|
|
padding-bottom: $sp-2;
|
|
}
|
|
}
|
|
|
|
@if variable-exists(logo) {
|
|
.site-logo {
|
|
width: 100%;
|
|
height: 100%;
|
|
background-image: url($logo);
|
|
background-repeat: no-repeat;
|
|
background-position: left center;
|
|
background-size: contain;
|
|
}
|
|
}
|
|
|
|
.site-button {
|
|
display: flex;
|
|
height: 100%;
|
|
padding: $gutter-spacing-sm;
|
|
align-items: center;
|
|
}
|
|
|
|
@include mq(md) {
|
|
.site-header .site-button {
|
|
display: none;
|
|
}
|
|
}
|
|
|
|
.site-title:hover {
|
|
background-image: linear-gradient(
|
|
-90deg,
|
|
rgba($feedback-color, 1) 0%,
|
|
rgba($feedback-color, 0.8) 80%,
|
|
rgba($feedback-color, 0) 100%
|
|
);
|
|
}
|
|
|
|
.site-button:hover {
|
|
background-image: linear-gradient(
|
|
-90deg,
|
|
rgba($feedback-color, 1) 0%,
|
|
rgba($feedback-color, 0.8) 100%
|
|
);
|
|
}
|
|
|
|
// stylelint-disable selector-max-type
|
|
|
|
body {
|
|
position: relative;
|
|
padding-bottom: $sp-10;
|
|
overflow-y: scroll;
|
|
|
|
@include mq(md) {
|
|
position: static;
|
|
padding-bottom: 0;
|
|
}
|
|
}
|
|
|
|
// stylelint-enable selector-max-type
|
|
|
|
.site-footer {
|
|
@include container;
|
|
|
|
position: absolute;
|
|
bottom: 0;
|
|
left: 0;
|
|
padding-top: $sp-4;
|
|
padding-bottom: $sp-4;
|
|
color: $grey-dk-000;
|
|
@include fs-2;
|
|
|
|
@include mq(md) {
|
|
position: static;
|
|
justify-self: end;
|
|
}
|
|
}
|
|
|
|
.icon {
|
|
width: $sp-5;
|
|
height: $sp-5;
|
|
color: $link-color;
|
|
}
|