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?~~
201 lines
2.5 KiB
SCSS
201 lines
2.5 KiB
SCSS
.highlight,
|
|
pre.highlight {
|
|
background: #282c34;
|
|
color: #abb2bf;
|
|
}
|
|
.highlight pre {
|
|
background: #282c34;
|
|
}
|
|
.highlight .hll {
|
|
background: #282c34;
|
|
}
|
|
.highlight .c {
|
|
color: #5c6370;
|
|
font-style: italic;
|
|
}
|
|
.highlight .err {
|
|
color: #960050;
|
|
background-color: #1e0010;
|
|
}
|
|
.highlight .k {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .l {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .n {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .o {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .p {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .cm {
|
|
color: #5c6370;
|
|
font-style: italic;
|
|
}
|
|
.highlight .cp {
|
|
color: #5c6370;
|
|
font-style: italic;
|
|
}
|
|
.highlight .c1 {
|
|
color: #5c6370;
|
|
font-style: italic;
|
|
}
|
|
.highlight .cs {
|
|
color: #5c6370;
|
|
font-style: italic;
|
|
}
|
|
.highlight .ge {
|
|
font-style: italic;
|
|
}
|
|
.highlight .gs {
|
|
font-weight: 700;
|
|
}
|
|
.highlight .kc {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .kd {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .kn {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .kp {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .kr {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .kt {
|
|
color: #5ba473;
|
|
}
|
|
.highlight .ld {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .m {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .s {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .na {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .nb {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .nc {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .no {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .nd {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .ni {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .ne {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .nf {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .nl {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .nn {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .nx {
|
|
color: #abb2bf;
|
|
}
|
|
.highlight .py {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .nt {
|
|
color: #77b181;
|
|
}
|
|
.highlight .nv {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .ow {
|
|
font-weight: 700;
|
|
}
|
|
.highlight .w {
|
|
color: #f8f8f2;
|
|
}
|
|
.highlight .mf {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .mh {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .mi {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .mo {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .sb {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .sc {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .sd {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .s2 {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .se {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .sh {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .si {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .sx {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .sr {
|
|
color: #56b6c2;
|
|
}
|
|
.highlight .s1 {
|
|
color: #c8ae9d;
|
|
}
|
|
.highlight .ss {
|
|
color: #56b6c2;
|
|
}
|
|
.highlight .bp {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .vc {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .vg {
|
|
color: #e5c07b;
|
|
}
|
|
.highlight .vi {
|
|
color: #77b181;
|
|
}
|
|
.highlight .il {
|
|
color: #d19a66;
|
|
}
|
|
.highlight .gu {
|
|
color: #75715e;
|
|
}
|
|
.highlight .gd {
|
|
color: #f92672;
|
|
}
|
|
.highlight .gi {
|
|
color: #a6e22e;
|
|
}
|