axe-sarif-converter
Advanced tools
axe-sarif-converter - npm Package Compare versions
Comparing version 2.2.0 to 2.3.0
| { | ||
| "name": "axe-sarif-converter", | ||
| "version": "2.2.0", | ||
| "version": "2.3.0", | ||
| "description": "Convert axe-core accessibility scan results to the SARIF format", | ||
@@ -19,3 +19,3 @@ "main": "dist/index.js", | ||
| "axe-core": "^3.2.2", | ||
| "yargs": "^14.0.0" | ||
| "yargs": "^15.0.2" | ||
| }, | ||
@@ -25,8 +25,8 @@ "devDependencies": { | ||
| "@types/lodash": "^4.14.136", | ||
| "@types/node": "^12.6.8", | ||
| "@types/node": "^13.1.2", | ||
| "@types/yargs": "^13.0.2", | ||
| "jest": "^24.8.0", | ||
| "jest-circus": "^24.8.0", | ||
| "jest-junit": "^8.0.0", | ||
| "license-check-and-add": "^2.3.6", | ||
| "jest-junit": "^10.0.0", | ||
| "license-check-and-add": "^3.0.3", | ||
| "lodash": "^4.17.15", | ||
@@ -50,3 +50,3 @@ "prettier": "^1.18.2", | ||
| "format-check": "prettier --config prettier.config.js --check \"**/*\"", | ||
| "copyrightheaders": "license-check-and-add", | ||
| "copyrightheaders": "license-check-and-add check -f copyright-header.config.json", | ||
| "precheckin": "yarn format-check && yarn lint && yarn build && yarn test && yarn copyrightheaders", | ||
@@ -75,45 +75,3 @@ "watch:build": "tsc -p . --watch", | ||
| }, | ||
| "homepage": "https://github.com/Microsoft/axe-sarif-converter#readme", | ||
| "license-check-and-add-config": { | ||
| "folder": "./", | ||
| "license": "copyright-header.txt", | ||
| "exact_paths_method": "EXCLUDE", | ||
| "exact_paths": [ | ||
| "./.git", | ||
| "./.github", | ||
| "./.vscode", | ||
| "./copyright-header.txt", | ||
| "./dist", | ||
| "./node_modules", | ||
| "./src/test-resources/", | ||
| "./test-results" | ||
| ], | ||
| "file_type_method": "INCLUDE", | ||
| "file_types": [ | ||
| ".ts", | ||
| ".d.ts", | ||
| ".js", | ||
| ".yaml", | ||
| ".md", | ||
| ".txt", | ||
| ".xml" | ||
| ], | ||
| "insert_license": false, | ||
| "license_formats": { | ||
| "yaml|npmrc": { | ||
| "eachLine": { | ||
| "prepend": "# " | ||
| } | ||
| }, | ||
| "md": { | ||
| "prepend": "<!--", | ||
| "append": "-->" | ||
| }, | ||
| "ts|d.ts|js": { | ||
| "eachLine": { | ||
| "prepend": "// " | ||
| } | ||
| } | ||
| } | ||
| } | ||
| "homepage": "https://github.com/Microsoft/axe-sarif-converter#readme" | ||
| } |
@@ -69,3 +69,3 @@ <!-- | ||
| - axe-sarif-converter version 2.x supports input from version ^3.2.0 of axe-core (tested with 3.2.2 and 3.3.2) and outputs SARIF v2.1 | ||
| - axe-sarif-converter version 2.x supports input from version ^3.2.0 of axe-core (tested with 3.2.2, 3.3.2, and 3.4.1) and outputs SARIF v2.1 | ||
| - axe-sarif-converter version 1.x supports input from version >= 3.2.0 < 3.3.0 of axe-core (tested with 3.2.2) and outputs SARIF v2.0 | ||
@@ -95,2 +95,29 @@ | ||
| ### Updating axe-core version | ||
| This package attempts to maintain backwards compatibility with axe-core versions ^3.2.2. We maintain | ||
| test cases using pinned output from multiple axe-core versions under `/src/test-resources/`, so updating | ||
| the version of axe-core we support involves generating new output for the new versions. | ||
| Ideally we'd specify axe-core as a peer dependency; unfortunately, changing this now would be a breaking | ||
| change, so we're waiting to change this until we would need to make a breaking change anyway. | ||
| To update the package and test cases to account for a new axe-core version: | ||
| 1. Update the version of axe-core in `yarn.lock` (_not_ `package.json`); usually dependabot will cover this. | ||
| 1. Update the versions of axe-cli and axe-core in `src/test-resources/generator/package.json` | ||
| 1. Generate test resource files for the new version with: | ||
| ``` | ||
| cd src/test-resources/generator | ||
| yarn install | ||
| yarn generate | ||
| ``` | ||
| 1. Manually compare the diff of `/src/test-resources/basic-axe-vPREVIOUS.sarif` and `/src/test-resources/basic-axe-vNEW.sarif`; the only differences should be the version numbers. | ||
| 1. Manually compare the diff of `/src/test-resources/w3citylights-axe-vPREVIOUS.sarif` and `/src/test-resources/w3citylights-axe-vNEW.sarif`; in addition to version number differences, you should see some differences based on new/removed rules between the axe versions. | ||
| 1. Add test cases involving the new files to the integration tests in `src/index.test.ts` and `src/cli.test.ts` | ||
| 1. Update snapshots (`yarn test -u`) | ||
| 1. Update this README's `Version numbers` section to note which versions we've tested against. | ||
| ### Contributor License Agreement | ||
@@ -97,0 +124,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis 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
- increased by1.64%
59853
- Number of package files
- increased by4.65%
45
- Lines of code
- increased by0.58%
1036
- Number of lines in readme file
- increased by24.77%
136
Dependency changes
+ Addedansi-regex@5.0.1(transitive)
+ Addedansi-styles@4.3.0(transitive)
+ Addedcliui@6.0.0(transitive)
+ Addedcolor-convert@2.0.1(transitive)
+ Addedcolor-name@1.1.4(transitive)
+ Addedemoji-regex@8.0.0(transitive)
+ Addedfind-up@4.1.0(transitive)
+ Addedis-fullwidth-code-point@3.0.0(transitive)
+ Addedlocate-path@5.0.0(transitive)
+ Addedp-locate@4.1.0(transitive)
+ Addedpath-exists@4.0.0(transitive)
+ Addedstring-width@4.2.3(transitive)
+ Addedstrip-ansi@6.0.1(transitive)
+ Addedwrap-ansi@6.2.0(transitive)
+ Addedyargs@15.4.1(transitive)
+ Addedyargs-parser@18.1.3(transitive)
- Removedansi-regex@4.1.1(transitive)
- Removedansi-styles@3.2.1(transitive)
- Removedcliui@5.0.0(transitive)
- Removedcolor-convert@1.9.3(transitive)
- Removedcolor-name@1.1.3(transitive)
- Removedemoji-regex@7.0.3(transitive)
- Removedfind-up@3.0.0(transitive)
- Removedis-fullwidth-code-point@2.0.0(transitive)
- Removedlocate-path@3.0.0(transitive)
- Removedp-locate@3.0.0(transitive)
- Removedpath-exists@3.0.0(transitive)
- Removedstring-width@3.1.0(transitive)
- Removedstrip-ansi@5.2.0(transitive)
- Removedwrap-ansi@5.1.0(transitive)
- Removedyargs@14.2.3(transitive)
- Removedyargs-parser@15.0.3(transitive)
Updatedyargs@^15.0.2