automatica11y 0.4.0 → 0.4.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/AGENTS.md CHANGED
@@ -10,6 +10,8 @@ Keep the user's request as they gave it, including the target and any settings t
10
10
  npx --yes automatica11y@latest guide skill
11
11
  ```
12
12
 
13
+ If `automatica11y` is already on the `PATH` (the user ran `npm i -g automatica11y`, and `automatica11y --version` prints a version), you can run `automatica11y guide skill` and `automatica11y guide fixtures` instead, and use `automatica11y` wherever the steps say `npx --yes automatica11y@latest`. The version check in the steps still applies. An installed copy can be older than the steps expect, and then the check stops you. Use `npx` when the installed version is the wrong series, or when nothing is installed.
14
+
13
15
  When the steps tell you to write a fixture, read the fixture guide:
14
16
 
15
17
  ```bash
package/README.md CHANGED
@@ -13,12 +13,22 @@ It's **not** an attestation or certification tool. Automated checks cover only p
13
13
 
14
14
  You need Node 20 or newer and Chrome or Chromium.
15
15
 
16
+ Install it once, and `automatica11y` is on your `PATH`, with the short name `a11y` too:
17
+
18
+ ```bash
19
+ npm i -g automatica11y
20
+ ```
21
+
22
+ Then run it without `npx`:
23
+
16
24
  ```bash
17
- npx automatica11y doctor
18
- npx automatica11y audit https://example.com
19
- npx automatica11y compare radix=npm:@radix-ui/react-dialog aria=npm:react-aria-components
25
+ automatica11y doctor
26
+ automatica11y audit https://example.com
27
+ automatica11y compare radix=npm:@radix-ui/react-dialog aria=npm:react-aria-components
20
28
  ```
21
29
 
30
+ You can skip the install and put `npx` in front instead, for example `npx automatica11y doctor`. `npx` fetches the tool the first time and checks the registry after that. A global install doesn't update itself, so run `npm i -g automatica11y@latest` to upgrade, and `automatica11y --version` to see what you have. The rest of this page writes the short form. Add `npx` if you didn't install it.
31
+
22
32
  `doctor` checks your setup. If it can't find a browser, it prints the command that installs one:
23
33
 
24
34
  ```bash
@@ -120,7 +130,7 @@ Fixtures are code that the tool bundles and runs in a browser on your machine. W
120
130
 
121
131
  ## Use it with an AI agent.
122
132
 
123
- The tool prints its own guidance, so any agent that can run `npx` can learn to use it:
133
+ The tool prints its own guidance, so any agent that can run `npx` can learn to use it. If the tool is installed globally, the agent can run `automatica11y guide skill` instead of `npx automatica11y@latest guide skill`:
124
134
 
125
135
  ```bash
126
136
  npx automatica11y@latest guide # where to start (the AGENTS.md file)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "automatica11y",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Test and compare the accessibility of web pages, Storybook builds, and npm component libraries.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: automatica11y
3
- compatibility: Needs Node 20 or newer, a shell that can run npx, and network access to the npm registry.
3
+ compatibility: Needs Node 20 or newer, a shell that can run npx or the installed automatica11y command, and network access to the npm registry.
4
4
  description: Test and compare web accessibility. Use when someone asks how accessible a web page, Storybook, or npm component library is, asks for an accessibility or WCAG check or audit, or asks to compare the accessibility of two or more sites or component libraries (for example "how accessible is Radix Dialog?" or "compare React Aria and Headless UI").
5
5
  ---
6
6
 
@@ -20,6 +20,8 @@ automatica11y tests and compares web accessibility. This skill only gets you sta
20
20
 
21
21
  If the command exits with an error or prints no usable output, including after that retry, tell the user it failed, include the error text, and stop. Don't continue with partial instructions.
22
22
 
23
+ If `automatica11y` is already installed (`automatica11y --version` prints a version), you can run `automatica11y guide skill` instead. The steps check that the installed version matches them.
24
+
23
25
  After reading the steps, pass only settings they list as supported. If the user named a setting they don't list as supported, tell the user which setting is unsupported, list the supported values from the steps, and ask which to use. Don't ask again for anything they've already said.
24
26
 
25
27
  4. If you can't run shell commands, or `npx` can't reach the npm registry, tell the user and stop. Don't guess at results.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: automatica11y-runner
3
- compatibility: Needs Node 20 or newer, Chrome or Chromium, a shell that can run npx, and network access to the npm registry.
3
+ compatibility: Needs Node 20 or newer, Chrome or Chromium, a shell that can run npx or the installed automatica11y command, and network access to the npm registry.
4
4
  description: The full steps for running automatica11y audits and comparisons, from building the command to writing the report. Use it when the automatica11y skill or AGENTS.md sends you here, or when you've already been told to run automatica11y and need the steps.
5
5
  ---
6
6
 
@@ -24,6 +24,8 @@ npx --yes automatica11y@latest --version
24
24
 
25
25
  If the command exits with an error or prints nothing, tell the user it failed, include the error text, and stop. If the output doesn't start with `0.4.`, stop. Tell the user the version you got and the series this copy expects (`0.4.x`). If this copy came from a file, offer to read the matching steps with `npx --yes automatica11y@latest guide skill`. Don't run an audit until the user confirms how to proceed.
26
26
 
27
+ If the user installed the tool globally (`npm i -g automatica11y`), `automatica11y` is on the `PATH` (so is the short name `a11y`), and it runs the same commands as `npx --yes automatica11y@latest`. Every command in this skill is written with `npx`, so replace that prefix with `automatica11y` only when `automatica11y --version` passes the check above. If the installed version is the wrong series, or nothing is installed, use `npx`.
28
+
27
29
  ## 2. Check the setup
28
30
 
29
31
  ```bash