README.md

FECS

FECS 是基于 Node.js 的前端代码风格工具。

安装

    $ [sudo] npm install fecs -g

使用

    fecs
    fecs -v
    fecs check --help
    fecs format --help

更多参数见 wiki: CLI

API

fecs.leadName

设置或获取控制台输出信息前的名称，默认值为 fecs。

var fecs = require('fecs');
fecs.leadName = 'edp';
...

fecs.getOptions(Array argv)

获取经 minimist 解释后的命令行参数对象，可用于 fecs.check 和 fecs.format 方法。

var options = fecs.getOptions(process.argv.slice(2));

console.log(options.command); // 'check'
...

fecs.check(Object options[, Function done])

检查文件或输入流的代码规范。

// 设置检查的文件路径
options._ = ['/path/to/check'];

// 或者设置为 stream
// options.stream = yourReadableStream;

// 设置文件类型
// options.type = 'js,css';


/**
 * callback after check finish
 *
 * @param {boolean} success true as all files ok, or false.
 * @param {Object[]} errors data for check result.
 */
function done(success, errors) {
    // blablabla
}

fecs.check(options, done);

fecs.format(Object options)

格式化、修复文件或输入流的代码。

fecs.check(options);

工具支持

• VIM

• WebStorm

• Eclipse

• Sublime Text 2/3 Baidu FE Code Style Sublime Helper SublimeLinter-contrib-fecs

• Visual Studio Code fecs-visual-studio-code vscode-fecs(中文)

• Atom

• Emacs

• Grunt

• Gulp

• Git Hook

常见问题

• https://github.com/ecomfe/fecs/wiki/FAQ
• https://github.com/ecomfe/fecs/wiki/HowToFix

更多信息请访问 https://github.com/ecomfe/fecs/wiki