https://github.com/wcandillon/xqlint

JSONiq & XQuery Quality Checker
https://github.com/wcandillon/xqlint

Last synced: about 2 months ago
JSON representation

JSONiq & XQuery Quality Checker

• Host: GitHub
• URL: https://github.com/wcandillon/xqlint
• Owner: wcandillon
• License: apache-2.0
• Created: 2012-11-17T20:15:11.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2023-02-27T22:43:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T05:27:04.368Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 11.3 MB
• Stars: 52
• Watchers: 12
• Forks: 22
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#XQLint

[![NPM version](http://img.shields.io/npm/v/xqlint.svg?style=flat)](http://badge.fury.io/js/xqlint)

## JSONiq & XQuery Code Quality Tool

XQLint parses XQuery & JSONiq files and returns errors and warnings based on static code analysis.

![example](http://i.imgur.com/86jU7C1.png)

## Installation

Install Node.js and NPM for your system (Mac, Windows or Linux). And install the command line tool using:

```bash

$ npm install xqlint -g

```

## Usage

### Lint

```bash

$ xqlint lint  [-s, --style-check ]

```

![result](https://dl.dropboxusercontent.com/u/1487285/Screenshot%202014-04-07%2011.06.31.png)

### Print AST as XML

```bash

$ xqlint ast 

```

### Syntax Highlighting

```bash

$ xqlint highlight 

```

## Development

If you'd like to hack on xqlint itself:

```bash

git clone [email protected]:wcandillon/xqlint.git

cd xqlint

npm install

grunt

```

### Run tests

```bash

grunt vows

```

### Generate Parsers

```bash

grunt parsers

```

## Who is using this project?

* [28.io cli tool](https://github.com/28msec/28)

* [Atom Editor](https://atom.io/packages/language-jsoniq)

* [ACE, aka the Cloud9 editor](https://github.com/ajaxorg/ace), [view demo](http://try.zorba.io).

* [XQLint Grunt Task](https://github.com/wcandillon/grunt-xqlint)

* [XQLint Gulp Plugin](https://github.com/wcandillon/gulp-xqlint)

* [eXide](https://github.com/wolfgangmm/eXide), a web-based XQuery IDE for eXist-db, [view demo](http://exist-db.org/exist/apps/eXide/).

* [atom-existdb](https://github.com/wolfgangmm/atom-existdb), an Atom editor integration package for eXist-db.