{"id":23458233,"url":"https://github.com/moxio/checkstyle-filter-by-name","last_synced_at":"2025-04-11T13:54:48.707Z","repository":{"id":41988241,"uuid":"407149550","full_name":"Moxio/checkstyle-filter-by-name","owner":"Moxio","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-26T10:56:03.000Z","size":168,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T17:45:30.810Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Moxio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-16T12:06:29.000Z","updated_at":"2024-01-12T18:22:45.000Z","dependencies_parsed_at":"2024-02-26T11:53:12.388Z","dependency_job_id":"67f7d078-5a5f-4576-a65e-e6d6d6618c95","html_url":"https://github.com/Moxio/checkstyle-filter-by-name","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moxio%2Fcheckstyle-filter-by-name","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moxio%2Fcheckstyle-filter-by-name/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moxio%2Fcheckstyle-filter-by-name/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moxio%2Fcheckstyle-filter-by-name/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Moxio","download_url":"https://codeload.github.com/Moxio/checkstyle-filter-by-name/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248412150,"owners_count":21099062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-24T05:17:50.782Z","updated_at":"2025-04-11T13:54:48.686Z","avatar_url":"https://github.com/Moxio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"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)\n[![NPM version](https://img.shields.io/npm/v/checkstyle-filter.svg)](https://www.npmjs.com/package/checkstyle-filter-by-name)\n\ncheckstyle-filter-by-name\n===================\nLibrary for filtering rules from a checkstyle file\n\nInstallation\n------------\nThis library can be installed from the NPM package registry.\nDepending on your use case it might be better to install this package globally\n(if you want to run these commands from your continuous integration server for example)\n\nUsing NPM:\n```\nnpm install checkstyle-filter-by-name\n```\nor Yarn\n```\nyarn add checkstyle-filter-by-name\n```\n\nUsage\n-----\nFrom the command line you can run this command\n```\n./node_modules/.bin/checkstyle-filter-by-name -i [filename] -o [filename] -e [exclude regex]\"\n```\nThere are three command line arguments:\n\n| short arg | long arg | effect  |\n|---|---|---|\n| -i | --input | the file to read from |\n| -o | --output | the file to write to, option, if not included will write to input file |\n| -e | --exclude | the javascript regex to determine which checkstyle entries get excluded |\n\nProvided filters\n--------------\n\n### -e --exclude\nPassing along the -e or --exclude flag will exclude entries within the checkstyle file that match the given regular expression.\nA check is performed using standard javascript regexp: `RegExp(..passes argument..).test(..checkstyle entry name..)`.\nIf this function returns true the file is skipped.\n\n#### example\nGiven a file with these rules:\n```xml\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003ccheckstyle version=\"4.3\"\u003e\n\t\u003cfile name=\"node_modules/example/example.d.ts\"\u003e\n\t\t\u003cerror line=\"1\" column=\"1\" severity=\"error\" message=\"Example\" source=\"TS2344\" /\u003e\n\t\u003c/file\u003e\n\t\u003cfile name=\"example/example.d.ts\"\u003e\n\t\t\u003cerror line=\"1\" column=\"1\" severity=\"error\" message=\"Example\" source=\"TS2344\" /\u003e\n\t\u003c/file\u003e\n\u003c/checkstyle\u003e\n```\n\nRunning this command:\n`checkstyle-filter-by-name -i typescript-error.xml -e \"node_modules\\\\/\"`\n\nWill result in a file with these rules:\n```xml\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003ccheckstyle version=\"4.3\"\u003e\n\t\u003cfile name=\"example/example.d.ts\"\u003e\n\t\t\u003cerror line=\"1\" column=\"1\" severity=\"error\" message=\"Example\" source=\"TS2344\" /\u003e\n\t\u003c/file\u003e\n\u003c/checkstyle\u003e\n```\n\nVersioning\n----------\nThis project adheres to [Semantic Versioning](http://semver.org/).\n\nContributing\n------------\nContributions to this project are more than welcome.\n\nLicense\n-------\nThis project is released under the MIT license.\n\nTreeware\n--------\nThis package is [Treeware](https://treeware.earth/). If you use it in production,\nthen we'd appreciate it if you [**buy the world a tree**](https://plant.treeware.earth/Moxio/checkstyle-filter-by-name)\nto thank us for our work. By contributing to the Treeware forest you'll be creating\nemployment for local families and restoring wildlife habitats.\n\n---\nMade with love, coffee and fun by the [Moxio](https://www.moxio.com) team from\nDelft, The Netherlands. Interested in joining our awesome team? Check out our\n[vacancies](https://werkenbij.moxio.com/) (in Dutch).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoxio%2Fcheckstyle-filter-by-name","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoxio%2Fcheckstyle-filter-by-name","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoxio%2Fcheckstyle-filter-by-name/lists"}