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?~~
117 lines
2.3 KiB
SCSS
117 lines
2.3 KiB
SCSS
// Buttons and things that look like buttons
|
|
// stylelint-disable color-named
|
|
|
|
.btn {
|
|
display: inline-block;
|
|
box-sizing: border-box;
|
|
padding-top: 0.3em;
|
|
padding-right: 1em;
|
|
padding-bottom: 0.3em;
|
|
padding-left: 1em;
|
|
margin: 0;
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
font-weight: 500;
|
|
line-height: 1.5;
|
|
color: $link-color;
|
|
text-decoration: none;
|
|
vertical-align: baseline;
|
|
cursor: pointer;
|
|
background-color: $base-button-color;
|
|
border-width: 0;
|
|
border-radius: $border-radius;
|
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
|
appearance: none;
|
|
|
|
&:focus {
|
|
text-decoration: none;
|
|
outline: none;
|
|
box-shadow: 0 0 0 3px rgba(blue, 0.25);
|
|
}
|
|
|
|
&:focus:hover,
|
|
&.selected:focus {
|
|
box-shadow: 0 0 0 3px rgba(blue, 0.25);
|
|
}
|
|
|
|
&:hover,
|
|
&.zeroclipboard-is-hover {
|
|
color: darken($link-color, 2%);
|
|
}
|
|
|
|
&:hover,
|
|
&:active,
|
|
&.zeroclipboard-is-hover,
|
|
&.zeroclipboard-is-active {
|
|
text-decoration: none;
|
|
background-color: darken($base-button-color, 1%);
|
|
}
|
|
|
|
&:active,
|
|
&.selected,
|
|
&.zeroclipboard-is-active {
|
|
background-color: darken($base-button-color, 3%);
|
|
background-image: none;
|
|
box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15);
|
|
}
|
|
|
|
&.selected:hover {
|
|
background-color: darken(#dcdcdc, 5%);
|
|
}
|
|
|
|
&:disabled,
|
|
&.disabled {
|
|
&,
|
|
&:hover {
|
|
color: rgba(102, 102, 102, 0.5);
|
|
cursor: default;
|
|
background-color: rgba(229, 229, 229, 0.5);
|
|
background-image: none;
|
|
box-shadow: none;
|
|
}
|
|
}
|
|
}
|
|
|
|
.btn-outline {
|
|
color: $link-color;
|
|
background: transparent;
|
|
box-shadow: inset 0 0 0 2px $grey-lt-300;
|
|
|
|
&:hover,
|
|
&:active,
|
|
&.zeroclipboard-is-hover,
|
|
&.zeroclipboard-is-active {
|
|
color: darken($link-color, 4%);
|
|
text-decoration: none;
|
|
background-color: transparent;
|
|
box-shadow: inset 0 0 0 3px $grey-lt-300;
|
|
}
|
|
|
|
&:focus {
|
|
text-decoration: none;
|
|
outline: none;
|
|
box-shadow: inset 0 0 0 2px $grey-dk-100, 0 0 0 3px rgba(blue, 0.25);
|
|
}
|
|
|
|
&:focus:hover,
|
|
&.selected:focus {
|
|
box-shadow: inset 0 0 0 2px $grey-dk-100;
|
|
}
|
|
}
|
|
|
|
.btn-primary {
|
|
@include btn-color($white, $btn-primary-color);
|
|
}
|
|
|
|
.btn-purple {
|
|
@include btn-color($white, $purple-100);
|
|
}
|
|
|
|
.btn-blue {
|
|
@include btn-color($white, $blue-000);
|
|
}
|
|
|
|
.btn-green {
|
|
@include btn-color($white, $green-100);
|
|
}
|