{"id":13537412,"url":"https://github.com/rlaffers/xstate-ninja","last_synced_at":"2026-01-12T12:36:32.801Z","repository":{"id":59671104,"uuid":"497610024","full_name":"rlaffers/xstate-ninja","owner":"rlaffers","description":"Devtool for XState state machines","archived":false,"fork":false,"pushed_at":"2023-10-21T18:45:48.000Z","size":1894,"stargazers_count":74,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-09T01:47:03.009Z","etag":null,"topics":["devtools-extension","fsm","hacktoberfest","javascript","state-machines","statecharts","xstate"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rlaffers.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}},"created_at":"2022-05-29T14:10:59.000Z","updated_at":"2025-06-05T19:34:09.000Z","dependencies_parsed_at":"2023-09-30T20:29:38.336Z","dependency_job_id":"baf7cc82-7e37-4b98-9d5d-009844fbb2d6","html_url":"https://github.com/rlaffers/xstate-ninja","commit_stats":{"total_commits":223,"total_committers":1,"mean_commits":223.0,"dds":0.0,"last_synced_commit":"d0def5a5126866da490b23ce9bd4d956c7f17b3a"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/rlaffers/xstate-ninja","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rlaffers%2Fxstate-ninja","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rlaffers%2Fxstate-ninja/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rlaffers%2Fxstate-ninja/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rlaffers%2Fxstate-ninja/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rlaffers","download_url":"https://codeload.github.com/rlaffers/xstate-ninja/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rlaffers%2Fxstate-ninja/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["devtools-extension","fsm","hacktoberfest","javascript","state-machines","statecharts","xstate"],"created_at":"2024-08-01T09:00:58.780Z","updated_at":"2026-01-12T12:36:32.784Z","avatar_url":"https://github.com/rlaffers.png","language":"TypeScript","funding_links":[],"categories":["Awesome XState"],"sub_categories":["Tools"],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eXState Ninja\u003c/h1\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/489018/182801436-1a9c7cfd-9c67-4343-a430-17ec63f0ff3b.png\" alt=\"logo\" /\u003e\n  \u003cp\u003eA dedicated devtool for XState state machines.\u003c/p\u003e\n  \u003cp\u003e    \n    \u003ca href=\"https://github.com/rlaffers/xstate-ninja/actions/workflows/main.yml\"\u003e\n      \u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/rlaffers/xstate-ninja/main.yml\"\u003e\n    \u003c/a\u003e\n \u003ca href=\"https://github.com/support-ukraine/support-ukraine\"\u003e\u003cimg src=\"https://bit.ly/support-ukraine-now\" alt=\"Support Ukraine\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/prettier/prettier\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\" alt=\"code style: prettier\" /\u003e\u003c/a\u003e\n    \u003ca href=\"http://makeapullrequest.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\" alt=\"PRs Welcome\" /\u003e\u003c/a\u003e\n  \u003c/p\u003e\n  \u003chr/\u003e\n\u003c/div\u003e\n\n## Screenshots\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/489018/193230455-1499360e-79b4-4e38-903c-befd6d311eb6.png\" alt=\"screenshot\" /\u003e\n\u003c/div\u003e\n\n## Quick Start\n\n1. Install the browser extension from the [Chrome Web Store](https://chrome.google.com/webstore/detail/xstate-ninja/cogeldipmkjdfjgjkghlmhehejpmcfif) or [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/xstate-ninja/).\n2. Install the xstate-ninja package in your project:\n\n```bash\nnpm install --save xstate-ninja xstate\n```\n\n3. Interpret your state machine with the provided **interpret** function:\n\n```javascript\nimport { interpret } from 'xstate-ninja'\nconst actor = interpret(machine, { devTools: true })\n```\n\nFor React integration, check the [@xstate-ninja/react](https://github.com/rlaffers/xstate-ninja/tree/master/packages/xstate-ninja-react) library.\nFor Vue integration, check the [@xstate-ninja/vue](https://github.com/rlaffers/xstate-ninja/tree/master/packages/xstate-ninja-vue) library.\n\n## How it works\n\nThe **interpret** function is just a thin wrapper around the [core interpreter](https://xstate.js.org/docs/guides/interpretation.html#interpreter) provided by the XState library. It accepts the same argument as the XState's `interpret` function. It observes your state machines and sends updates to the XState Ninja browser extension.\n\n## Configuration\n\nTo change default settings, import the XState Ninja instance in your project's index file:\n\n```javascript\n// in your index.ts\nimport { configure, LogLevels } from 'xstate-ninja'\n\nconfigure({\n  enabled: process.env.NODE_ENV !== 'production',\n  logLevel: LogLevels.debug,\n})\n```\n\nXState Ninja is a singleton, so wherever you change these settings, they will be applied throughout your application.\n\n### `enabled`\n\n**Type: boolean**\n\n**Default: `true`**\n\nTurns XState Ninja on or off. By default, tracking is always on. You may want to disable tracking in the production mode to improve performance.\n\n### `logLevel`\n\n**Type: LogLevels enum**\n\n**Default: `LogLevels.error`**\n\nControls how much stuff is logged into console by XState Ninja.\n\n## Upgrading from v1 → v2\n\nIf you were using the default export to configure XState Ninja, replace it with the `configure` function:\n\n```javascript\n// ❌ DEPRECATED xstate-ninja v1\nimport XStateNinja from 'xstate-ninja'\nXStateNinja({ enabled: false })\n\n// ✅ xstate-ninja v2\nimport { configure } from 'xstate-ninja'\nconfigure({ enabled: false })\n```\n\n## Attribution\n\n[Ninja icons created by Good Ware - Flaticon](https://www.flaticon.com/free-icons/ninja)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frlaffers%2Fxstate-ninja","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frlaffers%2Fxstate-ninja","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frlaffers%2Fxstate-ninja/lists"}