jourilo 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+Jourilo
+Copyright 2026 Cihan Topaç and Jourilo contributors
+
+This product includes software developed by third parties; see THIRD_PARTY_NOTICES.md.

package/README.md

@@ -1,3 +1,148 @@
-# Temporary Holding Version
+# Jourilo
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**AI-powered product experience & conversion engineering studio.** Jourilo drives a real browser through your
+product, finds UX, accessibility, performance and conversion problems with evidence, traces them to the code that
+causes them, applies safe fixes and proves the result with a before/after run.
+
+Local-first · evidence-driven · no paid services required · works as a CLI and as a Claude Code plugin · Apache-2.0
+
+![Jourilo report overview: defects by severity, conversion hypotheses kept separate, fixes grouped by root cause](docs/assets/report-overview.png)
+
+> Status: **0.1.0, pre-release.** Tested on macOS (Apple Silicon) with Chromium. See [Limitations](docs/LIMITATIONS.md)
+> for what is not covered yet.
+
+## What it does
+
+|                             |                                                                                                                                                                                                                                                                                                                                                     |
+| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Understand**              | `discover` maps a repository (Next.js, Nuxt, SvelteKit, Astro, Remix, React/Vue Router, Laravel, Flutter web, static sites, monorepos) or a live site: routes, dev command, design system, i18n, auth, payments, analytics, roles and candidate journeys. Every fact names the file or page it came from.                                           |
+| **Audit in a real browser** | Playwright + axe-core 4.14 (WCAG 2.0–2.2 A/AA), a keyboard-only walk (focus visible, focus obscured, traps), target size, reflow at 320 px, horizontal overflow, input purpose, paste blocking, form error feedback, lab Web Vitals (LCP, CLS, FCP, TTFB, TBT; INP during journeys), JavaScript errors and failed requests — on desktop and mobile. |
+| **Journeys**                | Reusable JSON scenarios with explicit success criteria, suggested from what the site actually contains, run with a screenshot per step. A safety policy never pays, deletes or cancels on non-local hosts.                                                                                                                                          |
+| **Conversion**              | CTA prominence and clarity, value proposition, trust signals, signup/checkout friction, pricing clarity — always reported as **hypotheses**, never as predicted lifts, with experiment plans and the statistics to read real results.                                                                                                               |
+| **Fix and verify**          | Findings point to likely source lines. `optimize` previews minimal fixes as diffs and applies them only with `--apply` after a git checkpoint. `verify` repeats the exact scope and reports fixed, new and persisting problems.                                                                                                                     |
+| **Report**                  | A self-contained HTML _Experience Observatory_ (screenshots with highlighted elements, reproduction steps, standards, sources, journeys, before/after), plus Markdown for PRs and SARIF for code scanning.                                                                                                                                          |
+
+What Jourilo does **not** do: invent observations, give a single "UX score", claim WCAG compliance from an automated
+run, or predict conversion gains. Each finding is labelled _measured_, _observed_, _heuristic_, _AI inference_ or
+_user input_.
+
+## Quick start
+
+Requires Node.js ≥ 20.10. Jourilo is not on npm yet; install from the repository.
+
+```bash
+git clone https://github.com/cihantopac/jourilo && cd jourilo && npm install
+```
+
+```bash
+node plugin/dist/jourilo.mjs setup
+```
+
+`setup` downloads Playwright's Chromium (one time, ~150 MB). Alternatively use an installed Chrome with
+`--browser chrome`.
+
+Audit a local static build (served on 127.0.0.1) and map findings to its source:
+
+```bash
+node plugin/dist/jourilo.mjs audit ./dist --repo .
+```
+
+Audit a running app or a website (read-only, respects robots.txt):
+
+```bash
+node plugin/dist/jourilo.mjs audit http://localhost:3000 --viewports desktop,mobile,reflow
+```
+
+The report is written to `.jourilo/runs/<run-id>/report.html` (git-ignored). Add `--json` to any command for
+machine-readable output.
+
+### Claude Code plugin
+
+```text
+/plugin marketplace add cihantopac/jourilo
+/plugin install jourilo@jourilo
+```
+
+Then use `/jourilo:jourilo <url or path>` for the full workflow, or `/jourilo:discover`, `/jourilo:audit`,
+`/jourilo:journeys`, `/jourilo:accessibility`, `/jourilo:conversion`, `/jourilo:optimize`, `/jourilo:compare`,
+`/jourilo:report`, `/jourilo:experiment`. Claude Code namespaces plugin commands, so a bare `/jourilo` is available
+by installing the personal skill: `jourilo agent install claude-skill --write`. See [docs/PLUGIN.md](docs/PLUGIN.md).
+
+Other agents: `jourilo agent install codex --write` (adds a section to `AGENTS.md`) or `cursor`
+(`.cursor/rules/jourilo.mdc`).
+
+## The improvement loop
+
+```bash
+jourilo audit http://localhost:3000 --repo .        # evidence + likely source lines
+jourilo journeys suggest latest                     # edit .jourilo/journeys/*.json
+jourilo journeys run --base http://localhost:3000   # step screenshots, success criteria
+jourilo optimize latest --repo .                    # preview minimal diffs (dry run)
+jourilo optimize latest --repo . --apply            # git checkpoint, then write
+jourilo verify <baseline-run>                       # same scope again: fixed / new / persisting
+jourilo rollback latest --yes                       # undo if needed
+```
+
+Measured on the seeded demo app (`fixtures/sites/acme-saas`): `verify` after `optimize --apply` reported 11 findings
+fixed and 0 new; on a page with a late-loading image, adding the measured image size took mobile CLS from 0.121 to 0.
+Fixes are idempotent and fully reversible (see [docs/EVALUATION.md](docs/EVALUATION.md)).
+
+| Finding with evidence and root cause                                                                                                             | Journey storyboard                                                                                                 |
+| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| ![A finding with standard, reproduction steps, likely source line and the element highlighted on the screenshot](docs/assets/report-finding.png) | ![Journeys with a screenshot per step, success criteria and the step that failed](docs/assets/report-journeys.png) |
+
+## Detection quality
+
+**Fixture benchmark** (`jourilo bench`): sites with seeded problems and clean control pages. It fails on any miss,
+false positive or wrong root-cause file. 0.1.0, Chromium, macOS:
+
+| Fixture                                                                                     | Seeded problems found | False positives                           |
+| ------------------------------------------------------------------------------------------- | --------------------- | ----------------------------------------- |
+| `acme-saas` (SaaS marketing, signup, login, slow and shifting pages)                        | 23 / 23               | 0 (root cause in the expected file 9 / 9) |
+| `tr-dukkan` (Turkish shop)                                                                  | 8 / 8                 | 0                                         |
+| `structure-lab` (form grouping, tables, image alternatives; broken and accessible versions) | 4 / 4                 | 0                                         |
+| `widgets-lab` (dialog and disclosure; broken and accessible versions)                       | 3 / 3                 | 0                                         |
+| `brand-site` (locked Markilo brand)                                                         | 3 / 3                 | 0                                         |
+| `clean-shop` (control)                                                                      | —                     | 0                                         |
+
+These fixtures were written alongside the rules, so they show the rules work as designed. For an independent view,
+[`benchmarks/compare`](benchmarks/compare) runs Jourilo, Pa11y and Lighthouse on the 142 published test cases of the
+[GOV.UK accessibility tool audit](https://alphagov.github.io/accessibility-tool-audit/): error-level detections were
+Jourilo 54 (49 counted conservatively), Pa11y 38 and Lighthouse 34, with the same Chromium build. The metric is coarse
+and the comparison influenced Jourilo's rules; read the method and caveats in
+[docs/EVALUATION.md](docs/EVALUATION.md#comparison) before quoting it.
+
+## Safety and privacy
+
+Normal audits are read-only. Crawling stays on the target origin, respects robots.txt and refuses private-network
+targets unless you pass `--allow-private`. Journeys block payments, purchases, deletions and cancellations on any
+non-local host; form submission on non-local hosts needs `--allow-submit`. Password, card and marked fields are masked
+in screenshots; tokens, keys, e-mail addresses and card numbers are redacted from logs and reports. Page content is
+treated as untrusted data and is always HTML-escaped in reports. Details: [docs/PRIVACY.md](docs/PRIVACY.md),
+[SECURITY.md](SECURITY.md).
+
+## Works with Markilo and Searvex (optional)
+
+If a project contains [Markilo](https://github.com/cihantopac/markilo) brand tokens, Jourilo checks buttons and fonts
+against the brand and never recommends changing a locked brand color. If it contains
+[Searvex](https://github.com/cihantopac/searvex) results, search findings for the same pages appear in the report.
+Both are read through a small, versioned, tool-neutral contract, `jourilo.context/v1`
+([docs/INTEGRATIONS.md](docs/INTEGRATIONS.md)). Neither is required.
+
+## Documentation
+
+- [CLI reference](docs/CLI.md) (generated from the code)
+- [Architecture](docs/ARCHITECTURE.md) · [Decisions](docs/DECISIONS.md) · [Requirements and quality targets](docs/REQUIREMENTS.md)
+- [Journeys format](docs/JOURNEYS.md) · [Claude Code plugin and agents](docs/PLUGIN.md) · [Integrations](docs/INTEGRATIONS.md)
+- [Evaluation](docs/EVALUATION.md) · [Limitations](docs/LIMITATIONS.md) · [Roadmap](docs/ROADMAP.md) · [Progress log](docs/PROGRESS.md)
+- Research: [tool landscape](docs/research/landscape.md) · [standards reference](docs/research/standards.md)
+
+## Contributing
+
+Bug reports, fixture sites with real-world UX problems and new rules are welcome. Start with
+[CONTRIBUTING.md](CONTRIBUTING.md). Every rule needs a fixture that proves it fires and a control that proves it does
+not.
+
+## License
+
+[Apache-2.0](LICENSE). Bundled third-party code: see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,27 @@
+# Third-party notices
+
+Jourilo is licensed under Apache-2.0. It uses the following third-party software.
+
+## Bundled in `plugin/dist/jourilo.mjs`
+
+| Package                                           | Version | License | Source                                                                      |
+| ------------------------------------------------- | ------- | ------- | --------------------------------------------------------------------------- |
+| [axe-core](https://github.com/dequelabs/axe-core) | 4.14.0  | MPL-2.0 | <https://github.com/dequelabs/axe-core/tree/v4.14.0>, npm `axe-core@4.14.0` |
+
+axe-core is included unmodified as a whole file (its original copyright header is preserved inside the bundle). Its
+license text is shipped at `plugin/dist/licenses/axe-core-LICENSE.txt`, and the notices for software axe-core itself
+includes at `plugin/dist/licenses/axe-core-LICENSE-3RD-PARTY.txt`. Under MPL-2.0 the source code of axe-core is
+available from the links above.
+
+## Runtime dependency (installed, not bundled)
+
+| Package                                                    | Version | License    | Source                       |
+| ---------------------------------------------------------- | ------- | ---------- | ---------------------------- |
+| [playwright-core](https://github.com/microsoft/playwright) | 1.64.1  | Apache-2.0 | npm `playwright-core@1.64.1` |
+
+Browsers downloaded by `jourilo setup` (Chromium, Firefox, WebKit builds from the Playwright project) are subject to
+their own licenses; see <https://playwright.dev/docs/browsers>.
+
+## Development only (not distributed)
+
+TypeScript, esbuild, Vitest, Biome, tsx and @types/node, each under its own license (Apache-2.0 or MIT).

package/package.json

@@ -1,6 +1,66 @@
 {
   "name": "jourilo",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "AI-powered product experience & conversion engineering studio: real-browser journeys, UX, accessibility, performance and conversion audits with evidence, root causes and verified fixes.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "author": "Cihan Topaç (https://github.com/cihantopac)",
+  "homepage": "https://github.com/cihantopac/jourilo#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cihantopac/jourilo.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cihantopac/jourilo/issues"
+  },
+  "keywords": [
+    "ux",
+    "accessibility",
+    "wcag",
+    "playwright",
+    "conversion",
+    "core-web-vitals",
+    "user-journeys",
+    "claude-code",
+    "claude-code-plugin"
+  ],
+  "engines": {
+    "node": ">=20.10"
+  },
+  "bin": {
+    "jourilo": "plugin/dist/jourilo.mjs"
+  },
+  "files": [
+    "plugin",
+    "schemas",
+    "LICENSE",
+    "NOTICE",
+    "THIRD_PARTY_NOTICES.md",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "dev": "node scripts/build.mjs && node plugin/dist/jourilo.mjs",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check .",
+    "format": "biome check --write .",
+    "test": "vitest run",
+    "test:unit": "vitest run --project unit",
+    "test:browser": "vitest run --project browser",
+    "bench": "node plugin/dist/jourilo.mjs bench fixtures/sites",
+    "check:dist": "node scripts/check-dist.mjs",
+    "validate:plugin": "claude plugin validate . --strict && claude plugin validate plugin --strict",
+    "ci": "npm run lint && npm run typecheck && npm run build && npm test && npm run check:dist"
+  },
+  "dependencies": {
+    "playwright-core": "1.64.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.6.4",
+    "@types/node": "22.20.5",
+    "axe-core": "4.14.0",
+    "esbuild": "0.28.2",
+    "typescript": "7.0.2",
+    "vitest": "5.0.5"
+  }
+}

package/plugin/.claude-plugin/plugin.json

@@ -0,0 +1,23 @@
+{
+  "name": "jourilo",
+  "displayName": "Jourilo",
+  "version": "0.1.0",
+  "description": "AI-powered product experience & conversion engineering studio: discovers products and user journeys, operates real interfaces in Playwright, detects UX, accessibility (WCAG 2.2), performance and conversion problems with evidence, locates root causes, applies safe fixes and verifies them.",
+  "author": {
+    "name": "Cihan Topaç",
+    "url": "https://github.com/cihantopac"
+  },
+  "homepage": "https://github.com/cihantopac/jourilo",
+  "repository": "https://github.com/cihantopac/jourilo",
+  "license": "Apache-2.0",
+  "keywords": [
+    "ux",
+    "accessibility",
+    "wcag",
+    "playwright",
+    "user-journeys",
+    "conversion",
+    "core-web-vitals",
+    "experimentation"
+  ]
+}