{"id":20597510,"url":"https://github.com/gerrproger/ringmaster","last_synced_at":"2025-04-15T00:15:18.340Z","repository":{"id":68419207,"uuid":"604320356","full_name":"Gerrproger/ringmaster","owner":"Gerrproger","description":"CLI package for testing websites \u0026 checking their contents","archived":false,"fork":false,"pushed_at":"2025-04-10T22:36:53.000Z","size":107865,"stargazers_count":1,"open_issues_count":13,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T00:14:56.643Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/Gerrproger.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}},"created_at":"2023-02-20T20:08:58.000Z","updated_at":"2023-05-26T05:06:16.000Z","dependencies_parsed_at":"2024-03-13T03:26:33.304Z","dependency_job_id":"066eeb80-d574-4a4d-a6f6-a0521e0c08ee","html_url":"https://github.com/Gerrproger/ringmaster","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"053447946e5f50f7bb87f39a857fc5ccad5618d8"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gerrproger%2Fringmaster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gerrproger%2Fringmaster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gerrproger%2Fringmaster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gerrproger%2Fringmaster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gerrproger","download_url":"https://codeload.github.com/Gerrproger/ringmaster/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981268,"owners_count":21193147,"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-11-16T08:22:47.677Z","updated_at":"2025-04-15T00:15:18.295Z","avatar_url":"https://github.com/Gerrproger.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ringmaster\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./ringmaster-logo.png\" width=\"100px\"\u003e\u003cbr\u003e\n  \u003cb\u003eCLI package for testing websites \u0026 checking their contents.\u003c/b\u003e\n\u003c/p\u003e\n \n## Usage\n\nInstall package: `npm install ringmaster -g` | `yarn global add ringmaster`.\\\nRun `ringmaster` from CLI.\n\nOr, you can download and launch it directly from the **[Releases](https://github.com/Gerrproger/ringmaster/releases/)**.\\\nDo not forget to make the file executable: `chmod +x ringmaster-macos-arm64`.\n\nIt will search your config files in the folder `./_tests` by default.\\\nYou can pass desired folders as arguments: `ringmaster ./tests-folder ~/another-folder`.\\\nOr, you can pass folders as `--dir` option: `ringmaster --dir dir1 --dir dir2`.\n\nResult files are exported to the `./_results` folder by default.\\\nYou can change it with `--output` option: `ringmaster --no-output`.\n\n### Options\n\nYou can use options with this library, for example: `ringmaster --sample`.\n\n**Supported options:**\n\n- `--help` - displays help for commands.\n- `--version` - displays package version.\n- `--interactive` - launches package in interactive mode.\n- `--sample` - adds sample directory to `dirs`.\n\nAnd other options from the **[CLI options list](./docs/schema_cli-properties-options.md)** (that will override options of all included test suits).\n\n### Configuration\n\nThe library uses JSON schemas to configure tests cases.\\\nYou need to always have a `config.json` file with the main test suit **[Configuration](./docs/schema_config.md)**.\n\nFor test cases, you need a separate config file for each test type.\n\n**Supported test types:**\n\n- **[Selectors](./docs/schema_selectors.md)**\n- **[Visual](./docs/schema_visual.md)**\n\nYou can configure actions to perform before the test check through the **[Before](./docs/schema_before.md)** section.\n\n### Example\n\nCheck out **[sample-test folder](./sample-test)**.\n\n## Development \u0026 Testing\n\n### Installation\n\nClone repo: `git clone https://github.com/Gerrproger/ringmaster.git`.\\\nInstall dependencies: `npm install` | `yarn install`.\\\nRun command: `npm run start` | `yarn start`.\\\nPass arguments casually: `npm run start -- --sample` | `yarn start --sample`.\n\nOr you can link package: `npm link`.\\\nThen just use command `ringmaster` from CLI.\\\nTo uninstall the linked package, run: `npm uninstall -g ringmaster`.\n\n### Building\n\nTo build executables and schema docs, run: `npm run build` | `yarn build`.\n\n### Testing\n\nTo run tests, use: `npm run test` | `yarn test`.\n\n### TODO\n\n- Add new test types (~~visual via screenshots~~, content comparison).\n- Make it possible to declare configs directly as objects and not only from files.\n- Add exported config file formats and not only JSON (config.js/.mjs/.cjs).\n- Write more tests with coverage.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgerrproger%2Fringmaster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgerrproger%2Fringmaster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgerrproger%2Fringmaster/lists"}