audit-app - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

config.schema.json

CHANGELOG.md

		@@ -1,3 +0,13 @@
		# [Unreleased](https://github.com/G-Rath/audit-app/compare/v0.2.0...HEAD) (2020-09-13)
		# [Unreleased](https://github.com/G-Rath/audit-app/compare/v0.3.0...HEAD) (2020-09-18)

		# [0.3.0](https://github.com/G-Rath/audit-app/compare/v0.2.0...v0.3.0) (2020-09-18)

		### Features

		- publish `config.schema.json` to use to valid config files ([bfda8ade][])

		### Bug Fixes

		- ignore `$schema` property if present in config file ([f898766e][])

		# [0.2.0](https://github.com/G-Rath/audit-app/compare/v0.1.1...v0.2.0) (2020-09-13)
		@@ -8,2 +18,3 @@
		- expand `statistics` object in audit report to include more details
		([79e6ef0d][])

		@@ -14,3 +25,3 @@ # [0.1.1](https://github.com/G-Rath/audit-app/compare/v0.1.0...v0.1.1) (2020-08-03)

		- add `types` property to `package.json` ([e977130][])
		- add `types` property to `package.json` ([e977130b][])

		@@ -21,3 +32,5 @@ # [0.1.0](https://github.com/G-Rath/audit-app/compare/82aa09aaf47ee736ddc030ee0418ffe40e191adf...v0.1.0) (2020-08-02)

		[e977130]:
		https://github.com/G-Rath/audit-app/commit/e977130b76e69f816fd57f3d366442c663c768c4
		[bfda8ade]: https://github.com/G-Rath/audit-app/commit/bfda8ade
		[f898766e]: https://github.com/G-Rath/audit-app/commit/f898766e
		[79e6ef0d]: https://github.com/G-Rath/audit-app/commit/79e6ef0d
		[e977130b]: https://github.com/G-Rath/audit-app/commit/e977130b

lib/parseArgs.js

		@@ -53,3 +53,5 @@ "use strict";
		try {
		return JSON.parse(contents);
		const config = JSON.parse(contents);
		delete config.$schema;
		return config;
		}
		@@ -56,0 +58,0 @@ catch (e) {

package.json

		{
		"name": "audit-app",
		"version": "0.2.0",
		"version": "0.3.0",
		"description": "A cli tool for auditing apps & packages using their respective package managers.",
		@@ -25,3 +25,4 @@ "keywords": [
		"files": [
		"lib/"
		"lib/",
		"config.schema.json"
		],
		@@ -48,8 +49,8 @@ "scripts": {
		"@types/eslint": "^7.2.2",
		"@types/jest": "^26.0.13",
		"@types/node": "^14.10.1",
		"@types/jest": "^26.0.14",
		"@types/node": "^14.11.1",
		"@types/readline-transform": "^1.0.0",
		"@types/yargs": "^15.0.5",
		"@typescript-eslint/eslint-plugin": "^4.1.0",
		"@typescript-eslint/parser": "^4.1.0",
		"@typescript-eslint/eslint-plugin": "^4.1.1",
		"@typescript-eslint/parser": "^4.1.1",
		"eslint": "^7.9.0",
		@@ -65,3 +66,3 @@ "eslint-config-ackama": "^2.0.0",
		"memfs": "^3.2.0",
		"prettier": "^2.1.1",
		"prettier": "^2.1.2",
		"prettier-config-ackama": "^0.1.2",
		@@ -68,0 +69,0 @@ "ts-jest": "^26.3.0",

README.md

		@@ -179,2 +179,15 @@ # audit-app

		If you're using a json config, you can use `jq` to convert the output into a
		valid JSON array that you can paste straight into your config:

		```shell script
		audit-app --output paths \| grep '>@commitlint/load> \| jq -R '[inputs]'
		```

		You can do this in PowerShell like so:

		```powershell
		(audit-app --output paths).split('\n') \| ConvertTo-Json
		```

		### `json` format
		@@ -185,2 +198,26 @@

		If you're ignoring vulnerabilities using a json config, you can pipe the output
		of the json format to a program like `jq` to pick the `vulnerable` array

		If you have a lot of vulnerabilities that you wish to ignore, you can pipe the
		json output to a program like `jq` to select just the `vulnerable` array and get
		a valid json array as output for your clipboard:

		```shell script
		audit-app --format json \| jq '.vulnerable'
		```

		If you wish to select only some vulnerabilities, you can use filters like so:

		```shell script
		audit-app --format json \| jq '.vulnerable \| map(select(startswith("1556")))'
		audit-app --format json \| jq '.vulnerable \| map(select(startswith("1556")))'
		```

		If you're using Powershell, you can do this without `jq` like so:

		```powershell
		(audit-app --format json \| ConvertFrom-Json).vulnerable \| ConvertTo-Json
		```

		## `--ignore`, `-i`
		@@ -187,0 +224,0 @@

New alerts