Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yegor256/xcop
Command Line Style Checker of XML Documents: to make sure they are always formatted nicely
https://github.com/yegor256/xcop
html ruby static-analysis xml xml-format xsl xslt
Last synced: 18 days ago
JSON representation
Command Line Style Checker of XML Documents: to make sure they are always formatted nicely
- Host: GitHub
- URL: https://github.com/yegor256/xcop
- Owner: yegor256
- License: mit
- Created: 2017-08-24T13:37:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T17:21:27.000Z (about 1 year ago)
- Last Synced: 2024-09-20T08:08:01.703Z (about 2 months ago)
- Topics: html, ruby, static-analysis, xml, xml-format, xsl, xslt
- Language: Ruby
- Homepage: https://www.yegor256.com/2017/08/29/xcop.html
- Size: 127 KB
- Stars: 28
- Watchers: 6
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.elegantobjects.org)
[](http://www.rultor.com/p/yegor256/xcop)
[](https://www.jetbrains.com/ruby/)
[](https://github.com/yegor256/xcop/actions/workflows/rake.yml)
[](http://www.0pdd.com/p?name=yegor256/xcop)
[](http://badge.fury.io/rb/xcop)
[](https://github.com/yegor256/xcop/blob/master/LICENSE.txt)
[](https://codeclimate.com/github/yegor256/xcop/maintainability)
[](https://codecov.io/github/yegor256/xcop?branch=master)
[](https://hitsofcode.com/view/github/yegor256/xcop)
This command line tool validates your XML files for proper formatting.
If they are not formatted correctly, it prints the difference and
exits with an error. You can use it two ways: 1) to fail your build
if any XML-ish files (for example, XML, XSD, XSL, or XHTML) are not formatted correctly,
and 2) to format them correctly using `--fix` option.
Read this blog post first:
[_XCOP—XML Style Checker_](https://www.yegor256.com/2017/08/29/xcop.html).
Make sure you have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/)
and then install the tool:
```bash
$ gem install xcop
```
Run it locally and read its output:
```bash
$ xcop --help
```
To validate formatting of your XML files just pass their names
as arguments:
```bash
$ xcop file1.xml file2.xml
```
If your files are not formatted correctly and `xcop` complains, you
can ask it to "beautify" them, using `--fix` option:
```bash
$ xcop --fix broken-file.xml
```
To fix all files in the directory you can do
([won't work](https://askubuntu.com/questions/343727/) if your file names contain spaces):
```bash
$ xcop --fix $(find . -name '*.xml')
```
## Defaults
You can put command line options into `.xcop` file in the directory
where you start `xcop`. Each option should take a single line in the file.
They all will be _added_ to the list of options you specify. For example,
as it was suggested in [this blog post](https://www.yegor256.com/2022/07/20/command-line-defaults.html):
```
--license=LICENSE.txt
--nocolor
--quiet
--include=**/*
--exclude=**/*.xsl
--exclude=**/*.html
```
You can also create `~/.xcop` file (in your personal home directory), which
will also be read and _added_ to the command line options.
## How to use in `Rakefile`?
This is what you need there:
```ruby
require 'xcop/rake_task'
desc 'Run XCop on all XML/XSL files in all directories'
Xcop::RakeTask.new(:xcop) do |task|
task.license = 'LICENSE.txt' # no license by default
task.quiet = true # FALSE by default
task.includes = ['**/*.xml', '**/*.xsl'] # xml|xsd|xhtml|xsl|html by default
task.excludes = ['target/**/*'] # empty by default
end
```
## How to use as GitHub action?
Create new workflow file in repository under `.github/workflows/xcop.yml`:
```yaml
---
name: XCOP
"on":
# run on push to master events
push:
branches:
- master
# run on pull requests to master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: g4s8/xcop-action@master
```
To customize license location or files pattern use action inputs `license` and `files`:
```yaml
- uses: g4s8/xcop-action@master
with:
license: MY_LICENSE.txt
files: "src/*.xml"
```
## How to use in Maven `pom.xml`?
You can integrate it with the help of
[maven-antrun-plugin](http://maven.apache.org/plugins/maven-antrun-plugin/):
```xml
[...]
[...]
[...]
maven-antrun-plugin
1.8
verify
run
```
## How to use in Ant `project.xml`?
Something like this should work:
```xml
[...]
```
## How to contribute
Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure you build is green before you contribute
your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
[Bundler](https://bundler.io/) installed. Then:
```
$ bundle update
$ bundle exec rake
```
If it's clean and you don't see any error messages, submit your pull request.