{"id":13779888,"url":"https://github.com/HaxeCheckstyle/haxe-checkstyle","last_synced_at":"2025-05-11T13:31:17.902Z","repository":{"id":46079641,"uuid":"31724041","full_name":"HaxeCheckstyle/haxe-checkstyle","owner":"HaxeCheckstyle","description":"Haxe Checkstyle","archived":false,"fork":false,"pushed_at":"2024-10-28T16:34:54.000Z","size":4213,"stargazers_count":124,"open_issues_count":29,"forks_count":27,"subscribers_count":8,"default_branch":"dev","last_synced_at":"2024-10-28T17:51:03.996Z","etag":null,"topics":["checkstyle","haxe","static-analysis"],"latest_commit_sha":null,"homepage":"http://haxecheckstyle.github.io/docs","language":"Haxe","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/HaxeCheckstyle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2015-03-05T16:38:56.000Z","updated_at":"2024-10-28T16:34:58.000Z","dependencies_parsed_at":"2023-11-09T01:26:42.275Z","dependency_job_id":"bbcb60df-00ed-4a12-a215-060b2fd8927b","html_url":"https://github.com/HaxeCheckstyle/haxe-checkstyle","commit_stats":{"total_commits":1208,"total_committers":16,"mean_commits":75.5,"dds":0.6051324503311258,"last_synced_commit":"7e6e5883c1efe74038bea07ae47e1ccf9f5edcb2"},"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeCheckstyle%2Fhaxe-checkstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeCheckstyle%2Fhaxe-checkstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeCheckstyle%2Fhaxe-checkstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HaxeCheckstyle%2Fhaxe-checkstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HaxeCheckstyle","download_url":"https://codeload.github.com/HaxeCheckstyle/haxe-checkstyle/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225056744,"owners_count":17414198,"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":["checkstyle","haxe","static-analysis"],"created_at":"2024-08-03T18:01:10.233Z","updated_at":"2024-11-17T15:30:45.691Z","avatar_url":"https://github.com/HaxeCheckstyle.png","language":"Haxe","funding_links":[],"categories":["Linters"],"sub_categories":["Haxe"],"readme":"![logo](resources/logo.png)\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)\n[![Release](https://img.shields.io/github/release/HaxeCheckstyle/haxe-checkstyle.svg)](http://lib.haxe.org/p/checkstyle/)\n[![Haxe-Checkstyle Linux](https://github.com/HaxeCheckstyle/haxe-checkstyle/workflows/Haxe-Checkstyle%20Linux/badge.svg)](https://github.com/HaxeCheckstyle/haxe-checkstyle/actions)\n[![Codecov](https://img.shields.io/codecov/c/github/HaxeCheckstyle/haxe-checkstyle.svg)](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle?branch=dev)\n\u003c!-- [![Code Climate](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle)\n[![Code Climate Issues](https://img.shields.io/codeclimate/issues/HaxeCheckstyle/haxe-checkstyle.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/issues)\n[![Code Climate Issues](https://img.shields.io/codeclimate/tech-debt/HaxeCheckstyle/haxe-checkstyle.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/issues) --\u003e\n\n**Haxe Checkstyle** is a static analysis tool to help developers write Haxe code that adheres to a coding standard.\n\nIt automates the process of checking Haxe code to spare developers of this boring (but important) task.\n\nCode conventions improve readability, allowing team members to understand each other's code better.\n\nIdeal for any project that wants to enforce coding conventions.\n\nStatic analysis is usually performed as part of a code review.\n\n### Code Climate\n\nHaxe Checkstyle is available on the [Code Climate](https://docs.codeclimate.com/docs/haxe-checkstyle) platform (free for open source projects). It requires a **`.codeclimate.yml`** file and an optional but recommended **`checkstyle.json`** file to be added to the root of your repository - see [here](https://docs.codeclimate.com/docs/haxe-checkstyle) for more details.\n\nWhen everything is set up, Code Climate automatically runs Haxe Checkstyle for you on each new commit (also on pull requests if configured that way).\n\nThe current number of issues can be tracked via a badge:\n\n\u003c!-- [![Code Climate](https://img.shields.io/codeclimate/issues/HaxeCheckstyle/haxe-checkstyle.svg)](https://codeclimate.com/github/HaxeCheckstyle/haxe-checkstyle/issues) --\u003e\n\nImmediate results, right in your pull requests.\n\n![codeclimate-pr](resources/codeclimate_pr.png)\n\n### Installation\n\n```bash\nhaxelib install checkstyle\n```\n\n### Basic Usage\n\n```bash\nhaxelib run checkstyle -s src\n```\n\n### Automatic detection of your coding style (experimental)\n\n```bash\nhaxelib run checkstyle -s src --detect detectedCheckstyle.json\n```\n\n### VSCode integration\n\nThere is a VSCode extension for haxe-checkstyle available in the VSCode marketplace. It is currently built with haxe-checkstyle v2.4.1 and tokentree v1.0.1. You can view the development version here: [vscode-checkstyle](https://github.com/vshaxe/vscode-checkstyle)\n\n### Compiling checkstyle\n\n```bash\ngit clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git\nnpm install\nlix download\nhaxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema\nhaxe buildCpp.hxml # for C++ version\n```\n\nCompiling with Haxe 3\n\n```bash\ngit clone https://github.com/HaxeCheckstyle/haxe-checkstyle.git\nmv haxe_libraries haxe4_libraries\nmv haxe3_libraries haxe_libraries\nnpm install\nlix use haxe 3.4.7\nlix download\nhaxe buildAll.hxml # for Neko and NodeJS version + run Unittests and create schema\nhaxe buildCpp.hxml # for C++ version\n```\n\n### Reference\n\n[More information and reference](http://haxecheckstyle.github.io/docs).\n\n### Issues [![Stories in Ready](https://badge.waffle.io/HaxeCheckstyle/haxe-checkstyle.svg?label=ready\u0026title=Ready)](http://waffle.io/HaxeCheckstyle/haxe-checkstyle)\n\nFound any bug? Please create a new [issue](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/new).\n\n### Coverage\n\n![codecov.io](https://codecov.io/github/HaxeCheckstyle/haxe-checkstyle/branch.svg?branch=dev)\n\n### Licensing Information\n\nThis content is released under the [MIT](http://opensource.org/licenses/MIT) license.\n\nThis project was derived from [haxelint](https://github.com/mcheshkov/haxelint)\ncreated by [@mcheshkov](https://github.com/mcheshkov).\n\n### Contributor Code of Conduct\n\n[Code of Conduct](https://github.com/CoralineAda/contributor_covenant) is adapted from\n[Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeCheckstyle%2Fhaxe-checkstyle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHaxeCheckstyle%2Fhaxe-checkstyle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHaxeCheckstyle%2Fhaxe-checkstyle/lists"}