@a11yst/cli 1.0.0
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 +373 -0
- package/NOTICE.md +11 -0
- package/README.md +60 -0
- package/TRADEMARKS.md +52 -0
- package/dist/bin.d.ts +3 -0
- package/dist/bin.d.ts.map +1 -0
- package/dist/bin.js +9 -0
- package/dist/bin.js.map +1 -0
- package/dist/ci-policy-options.d.ts +15 -0
- package/dist/ci-policy-options.d.ts.map +1 -0
- package/dist/ci-policy-options.js +54 -0
- package/dist/ci-policy-options.js.map +1 -0
- package/dist/cli-progress.d.ts +16 -0
- package/dist/cli-progress.d.ts.map +1 -0
- package/dist/cli-progress.js +35 -0
- package/dist/cli-progress.js.map +1 -0
- package/dist/command-program.d.ts +7 -0
- package/dist/command-program.d.ts.map +1 -0
- package/dist/command-program.js +950 -0
- package/dist/command-program.js.map +1 -0
- package/dist/commands/audit-flow-output.d.ts +4 -0
- package/dist/commands/audit-flow-output.d.ts.map +1 -0
- package/dist/commands/audit-flow-output.js +119 -0
- package/dist/commands/audit-flow-output.js.map +1 -0
- package/dist/commands/audit-policy-output.d.ts +9 -0
- package/dist/commands/audit-policy-output.d.ts.map +1 -0
- package/dist/commands/audit-policy-output.js +95 -0
- package/dist/commands/audit-policy-output.js.map +1 -0
- package/dist/commands/audit.d.ts +15 -0
- package/dist/commands/audit.d.ts.map +1 -0
- package/dist/commands/audit.js +178 -0
- package/dist/commands/audit.js.map +1 -0
- package/dist/commands/baseline-config.d.ts +14 -0
- package/dist/commands/baseline-config.d.ts.map +1 -0
- package/dist/commands/baseline-config.js +33 -0
- package/dist/commands/baseline-config.js.map +1 -0
- package/dist/commands/baseline.d.ts +86 -0
- package/dist/commands/baseline.d.ts.map +1 -0
- package/dist/commands/baseline.js +392 -0
- package/dist/commands/baseline.js.map +1 -0
- package/dist/commands/classify.d.ts +30 -0
- package/dist/commands/classify.d.ts.map +1 -0
- package/dist/commands/classify.js +105 -0
- package/dist/commands/classify.js.map +1 -0
- package/dist/commands/detect.d.ts +12 -0
- package/dist/commands/detect.d.ts.map +1 -0
- package/dist/commands/detect.js +213 -0
- package/dist/commands/detect.js.map +1 -0
- package/dist/commands/doctor.d.ts +16 -0
- package/dist/commands/doctor.d.ts.map +1 -0
- package/dist/commands/doctor.js +404 -0
- package/dist/commands/doctor.js.map +1 -0
- package/dist/commands/findings.d.ts +45 -0
- package/dist/commands/findings.d.ts.map +1 -0
- package/dist/commands/findings.js +220 -0
- package/dist/commands/findings.js.map +1 -0
- package/dist/commands/flows.d.ts +30 -0
- package/dist/commands/flows.d.ts.map +1 -0
- package/dist/commands/flows.js +108 -0
- package/dist/commands/flows.js.map +1 -0
- package/dist/commands/init.d.ts +64 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +293 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/profiles.d.ts +5 -0
- package/dist/commands/profiles.d.ts.map +1 -0
- package/dist/commands/profiles.js +39 -0
- package/dist/commands/profiles.js.map +1 -0
- package/dist/commands/report.d.ts +72 -0
- package/dist/commands/report.d.ts.map +1 -0
- package/dist/commands/report.js +284 -0
- package/dist/commands/report.js.map +1 -0
- package/dist/commands/results-loader.d.ts +15 -0
- package/dist/commands/results-loader.d.ts.map +1 -0
- package/dist/commands/results-loader.js +100 -0
- package/dist/commands/results-loader.js.map +1 -0
- package/dist/commands/routes.d.ts +35 -0
- package/dist/commands/routes.d.ts.map +1 -0
- package/dist/commands/routes.js +201 -0
- package/dist/commands/routes.js.map +1 -0
- package/dist/commands/unclassify.d.ts +22 -0
- package/dist/commands/unclassify.d.ts.map +1 -0
- package/dist/commands/unclassify.js +79 -0
- package/dist/commands/unclassify.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/output.d.ts +9 -0
- package/dist/output.d.ts.map +1 -0
- package/dist/output.js +29 -0
- package/dist/output.js.map +1 -0
- package/dist/presentation/ansi.d.ts +12 -0
- package/dist/presentation/ansi.d.ts.map +1 -0
- package/dist/presentation/ansi.js +51 -0
- package/dist/presentation/ansi.js.map +1 -0
- package/dist/presentation/audit-presentation.d.ts +20 -0
- package/dist/presentation/audit-presentation.d.ts.map +1 -0
- package/dist/presentation/audit-presentation.js +409 -0
- package/dist/presentation/audit-presentation.js.map +1 -0
- package/dist/presentation/boundary.d.ts +5 -0
- package/dist/presentation/boundary.d.ts.map +1 -0
- package/dist/presentation/boundary.js +4 -0
- package/dist/presentation/boundary.js.map +1 -0
- package/dist/presentation/brand-header.d.ts +6 -0
- package/dist/presentation/brand-header.d.ts.map +1 -0
- package/dist/presentation/brand-header.js +18 -0
- package/dist/presentation/brand-header.js.map +1 -0
- package/dist/presentation/capabilities.d.ts +4 -0
- package/dist/presentation/capabilities.d.ts.map +1 -0
- package/dist/presentation/capabilities.js +25 -0
- package/dist/presentation/capabilities.js.map +1 -0
- package/dist/presentation/color.d.ts +13 -0
- package/dist/presentation/color.d.ts.map +1 -0
- package/dist/presentation/color.js +27 -0
- package/dist/presentation/color.js.map +1 -0
- package/dist/presentation/disclaimers.d.ts +3 -0
- package/dist/presentation/disclaimers.d.ts.map +1 -0
- package/dist/presentation/disclaimers.js +3 -0
- package/dist/presentation/disclaimers.js.map +1 -0
- package/dist/presentation/finding-groups.d.ts +14 -0
- package/dist/presentation/finding-groups.d.ts.map +1 -0
- package/dist/presentation/finding-groups.js +77 -0
- package/dist/presentation/finding-groups.js.map +1 -0
- package/dist/presentation/finding-source-report.d.ts +21 -0
- package/dist/presentation/finding-source-report.d.ts.map +1 -0
- package/dist/presentation/finding-source-report.js +134 -0
- package/dist/presentation/finding-source-report.js.map +1 -0
- package/dist/presentation/human-output.d.ts +4 -0
- package/dist/presentation/human-output.d.ts.map +1 -0
- package/dist/presentation/human-output.js +8 -0
- package/dist/presentation/human-output.js.map +1 -0
- package/dist/presentation/index.d.ts +15 -0
- package/dist/presentation/index.d.ts.map +1 -0
- package/dist/presentation/index.js +13 -0
- package/dist/presentation/index.js.map +1 -0
- package/dist/presentation/mode.d.ts +4 -0
- package/dist/presentation/mode.d.ts.map +1 -0
- package/dist/presentation/mode.js +8 -0
- package/dist/presentation/mode.js.map +1 -0
- package/dist/presentation/progress-mode.d.ts +20 -0
- package/dist/presentation/progress-mode.d.ts.map +1 -0
- package/dist/presentation/progress-mode.js +38 -0
- package/dist/presentation/progress-mode.js.map +1 -0
- package/dist/presentation/progress-reporter.d.ts +18 -0
- package/dist/presentation/progress-reporter.d.ts.map +1 -0
- package/dist/presentation/progress-reporter.js +236 -0
- package/dist/presentation/progress-reporter.js.map +1 -0
- package/dist/presentation/progress-signals.d.ts +2 -0
- package/dist/presentation/progress-signals.d.ts.map +1 -0
- package/dist/presentation/progress-signals.js +14 -0
- package/dist/presentation/progress-signals.js.map +1 -0
- package/dist/presentation/status.d.ts +11 -0
- package/dist/presentation/status.d.ts.map +1 -0
- package/dist/presentation/status.js +14 -0
- package/dist/presentation/status.js.map +1 -0
- package/dist/presentation/types.d.ts +23 -0
- package/dist/presentation/types.d.ts.map +1 -0
- package/dist/presentation/types.js +2 -0
- package/dist/presentation/types.js.map +1 -0
- package/dist/run-cli.d.ts +6 -0
- package/dist/run-cli.d.ts.map +1 -0
- package/dist/run-cli.js +15 -0
- package/dist/run-cli.js.map +1 -0
- package/package.json +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/NOTICE.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Notices
|
|
2
|
+
|
|
3
|
+
a11yst is distributed under the Mozilla Public License 2.0.
|
|
4
|
+
|
|
5
|
+
See [LICENSE](./LICENSE) for the complete license text.
|
|
6
|
+
|
|
7
|
+
Copyright in individual contributions remains with the applicable copyright holders unless otherwise agreed.
|
|
8
|
+
|
|
9
|
+
The a11yst project name and visual identity are addressed separately in [TRADEMARKS.md](./TRADEMARKS.md).
|
|
10
|
+
|
|
11
|
+
Third-party dependencies remain subject to their respective licenses.
|
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# @a11yst/cli
|
|
2
|
+
|
|
3
|
+
**Package:** `@a11yst/cli`
|
|
4
|
+
**Command:** `a11yst`
|
|
5
|
+
|
|
6
|
+
a11yst is an accessibility testing and regression CLI for web applications. It runs Playwright + axe audits, optional a11yst profiles and flows, baseline comparison, source analysis, and multiple report formats.
|
|
7
|
+
|
|
8
|
+
Automated accessibility checks do not establish WCAG conformance and do not replace manual accessibility testing.
|
|
9
|
+
|
|
10
|
+
## Requirements
|
|
11
|
+
|
|
12
|
+
- Node.js **>= 22.12**
|
|
13
|
+
- Playwright Chromium for browser-based audits (installed separately; see below)
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
Install the CLI as development/CI tooling:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm add -D @a11yst/cli
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Browser setup
|
|
24
|
+
|
|
25
|
+
a11yst uses Playwright Chromium for browser-based audits. Install the browser binary explicitly **after** installing the package:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pnpm exec playwright install chromium
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Chromium is managed separately by Playwright. a11yst does **not** download Chromium automatically during package installation.
|
|
32
|
+
|
|
33
|
+
Then run audits from your project directory:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pnpm exec a11yst audit
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The consumer environment exposes the `a11yst` command via this package. Playwright is invoked through the installed dependency graph (`pnpm exec playwright …`).
|
|
40
|
+
|
|
41
|
+
## What this package is
|
|
42
|
+
|
|
43
|
+
- **Consumer entry package** for the a11yst CLI (`a11yst` binary).
|
|
44
|
+
- Depends on the full a11yst runtime closure (multiple `@a11yst/*` packages resolved transitively when installed from a registry release).
|
|
45
|
+
|
|
46
|
+
## Limitations
|
|
47
|
+
|
|
48
|
+
- Recommendations are guidance, not patches or automatic fixes.
|
|
49
|
+
- Source mapping is heuristic and may be ambiguous or unmapped.
|
|
50
|
+
- React Native runtime audits are not supported.
|
|
51
|
+
|
|
52
|
+
## Security
|
|
53
|
+
|
|
54
|
+
Report suspected vulnerabilities through GitHub private vulnerability reporting at https://github.com/angelabenavente/a11yst/security/advisories/new. Do not disclose undisclosed security problems in public issues.
|
|
55
|
+
|
|
56
|
+
## License
|
|
57
|
+
|
|
58
|
+
License: **MPL-2.0** (Mozilla Public License 2.0)
|
|
59
|
+
|
|
60
|
+
See the LICENSE file included with this package.
|
package/TRADEMARKS.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# a11yst trademark and brand policy
|
|
2
|
+
|
|
3
|
+
This document describes how to refer to a11yst project identity. It does **not** change the license for source code.
|
|
4
|
+
|
|
5
|
+
## Code license vs. project branding
|
|
6
|
+
|
|
7
|
+
The Mozilla Public License 2.0 (MPL-2.0) covers the a11yst Community source code distributed in this repository. It does not grant a general license to use the a11yst project name, logo, or visual identity.
|
|
8
|
+
|
|
9
|
+
You may use, modify, and distribute the Community code under MPL-2.0. Trademark and branding rules in this document address how the project is identified, not whether the code may be used commercially.
|
|
10
|
+
|
|
11
|
+
## Permitted referential use
|
|
12
|
+
|
|
13
|
+
Truthful, non-misleading references are generally acceptable, for example:
|
|
14
|
+
|
|
15
|
+
- "uses a11yst"
|
|
16
|
+
- "compatible with a11yst"
|
|
17
|
+
- "based on a11yst"
|
|
18
|
+
- "fork of a11yst"
|
|
19
|
+
|
|
20
|
+
These references must not imply sponsorship, endorsement, or official status from the a11yst project.
|
|
21
|
+
|
|
22
|
+
## Forks and modified distributions
|
|
23
|
+
|
|
24
|
+
If you distribute a modified version of a11yst Community, use your own product name and branding when there is a reasonable risk of confusion with the official project.
|
|
25
|
+
|
|
26
|
+
You may identify the origin factually, for example:
|
|
27
|
+
|
|
28
|
+
- "Based on a11yst"
|
|
29
|
+
|
|
30
|
+
Do not present a modified fork as the official a11yst product.
|
|
31
|
+
|
|
32
|
+
## Not permitted without permission
|
|
33
|
+
|
|
34
|
+
Do not present a product or service as:
|
|
35
|
+
|
|
36
|
+
- official a11yst
|
|
37
|
+
- an official a11yst offering
|
|
38
|
+
- a11yst Pro, Team, Cloud, or Enterprise (or similar names that imply an official commercial product from this project)
|
|
39
|
+
|
|
40
|
+
when it is not operated or authorized by the a11yst project maintainers.
|
|
41
|
+
|
|
42
|
+
This policy addresses brand confusion. It does not prohibit creating commercial products that use a11yst Community source code under MPL-2.0.
|
|
43
|
+
|
|
44
|
+
## Logo and visual identity
|
|
45
|
+
|
|
46
|
+
The a11yst name, logo, and visual identity are project identity assets.
|
|
47
|
+
|
|
48
|
+
Do not use those assets in a way that suggests your product is the official a11yst project or is endorsed by it, unless you have explicit permission.
|
|
49
|
+
|
|
50
|
+
## No registration claims
|
|
51
|
+
|
|
52
|
+
This document does not claim that a11yst is a registered trademark. Do not describe a11yst as a registered mark unless a maintainer publishes confirmed registration details.
|
package/dist/bin.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}
|
package/dist/bin.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { runCli } from "./index.js";
|
|
3
|
+
const code = await runCli();
|
|
4
|
+
// Set exitCode (not `process.exit()`) so Node drains buffered stdout/stderr
|
|
5
|
+
// writes before the process terminates. Audit `--json` output can exceed a
|
|
6
|
+
// single pipe buffer; calling `process.exit()` immediately after a large
|
|
7
|
+
// `stream.write()` can truncate it before the OS-level write completes.
|
|
8
|
+
process.exitCode = code;
|
|
9
|
+
//# sourceMappingURL=bin.js.map
|
package/dist/bin.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE,CAAC;AAC5B,4EAA4E;AAC5E,2EAA2E;AAC3E,yEAAyE;AACzE,wEAAwE;AACxE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { CiPolicyCliOverrides } from "@a11yst/policy";
|
|
2
|
+
export type ParsedCiPolicyCliOptions = {
|
|
3
|
+
overrides: CiPolicyCliOverrides;
|
|
4
|
+
explicitFlagsUsed: boolean;
|
|
5
|
+
};
|
|
6
|
+
export declare function parseCiPolicyCliOptions(opts: {
|
|
7
|
+
failOnNew?: boolean;
|
|
8
|
+
noFailOnNew?: boolean;
|
|
9
|
+
failOnRegression?: boolean;
|
|
10
|
+
noFailOnRegression?: boolean;
|
|
11
|
+
failOnExpiredClassification?: boolean;
|
|
12
|
+
noFailOnExpiredClassification?: boolean;
|
|
13
|
+
minimumSeverity?: string;
|
|
14
|
+
}, argv?: readonly string[]): ParsedCiPolicyCliOptions;
|
|
15
|
+
//# sourceMappingURL=ci-policy-options.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ci-policy-options.d.ts","sourceRoot":"","sources":["../src/ci-policy-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAI3D,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAE,oBAAoB,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAgBF,wBAAgB,uBAAuB,CACrC,IAAI,EAAE;IACJ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,EACD,IAAI,GAAE,SAAS,MAAM,EAAiB,GACrC,wBAAwB,CAsD1B"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { isValidMinimumSeverity } from "@a11yst/policy";
|
|
2
|
+
const POLICY_FLAGS = [
|
|
3
|
+
"--fail-on-new",
|
|
4
|
+
"--no-fail-on-new",
|
|
5
|
+
"--fail-on-regression",
|
|
6
|
+
"--no-fail-on-regression",
|
|
7
|
+
"--fail-on-expired-classification",
|
|
8
|
+
"--no-fail-on-expired-classification",
|
|
9
|
+
"--minimum-severity",
|
|
10
|
+
];
|
|
11
|
+
function argvIncludes(argv, flag) {
|
|
12
|
+
return argv.some((arg) => arg === flag || arg.startsWith(`${flag}=`));
|
|
13
|
+
}
|
|
14
|
+
export function parseCiPolicyCliOptions(opts, argv = process.argv) {
|
|
15
|
+
const overrides = {};
|
|
16
|
+
const explicitFlagsUsed = POLICY_FLAGS.some((flag) => argvIncludes(argv, flag));
|
|
17
|
+
if (argvIncludes(argv, "--fail-on-new") && argvIncludes(argv, "--no-fail-on-new")) {
|
|
18
|
+
throw new Error("Cannot use --fail-on-new and --no-fail-on-new together. Choose one CI policy override.");
|
|
19
|
+
}
|
|
20
|
+
if (argvIncludes(argv, "--fail-on-regression") &&
|
|
21
|
+
argvIncludes(argv, "--no-fail-on-regression")) {
|
|
22
|
+
throw new Error("Cannot use --fail-on-regression and --no-fail-on-regression together. Choose one CI policy override.");
|
|
23
|
+
}
|
|
24
|
+
if (argvIncludes(argv, "--fail-on-expired-classification") &&
|
|
25
|
+
argvIncludes(argv, "--no-fail-on-expired-classification")) {
|
|
26
|
+
throw new Error("Cannot use --fail-on-expired-classification and --no-fail-on-expired-classification together. Choose one CI policy override.");
|
|
27
|
+
}
|
|
28
|
+
if (argvIncludes(argv, "--fail-on-new")) {
|
|
29
|
+
overrides.failOnNew = true;
|
|
30
|
+
}
|
|
31
|
+
else if (argvIncludes(argv, "--no-fail-on-new")) {
|
|
32
|
+
overrides.failOnNew = false;
|
|
33
|
+
}
|
|
34
|
+
if (argvIncludes(argv, "--fail-on-regression")) {
|
|
35
|
+
overrides.failOnRegression = true;
|
|
36
|
+
}
|
|
37
|
+
else if (argvIncludes(argv, "--no-fail-on-regression")) {
|
|
38
|
+
overrides.failOnRegression = false;
|
|
39
|
+
}
|
|
40
|
+
if (argvIncludes(argv, "--fail-on-expired-classification")) {
|
|
41
|
+
overrides.failOnExpiredClassification = true;
|
|
42
|
+
}
|
|
43
|
+
else if (argvIncludes(argv, "--no-fail-on-expired-classification")) {
|
|
44
|
+
overrides.failOnExpiredClassification = false;
|
|
45
|
+
}
|
|
46
|
+
if (opts.minimumSeverity !== undefined) {
|
|
47
|
+
if (!isValidMinimumSeverity(opts.minimumSeverity)) {
|
|
48
|
+
throw new Error(`Invalid --minimum-severity "${opts.minimumSeverity}". Expected one of: minor, medium, high, critical.`);
|
|
49
|
+
}
|
|
50
|
+
overrides.minimumSeverity = opts.minimumSeverity;
|
|
51
|
+
}
|
|
52
|
+
return { overrides, explicitFlagsUsed };
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=ci-policy-options.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ci-policy-options.js","sourceRoot":"","sources":["../src/ci-policy-options.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAQxD,MAAM,YAAY,GAAG;IACnB,eAAe;IACf,kBAAkB;IAClB,sBAAsB;IACtB,yBAAyB;IACzB,kCAAkC;IAClC,qCAAqC;IACrC,oBAAoB;CACZ,CAAC;AAEX,SAAS,YAAY,CAAC,IAAuB,EAAE,IAAY;IACzD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,IAQC,EACD,OAA0B,OAAO,CAAC,IAAI;IAEtC,MAAM,SAAS,GAAyB,EAAE,CAAC;IAC3C,MAAM,iBAAiB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhF,IAAI,YAAY,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,YAAY,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAClF,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;IACJ,CAAC;IACD,IACE,YAAY,CAAC,IAAI,EAAE,sBAAsB,CAAC;QAC1C,YAAY,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAC7C,CAAC;QACD,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;IACJ,CAAC;IACD,IACE,YAAY,CAAC,IAAI,EAAE,kCAAkC,CAAC;QACtD,YAAY,CAAC,IAAI,EAAE,qCAAqC,CAAC,EACzD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,8HAA8H,CAC/H,CAAC;IACJ,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,CAAC;QACxC,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC;IAC7B,CAAC;SAAM,IAAI,YAAY,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAClD,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,EAAE,sBAAsB,CAAC,EAAE,CAAC;QAC/C,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACpC,CAAC;SAAM,IAAI,YAAY,CAAC,IAAI,EAAE,yBAAyB,CAAC,EAAE,CAAC;QACzD,SAAS,CAAC,gBAAgB,GAAG,KAAK,CAAC;IACrC,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,EAAE,kCAAkC,CAAC,EAAE,CAAC;QAC3D,SAAS,CAAC,2BAA2B,GAAG,IAAI,CAAC;IAC/C,CAAC;SAAM,IAAI,YAAY,CAAC,IAAI,EAAE,qCAAqC,CAAC,EAAE,CAAC;QACrE,SAAS,CAAC,2BAA2B,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACvC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,CAAC,eAAe,oDAAoD,CACxG,CAAC;QACJ,CAAC;QACD,SAAS,CAAC,eAAe,GAAG,IAAI,CAAC,eAA2B,CAAC;IAC/D,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;AAC1C,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { ProgressReporter } from "@a11yst/types";
|
|
2
|
+
import type { ColorMode } from "./presentation/color.js";
|
|
3
|
+
import { resolveProgressModeFromCli, type ProgressMode } from "./presentation/progress-mode.js";
|
|
4
|
+
import type { TerminalCapabilitiesInput } from "./presentation/types.js";
|
|
5
|
+
export interface CliProgressOptions {
|
|
6
|
+
json?: boolean;
|
|
7
|
+
progress?: string;
|
|
8
|
+
noProgress?: boolean;
|
|
9
|
+
colorMode?: ColorMode;
|
|
10
|
+
capabilities?: TerminalCapabilitiesInput;
|
|
11
|
+
stream?: NodeJS.WriteStream;
|
|
12
|
+
}
|
|
13
|
+
export declare function createCliProgressReporter(options: CliProgressOptions): ProgressReporter;
|
|
14
|
+
export declare function withCliProgress<T>(progress: ProgressReporter, label: string, fn: () => Promise<T>): Promise<T>;
|
|
15
|
+
export { resolveProgressModeFromCli, type ProgressMode };
|
|
16
|
+
//# sourceMappingURL=cli-progress.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli-progress.d.ts","sourceRoot":"","sources":["../src/cli-progress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGzD,OAAO,EACL,0BAA0B,EAC1B,KAAK,YAAY,EAClB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAEzE,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC7B;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,kBAAkB,GAAG,gBAAgB,CAavF;AAED,wBAAsB,eAAe,CAAC,CAAC,EACrC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CAYZ;AAED,OAAO,EAAE,0BAA0B,EAAE,KAAK,YAAY,EAAE,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { resolveTerminalCapabilities } from "./presentation/capabilities.js";
|
|
2
|
+
import { createProgressReporter } from "./presentation/progress-reporter.js";
|
|
3
|
+
import { resolveProgressModeFromCli, } from "./presentation/progress-mode.js";
|
|
4
|
+
import { registerProgressSignalHandlers } from "./presentation/progress-signals.js";
|
|
5
|
+
export function createCliProgressReporter(options) {
|
|
6
|
+
registerProgressSignalHandlers();
|
|
7
|
+
const mode = resolveProgressModeFromCli({
|
|
8
|
+
progress: options.progress,
|
|
9
|
+
noProgress: options.noProgress,
|
|
10
|
+
});
|
|
11
|
+
return createProgressReporter({
|
|
12
|
+
mode,
|
|
13
|
+
machineOutput: Boolean(options.json),
|
|
14
|
+
capabilities: resolveTerminalCapabilities(options.capabilities),
|
|
15
|
+
colorMode: options.colorMode,
|
|
16
|
+
stream: options.stream,
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
export async function withCliProgress(progress, label, fn) {
|
|
20
|
+
progress.start(label);
|
|
21
|
+
try {
|
|
22
|
+
const result = await fn();
|
|
23
|
+
progress.succeed(label.replace(/…$/, "") || label);
|
|
24
|
+
return result;
|
|
25
|
+
}
|
|
26
|
+
catch (error) {
|
|
27
|
+
progress.fail(label.replace(/…$/, "") || label);
|
|
28
|
+
throw error;
|
|
29
|
+
}
|
|
30
|
+
finally {
|
|
31
|
+
progress.stop();
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
export { resolveProgressModeFromCli };
|
|
35
|
+
//# sourceMappingURL=cli-progress.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli-progress.js","sourceRoot":"","sources":["../src/cli-progress.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EACL,0BAA0B,GAE3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAYpF,MAAM,UAAU,yBAAyB,CAAC,OAA2B;IACnE,8BAA8B,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,0BAA0B,CAAC;QACtC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,OAAO,sBAAsB,CAAC;QAC5B,IAAI;QACJ,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpC,YAAY,EAAE,2BAA2B,CAAC,OAAO,CAAC,YAAY,CAAC;QAC/D,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,KAAa,EACb,EAAoB;IAEpB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;QAC1B,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IACd,CAAC;YAAS,CAAC;QACT,QAAQ,CAAC,IAAI,EAAE,CAAC;IAClB,CAAC;AACH,CAAC;AAED,OAAO,EAAE,0BAA0B,EAAqB,CAAC"}
|