https://github.com/xtx1130/icode-style

style sheet for icode
https://github.com/xtx1130/icode-style

Last synced: 3 months ago
JSON representation

style sheet for icode

• Host: GitHub
• URL: https://github.com/xtx1130/icode-style
• Owner: xtx1130
• License: mit
• Created: 2019-01-08T11:10:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-19T02:53:58.000Z (almost 6 years ago)
• Last Synced: 2024-10-04T08:48:10.113Z (3 months ago)
• Language: JavaScript
• Size: 128 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tb-format

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

[![Build Status](https://travis-ci.org/xtx1130/icode-style.svg?branch=master)](https://travis-ci.org/xtx1130/icode-style) 

![license](https://img.shields.io/github/license/xtx1130/icode-style.svg?style=popout)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## 安装

```shell

$ npm i tb-format

```

## 使用

### cli

```shell

$ tbformat (--fix)

```

`--fix` 自动修复

### API

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

```js

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**:

```js

{

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

}

```