kwikqa 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  KwikQA End User License Agreement
2
2
 
3
- Effective 21 October 2026
3
+ Effective 23 October 2026
4
4
  Copyright (c) 2026 KwikQA. All rights reserved.
5
5
 
6
6
  KwikQA is proprietary software. It is not open source, and this agreement does not grant any
@@ -47,8 +47,9 @@ you do not accept, do not install or use the Software.
47
47
  https://kwikqa.com/pricing/. Usage is counted per AI request as described there. Paid plans are
48
48
  sold by Paddle.com, our merchant of record, renew monthly or yearly until cancelled, and are
49
49
  refunded as described at https://kwikqa.com/refunds/, including a full refund of your first
50
- payment if you cancel within 14 days of it. We may change plans or prices with at least 30
51
- days' notice; a change applies from your next billing period after the notice ends.
50
+ payment if you cancel within 14 days of it, once in any 12 months. We may change plans or
51
+ prices with at least 30 days' notice; a change applies from your next billing period after the
52
+ notice ends.
52
53
 
53
54
  5. Your data. You keep all rights in your code, test reports, evidence, and the changes the
54
55
  Software makes to your code. The Software builds a redacted, size-limited evidence packet on
package/README.md CHANGED
@@ -13,6 +13,8 @@ npx kwikqa fix
13
13
  npx kwikqa validate
14
14
  ```
15
15
 
16
+ Using pnpm, Yarn, or Bun? See [Package managers and monorepos](#package-managers-and-monorepos).
17
+
16
18
  ## What it will and won't do
17
19
 
18
20
  - **Diagnoses with evidence.** Every cause it reports cites the report fields, trace events, or source
@@ -34,8 +36,8 @@ npx kwikqa validate
34
36
  ## Requirements
35
37
 
36
38
  - Node.js 20.11 or later
37
- - Playwright Test, Cypress, or WebdriverIO (Mocha or Jasmine) installed in your project. KwikQA
38
- runs your project's own copy and never installs packages or browsers.
39
+ - Playwright Test, Cypress, or WebdriverIO (Mocha or Jasmine) installed in your project with npm,
40
+ pnpm, Yarn, or Bun. KwikQA runs your project's own copy and never installs packages or browsers.
39
41
  - A git repository
40
42
 
41
43
  ## Setup
@@ -92,6 +94,25 @@ failing specs and records each failure's page (see below).
92
94
 
93
95
  `login` signs you in with GitHub; the free plan needs no payment details.
94
96
 
97
+ ### Package managers and monorepos
98
+
99
+ This page uses npm's commands. With another package manager, install and run KwikQA the same way:
100
+
101
+ | | Install | Run |
102
+ | --- | --- | --- |
103
+ | npm | `npm i -D kwikqa` | `npx kwikqa analyze` |
104
+ | pnpm | `pnpm add -D kwikqa` | `pnpm exec kwikqa analyze` |
105
+ | Yarn | `yarn add -D kwikqa` | `yarn kwikqa analyze` |
106
+ | Bun | `bun add -d kwikqa` | `bunx kwikqa analyze` |
107
+
108
+ The commands KwikQA suggests use the same form as the one you ran.
109
+
110
+ In a monorepo, install KwikQA in the package that holds your tests, and run it from that package's
111
+ folder, where its `kwikqa.config.json` goes. KwikQA finds that package's Playwright, Cypress, or
112
+ WebdriverIO wherever your package manager installed it inside the repository, including the root's
113
+ `node_modules`. It never runs one from outside the repository, so pnpm's global virtual store
114
+ (`enableGlobalVirtualStore`) isn't supported.
115
+
95
116
  ## Commands
96
117
 
97
118
  | Command | What it does |
@@ -127,7 +148,7 @@ produced for the same run, so it doesn't use another analysis.
127
148
  The paid plans are coming soon: until they open, every account uses Free.
128
149
 
129
150
  Annual billing gives two months free. Cancel within 14 days of your first payment, monthly or
130
- annual, and it is refunded in full. After that, cancelling an annual plan from the dashboard refunds
151
+ annual, and it is refunded in full, once in any 12 months. After that, cancelling an annual plan from the dashboard refunds
131
152
  its unused months; monthly plans stay active until the end of the paid month. Payments go through
132
153
  Paddle, the merchant of record.
133
154