{"id":26395701,"url":"https://github.com/tamada/omelette","last_synced_at":"2025-06-14T13:05:12.510Z","repository":{"id":56576778,"uuid":"254870817","full_name":"tamada/omelette","owner":"tamada","description":"Unit tests runner/coverage calculator on the CLI environment for the Java platform.","archived":false,"fork":false,"pushed_at":"2020-10-30T14:45:29.000Z","size":1092,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T11:19:00.446Z","etag":null,"topics":["coverage","jacoco","java","junit4","unittest"],"latest_commit_sha":null,"homepage":"https://tamada.github.io/omelette","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tamada.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}},"created_at":"2020-04-11T13:12:51.000Z","updated_at":"2020-07-17T02:13:18.000Z","dependencies_parsed_at":"2022-08-15T21:20:20.027Z","dependency_job_id":null,"html_url":"https://github.com/tamada/omelette","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tamada/omelette","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamada%2Fomelette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamada%2Fomelette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamada%2Fomelette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamada%2Fomelette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tamada","download_url":"https://codeload.github.com/tamada/omelette/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamada%2Fomelette/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259820812,"owners_count":22916548,"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":["coverage","jacoco","java","junit4","unittest"],"created_at":"2025-03-17T11:19:02.389Z","updated_at":"2025-06-14T13:05:12.477Z","avatar_url":"https://github.com/tamada.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![codebeat badge](https://codebeat.co/badges/23134092-de46-44aa-942c-5d4a070eaf3c)](https://codebeat.co/projects/github-com-tamada-omelette-master)\n[![License](https://img.shields.io/badge/License-WTFPL-blue.svg)](https://github.com/tamada/omelette/blob/master/LICENSE)\n[![Version](https://img.shields.io/badge/Version-1.1.1-yellowgreen.svg)](https://github.com/tamada/omelette/releases/tag/v1.1.1)\n\n# Omelette\n\nAn agent for running the unit tests on the CLI environment for the Java platform.\n\n## :speaking_head: Overview\n\nIn the Java platform, we usually run the unit tests through some build tool, such as [Maven](https://maven.apache.org), [Gradle](https://gradle.org), and so on.\nHowever, it is hard to run the unit tests on the CLI environment.\n\nCalculating test coverages is also complicated for novice programmers.\nSince, it requires understanding how to use several libraries (unit test library, coverage measuring library, and the build tool).\n\nRunning the unit tests and calculating test coverages usually requires software projects.\nIt is generally tiresome for calculating test coverages of toy programs with their unit tests.\n\nTherefore, we developed `omelette` for running unit tests and calculating test coverages in the CLI environment for the Java platform.\n\n\n## :runner: Usage\n\n```sh\nomelette version 1.0.0\nomelette [OPTIONS] \u003cPROJECT_DIR\u003e\n    or\nomelette [OPTIONS] -p \u003cPRODUCT_CODE_DIR\u003e -t \u003cTEST_CODE_DIR\u003e [PROJECT_NAME]\nOPTIONS\n    -c, --classpath \u003cPATH\u003e      specifies classpath list separated with a colon, or defines several options.\n    -d, --delete-tempfiles      deletes temporary files after running.\n    -e, --excludes \u003cREGEXP\u003e     specifies target exclusion rules for unit tests. Default is \"\" (no filtering).\n    -i, --includes \u003cREGEXP\u003e     specifies target inclusion rules for unit tests. Default is \"\" (no filtering).\n    -n, --no-coverage           calculates no coverage of test codes.\n    -p, --product-code \u003cDIR\u003e    specifies the directory contains the product codes.\n    -t, --test-code \u003cDIR\u003e       specifies the directory contains the test codes.\n    -v, --verbose               verbose mode.\n\n    -h, --help                  prints this message.\nARGUMENTS\n    PROJECT_DIR                 specifies the directory contains the product codes and the unit test codes.\n    PROJECT_NAME                specifies the project name for destination file. Default is \"unknown\".\n```\n\n### :briefcase: Requirements\n\n* Runtime\n    * bash completion 2.x or later.\n    * Java 10 or later.\n        * [JUnit 4](https://junit.org/junit4/) 4.13, [hamcrest-all](https://mvnrepository.com/artifact/org.hamcrest/hamcrest-all) 1.3\n        * [JaCoCo](https://www.eclemma.org/jacoco/) 0.8.5\n* Development\n    * Go lang 10.x or later.\n    * Dependent Libraries\n        * [pflag](https://github.com/spf13/pflag) v1.0.5\n\n## :anchor: Install\n\n### :beer: Homebrew (macOS)\n\n```sh\nbrew install tamada/brew/omelette\n```\n\n### Go lang\n\n```\ngo get github.com/tamada/omelette\n```\n\nAfter downloading `omelette`, run the following script.\n\n```sh\ncd ~/go/src/github.com/tamada/omelette; ./bin/download_dependencies.sh\n```\n\n### :hammer_and_wrench: Build from source\n\n```sh\ngit clone https://github.com/tamada/omelette.git\ncd omelette\nmake\n```\n\n## :smile: About\n\n### :scroll: License\n\n[Do What The F*ck You Want To Public License](https://github.com/tamada/omelette/blob/master/LICENSE)\n\n[![License](https://img.shields.io/badge/License-WTFPL-blue.svg)](https://github.com/tamada/omelette/blob/master/LICENSE)\n\n* This license permits\n    * :+1: Commercial use,\n    * :+1: Modification,\n    * :+1: Distribution, and\n    * :+1: Private use.\n\n### :man_office_worker: Developers :woman_office_worker:\n\n* [Haruaki Tamada](https://github.com/tamada) [:globe_with_meridians:](https://tamada.github.io)\n\n## :question: Why does the product names omelette?\n\nBecause the lunch was omelette, when I developed this product.\n\n### :handshake: Attributions\n\nIcons made by [Nhor Phai](https://www.flaticon.com/authors/nhor-phai) from [www.flaticon.com](https://www.flaticon.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamada%2Fomelette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftamada%2Fomelette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamada%2Fomelette/lists"}