Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Stylelint configuration and cleanup #16379

Merged
merged 35 commits into from Oct 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
9afeb56
build: add initial Stylelint setup
nschonni Oct 2, 2022
c772a3d
fix: stylelint no-eol-whitespace
nschonni Oct 2, 2022
258dec6
fix: stylelint no-empty-first-line
nschonni Oct 2, 2022
9b08fb3
fix: stylelint max-empty-lines
nschonni Oct 2, 2022
35b4fce
fix: stylelint rule-empty-line-before
nschonni Oct 2, 2022
43736ca
fix: stylelint block-closing-brace-empty-line-before
nschonni Oct 2, 2022
60c72bc
fix: stylelint block-closing-brace-newline-after
nschonni Oct 2, 2022
768c09b
fix: stylelint block-opening-brace-newline-after
nschonni Oct 2, 2022
5c860ba
fix: stylelint block-opening-brace-space-before
nschonni Oct 2, 2022
164c2c2
fix: stylelint declaration-colon-newline-after
nschonni Oct 2, 2022
e378bd9
fix: stylelint declaration-colon-space-after
nschonni Oct 2, 2022
25793c8
fix: stylelint declaration-empty-line-before
nschonni Oct 2, 2022
faccbbf
fix: stylelint length-zero-no-unit
nschonni Oct 2, 2022
f844ef5
fix: stylelint indentation of 4
nschonni Oct 2, 2022
e9a7ca8
fix: stylelint media-feature-colon-space-after
nschonni Oct 2, 2022
cc84561
fix: stylelint no-duplicate-at-import-rules
nschonni Oct 2, 2022
a27f9d2
fix: stylelint scss/at-import-partial-extension
nschonni Oct 2, 2022
650b35c
fix: stylelint scss/double-slash-comment-empty-line-before
nschonni Oct 2, 2022
ea102c6
fix: stylelint selector-attribute-quotes
nschonni Oct 2, 2022
910c054
fix: stylelint selector-combinator-space-after
nschonni Oct 2, 2022
d4ad102
fix: stylelint selector-combinator-space-before
nschonni Oct 2, 2022
795e557
fix: stylelint selector-descendant-combinator-no-non-space
nschonni Oct 2, 2022
d2c428c
fix: stylelint selector-list-comma-newline-after
nschonni Oct 2, 2022
b36fd55
fix: stylelint selector-pseudo-element-colon-notation
nschonni Oct 2, 2022
5f65f0b
fix: stylelint string-quotes
nschonni Oct 2, 2022
bd5228c
fix: stylelint value-list-comma-newline-after
nschonni Oct 2, 2022
5c81587
ci: add Stylelint hook for docs
nschonni Oct 2, 2022
3de1fe2
docs: add direct Stylelint dep
nschonni Oct 2, 2022
95b42f1
docs: ignore re-copied SCSS files in _site
nschonni Oct 2, 2022
bdac1bd
Update docs/src/assets/scss/print.scss
nzakas Oct 12, 2022
71e54f9
Update docs/package.json
nzakas Oct 12, 2022
7068ffc
Update .github/workflows/ci.yml
nzakas Oct 12, 2022
03c825d
Add `lint:fix:scss` script
mdjermanovic Oct 26, 2022
520b741
Update docs/src/assets/scss/syntax-highlighter.scss
nschonni Oct 26, 2022
ccf67a0
Update docs/.stylelintrc.json
nschonni Oct 26, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Expand Up @@ -28,6 +28,9 @@ jobs:
- name: Install Docs Packages
working-directory: docs
run: npm install
- name: Stylelint Docs
working-directory: docs
run: npm run lint:scss
- name: Lint Docs JS Files
run: node Makefile lintDocsJS

Expand Down
28 changes: 28 additions & 0 deletions docs/.stylelintrc.json
@@ -0,0 +1,28 @@
{
"extends": ["stylelint-config-standard-scss"],
"rules": {
"alpha-value-notation": null,
"at-rule-empty-line-before": null,
"color-function-notation": null,
"color-hex-case": null,
"custom-property-empty-line-before": null,
"custom-property-pattern": null,
"declaration-block-no-duplicate-properties": null,
"declaration-block-no-redundant-longhand-properties": null,
"declaration-block-no-shorthand-property-overrides": null,
"hue-degree-notation": null,
"indentation": 4,
"max-line-length": null,
"no-descending-specificity": null,
"no-duplicate-selectors": null,
"number-leading-zero": null,
"number-no-trailing-zeros": null,
"property-no-unknown": null,
"property-no-vendor-prefix": null,
"selector-class-pattern": null,
"value-keyword-case": null
},
"ignoreFiles": [
"_site/**"
]
}
8 changes: 6 additions & 2 deletions docs/package.json
Expand Up @@ -15,7 +15,9 @@
"build:sass": "sass --style=compressed src/assets/scss:src/assets/css --no-source-map",
"build:eleventy": "npx @11ty/eleventy",
"start": "npm-run-all build:sass --parallel watch:*",
"build": "npm-run-all build:sass build:eleventy images"
"build": "npm-run-all build:sass build:eleventy images",
"lint:scss": "stylelint \"**/*.scss\"",
"lint:fix:scss": "npm run lint:scss -- --fix"
},
"devDependencies": {
"@11ty/eleventy": "^1.0.1",
Expand All @@ -40,7 +42,9 @@
"netlify-cli": "^10.3.1",
"npm-run-all": "^4.1.5",
"rimraf": "^3.0.2",
"sass": "^1.52.1"
"sass": "^1.52.1",
"stylelint": "^14.13.0",
"stylelint-config-standard-scss": "^5.0.0"
},
"engines": {
"node": ">=14.0.0"
Expand Down
6 changes: 3 additions & 3 deletions docs/src/assets/scss/carbon-ads.scss
@@ -1,7 +1,7 @@
.hero-ad {
@media all and (max-width: 800px) {
display: none;
}
@media all and (max-width: 800px) {
display: none;
}
}

#carbonads * {
Expand Down
2 changes: 0 additions & 2 deletions docs/src/assets/scss/components/alert.scss
Expand Up @@ -42,7 +42,6 @@
}
}


