1. 程式人生 > 程式設計 >CSS程式碼檢查工具stylelint的使用方法詳解

CSS程式碼檢查工具stylelint的使用方法詳解

CSS不能算是嚴格意義的程式語言,但是在前端體系中卻不能小覷。 CSS 是以描述為主的樣式表,如果描述得混亂、沒有規則,對於其他開發者一定是一個定時炸彈,特別是有強迫症的人群。CSS 看似簡單,想要寫出漂亮的 CSS 還是相當困難。所以校驗 CSS 規則的行動迫在眉睫。stylelint是一個強大的現代 CSS 檢測器,可以讓開發者在樣式表中遵循一致的約定和避免錯誤。本文將詳細介紹CSS程式碼檢查工具stylelint

CSS程式碼檢查工具stylelint的使用方法詳解

概述

stylelint擁有超過150條的規則,包括捕捉錯誤、最佳實踐、控制可以使用的語言特性和強制程式碼風格規範。它支援最新的CSS語法,並且靈活可配置

Vue

下面在Vue框架下安裝使用stylelint

1、安裝stylelint、stylint-config-standard和stylelint-order

npm install stylelint --save-dev
npm install stylelint-config-standard --save-dev
npm install stylelint-order --save-dev

其中,stylelint是執行工具,stylelint-config-standard是stylelint的推薦配置,stylelint-order是CSS屬性排序外掛

安裝完成後,package.json檔案中會自動新增如下欄位

"stylelint": "^9.1.3","stylelint-config-standard": "^18.2.0","stylelint-order": "^0.8.1",

2、在根目錄下建立.stylelintrc配置檔案

{ 
"extends": "stylelint-config-standard","plugins": ["stylelint-order"],"rules": {
"order/order": [
"declarations","custom-properties","dollar-variables","rules","at-rules"
],"order/properties-order": [
"position","z-index","top","bottom","left","right","float","clear","columns","columns-width","columns-count","column-rule","column-rule-width","column-rule-style","column-rule-color","column-fill","column-span","column-gap","display","grid","grid-template-rows","grid-template-columns","grid-template-areas","grid-auto-rows","grid-auto-columns","grid-auto-flow","grid-column-gap","grid-row-gap","grid-template","grid-gap","grid-area","grid-row-start","grid-row-end","grid-column-start","grid-column-end","grid-column","grid-row","flex","flex-grow","flex-shrink","flex-basis","flex-flow","flex-direction","flex-wrap","justify-content","align-content","align-items","align-self","order","table-layout","empty-cells","caption-side","border-collapse","border-spacing","list-style","list-style-type","list-style-position","list-style-image","ruby-align","ruby-merge","ruby-position","box-sizing","width","min-width","max-width","height","min-height","max-height","padding","padding-top","padding-right","padding-bottom","padding-left","margin","margin-top","margin-right","margin-bottom","margin-left","border","border-width","border-top-width","border-right-width","border-bottom-width","border-left-width","border-style","border-top-style","border-right-style","border-bottom-style","border-left-style","border-color","border-top-color","border-right-color","border-bottom-color","border-left-color","border-image","border-image-source","border-image-slice","border-image-width","border-image-outset","border-image-repeat","border-top","border-bottom","border-left","border-radius","border-top-right-radius","border-bottom-right-radius","border-bottom-left-radius","border-top-left-radius","outline","outline-width","outline-color","outline-style","outline-offset","overflow","overflow-x","overflow-y","resize","visibility","font","font-style","font-variant","font-weight","font-stretch","font-size","font-family","font-synthesis","font-size-adjust","font-kerning","line-height","text-align","text-align-last","vertical-align","text-overflow","text-justify","text-transform","text-indent","text-emphasis","text-emphasis-style","text-emphasis-color","text-emphasis-position","text-decoration","text-decoration-color","text-decoration-style","text-decoration-line","text-underline-position","text-shadow","white-space","overflow-wrap","word-wrap","word-break","line-break","hyphens","letter-spacing","word-spacing","quotes","tab-size","orphans","writing-mode","text-combine-upright","unicode-bidi","text-orientation","direction","text-rendering","font-feature-settings","font-language-override","image-rendering","image-orientation","image-resolution","shape-image-threshold","shape-outside","shape-margin","color","background","background-image","background-position","background-size","background-repeat","background-origin","background-clip","background-attachment","background-color","background-blend-mode","isolation","clip-path","mask","mask-image","mask-mode","mask-position","mask-size","mask-repeat","mask-origin","mask-clip","mask-composite","mask-type","filter","box-shadow","opacity","transform-style","transform","transform-box","transform-origin","perspective","perspective-origin","backface-visibility","transition","transition-property","transition-duration","transition-timing-function","transition-delay","animation","animation-name","animation-duration","animation-timing-function","animation-delay","animation-iteration-count","animation-direction","animation-fill-mode","animation-play-state","scroll-behavior","scroll-snap-type","scroll-snap-destination","scroll-snap-coordinate","cursor","touch-action","caret-color","ime-mode","object-fit","object-position","content","counter-reset","counter-increment","will-change","pointer-events","all","page-break-before","page-break-after","page-break-inside","widows"
],"no-empty-source": null,"property-no-vendor-prefix": [true,{"ignoreProperties": ["background-clip"]}],"number-leading-zero": "never","number-no-trailing-zeros": true,"length-zero-no-unit": true,"value-list-comma-space-after": "always","declaration-colon-space-after": "always","value-list-max-empty-lines": 0,"shorthand-property-no-redundant-values": true,"declaration-block-no-duplicate-properties": true,"declaration-block-no-redundant-longhand-properties": true,"declaration-block-semicolon-newline-after": "always","block-closing-brace-newline-after": "always","media-feature-colon-space-after": "always","media-feature-range-operator-space-after": "always","at-rule-name-space-after": "always","indentation": 2,"no-eol-whitespace": true,"string-no-newline": null
}
}

