tb-format

3.0.11 • Public • Published

tb-format

产出符合icode规范的js和css代码

Build Status license JavaScript Style Guide

安装

$ npm i tb-format

使用

cli

$ tbformat (--fix)

--fix 自动修复

API

由于js lint使用的是esLint,vue和css lint使用的是prettier,所以API有点差异(prettier仅会进行ast解析并产出正确代码,不会去验证lint之前的code是否有lint规范错误问题)

const lint = require('icode-style')
 
/**
 * @param {String} code 需要lint的代码
 * @param {Boolean} isfix 是否需要修复,如果为false则返回Boolean类型(是否符合lint规范),如果为true则返回String类型(lint后的代码)
 * @return {Boolean|String} 
 */
lint.cssLint(code, isfix)
 
/**
 * @param {String} code 需要lint的代码
 * @param {String} filePath 产出文件路径
 * @return {Array} lint的信息以及错误信息 
 */
lint.jsLint(code, filePath)
 
/**
 * @param {String} code 需要lint的代码
 * @param {Boolean} isfix 是否需要修复,如果为false则返回Boolean类型(是否符合lint规范),如果为true则返回String类型(lint后的代码)
 * @return {Boolean|String} 
 */
lint.vueLint(code, isfix)

ignore

可以在pacakge.json中配置ignore的文件或者路径,配置如下,版本差异: 2.x 版本 tbformat 为RegExp, 3.x版本优化为glob:

{
    "tbformat": [".postcssrc.js", "coverage/"] // 本项目只想做开箱即用性质的,主要对接icode style 所以不想加过多配置项
}

Readme

Keywords

Package Sidebar

Install

npm i tb-format

Weekly Downloads

1

Version

3.0.11

License

MIT

Unpacked Size

22 kB

Total Files

14

Last publish

Collaborators

  • xtx1130