axe-sarif-converter - npm Package Compare versions

Comparing version 2.0.3 to 2.1.0

dist/axe-raw-sarif-converter.js

@@ -48,3 +48,3 @@ "use strict";
             tool: {
-                driver: __assign({}, this.getAxeProperties(environmentData), { rules: resultToRuleConverter.getRulePropertiesFromResults() }),
+                driver: __assign(__assign({}, this.getAxeProperties(environmentData)), { rules: resultToRuleConverter.getRulePropertiesFromResults() }),
             },
@@ -51,0 +51,0 @@ invocations: this.invocationConverter(environmentData),

dist/sarif-converter.js

@@ -49,3 +49,3 @@ "use strict";
             tool: {
-                driver: __assign({}, this.getAxeProperties(environmentData), { rules: resultToRuleConverter.getRulePropertiesFromResults() }),
+                driver: __assign(__assign({}, this.getAxeProperties(environmentData)), { rules: resultToRuleConverter.getRulePropertiesFromResults() }),
             },
@@ -52,0 +52,0 @@ invocations: this.invocationConverter(environmentData),

dist/wcag-taxonomy-provider.js

@@ -47,3 +47,3 @@ "use strict";
     if (wcagLinkData.title) {
-        taxa = __assign({}, taxa, { shortDescription: {
+        taxa = __assign(__assign({}, taxa), { shortDescription: {
                 text: wcagLinkData.title,
@@ -53,5 +53,5 @@ } });
     if (wcagLinkData.url) {
-        taxa = __assign({}, taxa, { helpUri: wcagLinkData.url });
+        taxa = __assign(__assign({}, taxa), { helpUri: wcagLinkData.url });
     }
     return taxa;
 }

package.json

 {
     "name": "axe-sarif-converter",
-    "version": "2.0.3",
+    "version": "2.1.0",
     "description": "Convert axe-core accessibility scan results to the SARIF format",
     "main": "dist/index.js",
+    "bin": "dist/cli.js",
     "types": "dist/index.d.js",
@@ -17,3 +18,4 @@ "files": [
         "@types/sarif": ">=2.1.1 <=2.1.2",
-        "axe-core": "^3.2.2"
+        "axe-core": "^3.2.2",
+        "yargs": "^14.0.0"
     },
@@ -24,5 +26,6 @@ "devDependencies": {
         "@types/node": "^12.6.8",
+        "@types/yargs": "^13.0.2",
         "jest": "^24.8.0",
         "jest-circus": "^24.8.0",
-        "jest-junit": "^6.4.0",
+        "jest-junit": "^8.0.0",
         "license-check-and-add": "^2.3.6",
@@ -29,0 +32,0 @@ "lodash": "^4.17.15",

README.md

@@ -13,3 +13,3 @@ <!--
 
-Convert [axe-core](https://github.com/dequelabs/axe-core) accessibility scan results to the [SARIF format](http://sarifweb.azurewebsites.net/).
+Convert [axe-core](https://github.com/dequelabs/axe-core) accessibility scan results to the [SARIF format](http://sarifweb.azurewebsites.net/). Provides both a TypeScript API and a CLI tool.
 
@@ -50,2 +50,14 @@ Use this with the [Sarif Viewer Build Tab Azure DevOps Extension](https://marketplace.visualstudio.com/items?itemName=sariftools.sarif-viewer-build-tab) to visualize accessibility scan results in the build results of an [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) build.
 
+You can also use axe-sarif-converter as a command line tool:
+
+```bash
+# axe-cli is used here for example purposes only; you could also run axe-core
+# using your library of choice and JSON.stringify the results.
+npx axe-cli https://accessibilityinsights.io --save ./sample-axe-results.json
+
+npx axe-sarif-converter --input-files ./sample-axe-results.json --output-file ./sample-axe-results.sarif
+```
+
+See `npx axe-sarif-converter --help` for full command line option details.
+
 ## Samples
@@ -66,2 +78,22 @@
 
+To get started working on the project:
+
+1. Install dependencies:
+
+    - Install [Node.js](https://nodejs.org/en/download/) (LTS version)
+    - `npm install -g yarn`
+    - `yarn install`
+
+1. Run all build, lint, and test steps:
+
+    - `yarn precheckin`
+
+1. Run the CLI tool with your changes:
+
+    - `yarn build`
+    - `node dist/cli.js`
+    - Alternately, register a linked global `axe-sarif-converter` command with `npm install && npm link` (yarn doesn't work for this; see [yarnpkg/yarn#1585](https://github.com/yarnpkg/yarn/issues/1585))
+
+### Contributor License Agreement
+
 This project welcomes contributions and suggestions. Most contributions require you to agree to a
@@ -75,4 +107,6 @@ Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
 
+### Code of Conduct
+
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [[e-mail]](mailto:[e-mail]) with any additional questions or comments.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

58827

increased by9.55%

Number of package files

43

increased by4.88%

Lines of code

1030

increased by10.87%

Number of lines in readme file

109

increased by45.33%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

17

increased by6.25%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedyargs@^14.0.0

• + Addedansi-regex@4.1.1(transitive)

• + Addedansi-styles@3.2.1(transitive)

• + Addedcamelcase@5.3.1(transitive)

• + Addedcliui@5.0.0(transitive)

• + Addedcolor-convert@1.9.3(transitive)

• + Addedcolor-name@1.1.3(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addedemoji-regex@7.0.3(transitive)

• + Addedfind-up@3.0.0(transitive)

• + Addedget-caller-file@2.0.5(transitive)

• + Addedis-fullwidth-code-point@2.0.0(transitive)

• + Addedlocate-path@3.0.0(transitive)

• + Addedp-limit@2.3.0(transitive)

• + Addedp-locate@3.0.0(transitive)

• + Addedp-try@2.2.0(transitive)

• + Addedpath-exists@3.0.0(transitive)

• + Addedrequire-directory@2.1.1(transitive)

• + Addedrequire-main-filename@2.0.0(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedstring-width@3.1.0(transitive)

• + Addedstrip-ansi@5.2.0(transitive)

• + Addedwhich-module@2.0.1(transitive)

• + Addedwrap-ansi@5.1.0(transitive)

• + Addedy18n@4.0.3(transitive)

• + Addedyargs@14.2.3(transitive)

• + Addedyargs-parser@15.0.3(transitive)