在webpack中使用stylelint(一) Quick Start

stylelint

前言


在学习stylelint之前我们需要知道什么是stylelint,以及它解决了什么问题。

如果你已经知道eslint,那么可能看名字你可能就已经猜到了,没错,就像eslintjavascript的语法检查工具一样,stylelintcss的语法检查工具。

下面是官网的解释:

A mighty, modern CSS linter and fixer that helps you avoid errors and enforce consistent conventions in your stylesheets.
一款强大的,时髦的css语法检查和纠错工具,它可以帮助开发者在编写样式文件时避免错误,同时它还可以强迫开发者们形成统一的开发规范。

通过stylelint的使用,可以帮助团队内的小伙伴形成统一的,规范的代码风格,从而降低代码的维护成本。

So,跟着小姐姐一起来学习stylelint吧,高能提示,以下纯干货哦~

文件目录


首先是文件目录,build用来放项目打包相关代码,src是我们的工作目录。

package.json
build
    webpack.config.js
    stylelint.config.js
src
    index.html
    index.js
    index.less

package.json


接下来是package.json,除了依赖我们还定义了一个dev脚本,用来查看样式的效果。

{
  "name": "stylelintStudy",
  "version": "1.0.0",
  "scripts": {
    "dev": "./node_modules/.bin/webpack-dev-server --config ./build/webpack.config.js"
  },
  "devDependencies": {
    "css-loader": "^0.28.7",
    "extract-text-webpack-plugin": "^2.1.2",
    "html-webpack-plugin": "^2.30.1",
    "less": "^2.7.3",
    "less-loader": "^4.0.5",
    "path": "^0.12.7",
    "style-loader": "^0.19.0",
    "stylelint": "^8.2.0",
    "stylelint-webpack-plugin": "^0.9.0",
    "webpack": "^3.8.1",
    "webpack-dev-server": "^2.9.3"
  }
}

webpack.config.js


接下来是webpack的配置文件,插件stylelint-webpack-plugin的配置项接下来会有详细的介绍。

const path = require('path');

const StyleLintPlugin = require('stylelint-webpack-plugin');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextWebpackPlugin = require('extract-text-webpack-plugin');

module.exports = {
    entry: './src/index.js',
    output: {
        path: path.resolve(__dirname, '../dist'),
        filename: 'index.js'
    },
    module: {
        rules: [{
            test: /\.less$/,
            use: ExtractTextWebpackPlugin.extract({
                fallback: 'style-loader',
                use: ['css-loader', 'less-loader']
            })
        }]
    },
    plugins: [
        new ExtractTextWebpackPlugin('index.css'),
        new HtmlWebpackPlugin({
            filename: 'index.html',
            template: 'src/index.html'
        }),
        new StyleLintPlugin({
            context: "src",
            configFile: path.resolve(__dirname, './stylelint.config.js'),
            files: '**/*.less',
            failOnError: false,
            quiet: true,
            syntax: 'less'
        })
    ]
};

stylelint.config.js


我们先写一个规则做测试,"color-no-invalid-hex": true表示必须使用合法的颜色值。

module.exports = {
    "rules": {
        "color-no-invalid-hex": true
    }
};

测试文件


index.html

<!DOCTYPE html>
<html>
    <head>
        <title>Stylelint</title>
    </head>
    <body>
        <div>这是一个学习stylelint的测试页面</div>
    </body>
</html>

index.js

import './index.less';

index.less

@base:46.875rem;

html, body {
    height: 100%;
    background: #f6f6f6;
}

body {
    font-size: 46.875px;
}

div {
    margin-top: 2rem;
    text-align: center;
    font-size: 100/@base;
}

开始运行


这些准备工作好了之后,打开终端,进入文件目录,执行:

npm install
npm run dev

默认端口是8080,8080被占用的情况下会使用其他端口,不管是哪个,终端里面都会有提示,类似于这样:

终端提示

打开http://localhost:8080,查看页面效果:
页面预览

测试


正常运行后,我们可以修改一下less文件的内容来做个测试。

@base:46.875rem;

html, body {
    height: 100%;
    background: #f6;
}

body {
    font-size: 46.875px;
}

div {
    margin-top: 2rem;
    text-align: center;
    font-size: 100/@base;
}

保存后,一切正常的情况下就会看到终端报错:


终端报错

The End


到这里,我们的Quick Start就结束了,怎么样,都跑起来了没?

下一篇,小姐姐将跟大家一起来学习插件stylelint-webpack-plugin,那就酱咯~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,639评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,093评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,079评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,329评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,343评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,047评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,645评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,565评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,095评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,201评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,338评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,014评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,701评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,194评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,320评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,685评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,345评论 2 358

推荐阅读更多精彩内容