stylelint - Где есть примеры для создания собственного плагина?

Question

Я зашел на сайт stylelint, github и скачал локально через npm. Сайт stylelint советует, что для создания моего собственного плагина я должен использовать этот формат:

var myPluginRule = stylelint.createPlugin(ruleName, function(primaryOption, secondaryOptionObject) {
  return function(postcssRoot, postcssResult) {
    var validOptions = stylelint.utils.validateOptions(postcssResult, ruleName, { .. })
    if (!validOptions) { return }
    // ... some logic ...
    stylelint.utils.report({ .. })
  }
})

Когда я делаю 'find' внутри папки npm для stylelint, я не могу найти примеры, использующие этот формат. Кто-нибудь может посоветовать действительно хороший учебник по созданию собственного плагина?

Спасибо

Answer 1

Хорошо после игры с этим я буквально нашел способ.

1) предпосылки:

$ npm init
$ npm install gulp stylelint gulp-style-lint --save-dev

2) Создайте несколько файлов scss по адресу./scss/myfile.scss

Тело {фон: красный;}

3) создать./gulpfile.js

var gulp          = require('gulp');
var gulpStylelint = require('gulp-stylelint');

gulp.task('stylelint',function(){
  return gulp        
    .src('./scss/*.scss')
    .pipe(
      gulpStylelint({
        reporters: [
          {formatter: 'string', console: true}
        ]
      })
    );
})

4) создать./stylelintCustom/index.js

var stylelint = require("stylelint");
var ruleName = "steves/steve1";

var messages = stylelint.utils.ruleMessages(ruleName, {
  rejected: 'steve rejects this',
});

module.exports = stylelint.createPlugin(ruleName, function(max, options) {

    return function(root, result) {     
      // to access the variable for the whole of this file scss =           
      console.log(root.source.input);

      // apply rules now...
      // run reporter to output

    }
});

module.exports.ruleName = ruleName;
module.exports.messages = messages;

Обязательно назовите ruleName: "плагины / плагины". то есть стивс / стиверуле1 и т. д.

5) Обязательно создайте stylelintCustom / package.json

{
  "name": "stylelint-steves-steve1", 
  "version": "0.0.1",
  "main": "index.js",
  "devDependencies": {
    "stylelint": "~2.6.0"
  },
  "engines": {
    "node": ">=0.10.0"
  }
}

6) создать: stylelint.rc

{
  "plugins": [
    "./stylelintCustom/index.js"
  ],
  "rules": {
    "steves/steve1": true
  }
}

7) беги глотком

$ gulp stylelint

Выводит scss, так что вы можете запустить любой js, regex, который вам нужен здесь.

Answer 2

Для справки о том, как существующие правила работают в stylelint, вы можете перейти к:

yourproject / node_modules / stylelint / DIST / правила /*