3、使用stylelint驗證CSS程式碼即可,如驗證src目錄下的所有vue檔案

CSS程式碼檢查工具stylelint的使用方法詳解

react

react中使用styled-components來書寫CSS程式碼,stylelint同樣提供了外掛來校驗CSS

1、安裝stylelint、stylelint-processor-styled-components、stylelint-config-styled-components、stylelint-config-recommend、stylelint-order

npm install --save-dev [email protected]
npm install --save-dev stylelint-processor-styled-components
npm install --save-dev stylelint-config-styled-components
npm install --save-dev stylelint-config-recommended
npm install --save-dev stylelint-order

注意: 由於stylelint更新到9.2版本後,導致styled-components中的CSS程式碼無法正常校驗,所以穩妥起見,使用9.1.3版本的

CSS程式碼檢查工具stylelint的使用方法詳解

2、在根目錄下新建配置檔案.stylelintrc

{
"processors": ["stylelint-processor-styled-components"],"extends": [
"stylelint-config-recommended","stylelint-config-styled-components"
],...
}

3、同樣地,使用stylelint命令即可校驗

注意事項

1、fix命令

在stylelint的150多條規則中,使用fix命令,可以自動修復一些命令。但是,該fix命令一定要慎用。筆者在使用fix命令後,stylelint將React工程中的所有js檔案裡的程式碼全部清除,只留著了下可以識別的css部分

stylelint '**/*.js' --fix

2、配置scripts

可以在package.json中配置stylelint的快捷方式

"scripts": {
"lintcss": "stylelint 'src/**/*.js'"
}

這樣,使用npm run lintcss 命令即可實現相同效果

3、如果提示如下錯誤

Error: No configuration provided for

是因為在根路徑下沒有發現配置檔案,如.stylelintrc

更多關於CSS程式碼檢查工具stylelint的使用方法請檢視下面的相關連結