[data-theme="dark"] {
.alert {
&.alert--warning {
Expand Down Expand Up @@ -101,7 +100,6 @@
}
}


.alert__learn-more {
display: block;
font-weight: 500;
Expand Down
4 changes: 1 addition & 3 deletions docs/src/assets/scss/components/buttons.scss
Expand Up @@ -23,9 +23,7 @@ button {
align-items: center;
justify-content: center;
border-radius: var(--border-radius);

transition: background-color .2s linear,
border-color .2s linear;
transition: background-color .2s linear, border-color .2s linear;

svg {
color: inherit;
Expand Down
1 change: 0 additions & 1 deletion docs/src/assets/scss/components/docs-index.scss
Expand Up @@ -143,7 +143,6 @@
}

#ham-top {

transform: rotate(41deg);
}

Expand Down
8 changes: 0 additions & 8 deletions docs/src/assets/scss/components/docs-navigation.scss
Expand Up @@ -13,7 +13,6 @@
margin-bottom: 2rem;
margin-block-end: 2rem;


@media all and (min-width: 1024px) {
font-size: var(--step-0);
margin-top: 0;
Expand Down Expand Up @@ -50,7 +49,6 @@
}
}


.docs-nav-panel {
@media all and (min-width: 1024px) {
display: flex;
Expand Down Expand Up @@ -83,11 +81,9 @@
align-items: center;
margin-left: .5rem;
margin-right: -10px;

margin-inline-start: .5rem;
margin-inline-end: -10px;


svg {
width: 40px;
height: 40px;
Expand Down Expand Up @@ -118,7 +114,6 @@
}

#ham-top {

transform: rotate(41deg);
}

Expand All @@ -128,8 +123,6 @@
}
}



@media all and (min-width: 1024px) {
.docs-site-nav {
flex-direction: row;
Expand All @@ -151,5 +144,4 @@
order: 1;
}
}

}
1 change: 0 additions & 1 deletion docs/src/assets/scss/components/hero.scss
Expand Up @@ -40,7 +40,6 @@
}

.hero--homepage {

.section-title {
margin-bottom: 1.5rem;
margin-block-end: 1.5rem;
Expand Down
1 change: 0 additions & 1 deletion docs/src/assets/scss/components/index.scss
Expand Up @@ -79,7 +79,6 @@
}

#ham-top {

transform: rotate(41deg);
}

Expand Down
3 changes: 1 addition & 2 deletions docs/src/assets/scss/components/language-switcher.scss
Expand Up @@ -18,8 +18,7 @@
flex: 1 0 10ch;
}


.switcher--language .switcher__select {
.switcher--language .switcher__select {
flex: 1 0 12rem;

@media all and (max-width: 800px) {
Expand Down
4 changes: 0 additions & 4 deletions docs/src/assets/scss/components/resources.scss
Expand Up @@ -7,14 +7,12 @@
overflow: hidden;
margin-bottom: .5rem;
margin-block-end: .5rem;

position: relative;
transition: all .2s linear;

&:hover {
background-color: var(--lighter-background-color);
}

}

.resource__image {
Expand All @@ -27,7 +25,6 @@
display: block;
height: 100%;
width: 100%;
// object-fit: cover;
object-fit: contain;
}
}
Expand All @@ -38,7 +35,6 @@
align-self: center;
}


