N°2847 - Add SCSS shame file for hacks (https://sass-guidelin.es/#shame-file)

This commit is contained in:
Molkobain
2021-01-04 10:20:52 +01:00
parent 551689d445
commit 050c00c791
4 changed files with 49 additions and 5 deletions

View File

@@ -53,6 +53,7 @@ css/backoffice/
| ... # Etc…
|
|
`- _shame.scss # Shame file, should contain all the ugly hacks (https://sass-guidelin.es/#shame-file)
` main.scss # Main Sass file
```
@@ -68,4 +69,5 @@ To avoid common errors, files should be imported in the final file in the follow
- Components
- Layout
- Pages
- Themes
- Themes
- Shame file

View File

@@ -0,0 +1,45 @@
/*!
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
// ==========================================================================
// $Shame
// @see http://csswizardry.com/2013/04/shame-css/
// Thanks https://github.com/heroheman/shepherd/blob/master/sass/_shame.scss
// ==========================================================================
// ==========================================================================
// because hacks happen.
//
// be very specific about what each piece of code is doing, and
// how to better fix it later
// ==========================================================================
// Try: $ git blame _shame.scss
// Rules:
// ---------------
// 1. If its a hack, it goes in _shame.scss.
// 2. Document all hacks fully:
// 3. What part of the codebase does it relate to?
// 4. Why was this needed?
// 5. How does this fix it?
// 6. How might you fix it properly, given more time?
// 7. Do not blame the developer; if they explained why they had to do it then their reasons are probably (hopefully) valid.
// 8. Try and clean _shame.scss up when you have some down time.
// Example:
// ---------------
// Nav specificity fix.
// Someone used an ID in the header code (`#header a{}`) which trumps the
// nav selectors (`.site-nav a{}`). Use !important to override it until I
// have time to refactor the header stuff.
// .site-nav a { color:#BADA55!important; }
// N°2847 - Recolor svg illustrations with iTop's primary color
.ibo-svg-illustration--container > svg *[fill="#6c63ff"]{
fill: $ibo-svg-illustration--fill;
}

View File

@@ -60,8 +60,4 @@ a{
&:active{
color: var(--ibo-hyperlink-color--on-active);
}
}
.ibo-svg-illustration--container>svg *[fill="#6c63ff"]{
fill: $ibo-svg-illustration--fill;
}

View File

@@ -24,3 +24,4 @@
@import "pages/all";
@import "application/all";
@import "themes/all";
@import "shame";