https://github.com/moxio/checkstyle-filter-by-name

https://github.com/moxio/checkstyle-filter-by-name

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/moxio/checkstyle-filter-by-name
• Owner: Moxio
• License: mit
• Created: 2021-09-16T12:06:29.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-26T10:56:03.000Z (10 months ago)
• Last Synced: 2024-12-24T02:09:56.227Z (3 days ago)
• Language: TypeScript
• Size: 164 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Continuous Integration](https://github.com/Moxio/checkstyle-filter-by-name/actions/workflows/ci.yml/badge.svg)](https://github.com/Moxio/checkstyle-filter-by-name/actions/workflows/ci.yml)

[![NPM version](https://img.shields.io/npm/v/checkstyle-filter.svg)](https://www.npmjs.com/package/checkstyle-filter-by-name)

checkstyle-filter-by-name

===================

Library for filtering rules from a checkstyle file

Installation

------------

This library can be installed from the NPM package registry.

Depending on your use case it might be better to install this package globally

(if you want to run these commands from your continuous integration server for example)

Using NPM:

```

npm install checkstyle-filter-by-name

```

or Yarn

```

yarn add checkstyle-filter-by-name

```

Usage

-----

From the command line you can run this command

```

./node_modules/.bin/checkstyle-filter-by-name -i [filename] -o [filename] -e [exclude regex]"

```

There are three command line arguments:

| short arg | long arg | effect  |

|---|---|---|

| -i | --input | the file to read from |

| -o | --output | the file to write to, option, if not included will write to input file |

| -e | --exclude | the javascript regex to determine which checkstyle entries get excluded |

Provided filters

--------------

### -e --exclude

Passing along the -e or --exclude flag will exclude entries within the checkstyle file that match the given regular expression.

A check is performed using standard javascript regexp: `RegExp(..passes argument..).test(..checkstyle entry name..)`.

If this function returns true the file is skipped.

#### example

Given a file with these rules:

```xml

	

		

	

	

		

	

```

Running this command:

`checkstyle-filter-by-name -i typescript-error.xml -e "node_modules\\/"`

Will result in a file with these rules:

```xml

	

		

	

```

Versioning

----------

This project adheres to [Semantic Versioning](http://semver.org/).

Contributing

------------

Contributions to this project are more than welcome.

License

-------

This project is released under the MIT license.

Treeware

--------

This package is [Treeware](https://treeware.earth/). If you use it in production,

then we'd appreciate it if you [**buy the world a tree**](https://plant.treeware.earth/Moxio/checkstyle-filter-by-name)

to thank us for our work. By contributing to the Treeware forest you'll be creating

employment for local families and restoring wildlife habitats.

---

Made with love, coffee and fun by the [Moxio](https://www.moxio.com) team from

Delft, The Netherlands. Interested in joining our awesome team? Check out our

[vacancies](https://werkenbij.moxio.com/) (in Dutch).