.resource__title { // a
text-decoration: none;
color: var(--headings-color);
Expand Down
11 changes: 5 additions & 6 deletions docs/src/assets/scss/components/rules.scss
Expand Up @@ -13,24 +13,24 @@
background: none;
border: none;

@media screen and (min-width:768px){
@media screen and (min-width: 768px) {
&:not(:first-child)::after {
content: "";
display: block;
padding: 1px;
border-left: 1px solid var(--divider-color);
left: 0px;
left: 0;
}
}

@media screen and (min-width:768px) and (max-width:1023px), screen and (min-width:1440px){
@media screen and (min-width: 768px) and (max-width: 1023px), screen and (min-width: 1440px) {
&:not(:first-child)::after {
height: 70%;
position: absolute;
}
}

@media screen and (min-width:1024px) and (max-width:1439px){
@media screen and (min-width: 1024px) and (max-width: 1439px) {
&:nth-child(2)::after {
height: 70%;
position: absolute;
Expand Down Expand Up @@ -171,7 +171,6 @@ a.rule__name {
}

.related-rules__list__item {

svg {
color: inherit;
}
Expand All @@ -194,7 +193,7 @@ a.rule__name {
}
}

a.rule-list-item+a.rule-list-item::before {
a.rule-list-item + a.rule-list-item::before {
content: ",";
display: inline-block;
margin-left: 5px;
Expand Down
8 changes: 4 additions & 4 deletions docs/src/assets/scss/components/search.scss
Expand Up @@ -4,8 +4,8 @@
appearance: none;
}

[type=search]::-ms-clear,
[type=search]::-ms-reveal {
[type="search"]::-ms-clear,
[type="search"]::-ms-reveal {
display: none;
width: 0;
height: 0;
Expand Down Expand Up @@ -84,6 +84,7 @@
&[data-results="true"] {
padding: 0;
}

&[data-results="false"] {
padding: 1rem;
}
Expand All @@ -110,7 +111,7 @@
background-color: var(--lightest-background-color);
}

&:focus-within{
&:focus-within {
background-color: var(--lightest-background-color);
}
}
Expand All @@ -121,7 +122,6 @@
margin-bottom: 0;
font-family: var(--text-font);


a {
display: block;
text-decoration: none;
Expand Down
7 changes: 1 addition & 6 deletions docs/src/assets/scss/components/tabs.scss
Expand Up @@ -27,11 +27,7 @@
align-items: center;
justify-content: center;
border-radius: var(--border-radius) var(--border-radius) 0 0;

transition: background-color .2s linear,
border-color .2s linear;


transition: background-color .2s linear, border-color .2s linear;

&:hover {
color: var(--link-color);
Expand All @@ -55,7 +51,6 @@
}
}


.c-tabs__tabpanel__title {
margin-bottom: 1.5rem;
margin-block-end: 1.5rem;
Expand Down
2 changes: 0 additions & 2 deletions docs/src/assets/scss/components/toc.scss
Expand Up @@ -105,8 +105,6 @@
}
}



.c-toc__panel {
&[data-open="false"] {
display: none;
Expand Down
1 change: 0 additions & 1 deletion docs/src/assets/scss/docs-header.scss
Expand Up @@ -10,7 +10,6 @@
align-items: start;
padding-top: 0;
padding-bottom: 0;

padding-block-start: 0;
padding-block-end: 0;

Expand Down
4 changes: 0 additions & 4 deletions docs/src/assets/scss/docs.scss
Expand Up @@ -32,7 +32,6 @@ html {
padding-top: var(--space-l-xl);
padding-block-start: var(--space-l-xl);
font-size: .875rem;

display: grid;
grid-auto-rows: max-content;
align-items: start;
Expand All @@ -41,7 +40,6 @@ html {
padding: var(--space-l-xl) 0;
padding-right: var(--space-s-l);
padding-inline-end: var(--space-s-l);

border-right: 1px solid var(--divider-color);
border-inline-end: 1px solid var(--divider-color);
}
Expand Down Expand Up @@ -73,7 +71,6 @@ html {
@media all and (min-width: 800px) {
padding-right: var(--space-s-l);
padding-inline-end: var(--space-s-l);

border-right: 1px solid var(--divider-color);
border-inline-end: 1px solid var(--divider-color);
}
Expand All @@ -83,7 +80,6 @@ html {
}
}


.docs-aside {
grid-column: 2 / 3;
display: flex;
Expand Down
1 change: 0 additions & 1 deletion docs/src/assets/scss/eslint-site-footer.scss
Expand Up @@ -61,5 +61,4 @@
flex-direction: row;
justify-content: space-between;
}

}
1 change: 0 additions & 1 deletion docs/src/assets/scss/eslint-site-header.scss
Expand Up @@ -10,7 +10,6 @@
align-items: start;
padding-top: 0;
padding-bottom: 0;

padding-block-start: 0;
padding-block-end: 0;

Expand Down
5 changes: 2 additions & 3 deletions docs/src/assets/scss/forms.scss
Expand Up @@ -6,7 +6,7 @@
display: block;
width: 100%;
max-width: 100%;
min-width: 0px;
min-width: 0;
padding: .625rem .875rem;
padding-right: calc(.875rem * 2.5);
padding-inline-end: calc(.875rem * 2.5);
Expand All @@ -19,8 +19,7 @@
background-color: var(--body-background-color);
background-image: url("data:image/svg+xml,%3Csvg width='20' height='21' viewBox='0 0 20 21' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M5 7.60938L10 12.6094L15 7.60938' stroke='%23667085' stroke-width='1.66667' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/svg%3E%0A"), linear-gradient(to bottom, var(--body-background-color) 0%, var(--body-background-color) 100%);
background-repeat: no-repeat, repeat;
background-position: right .875rem top 50%,
0 0;
background-position: right .875rem top 50%, 0 0;
background-size: 1em auto, 100%;
}

Expand Down