diff --git a/CHANGELOG.md b/CHANGELOG.md
index 81ddfa2..c1be675 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,14 @@
+## v2.0.0
+
+### Breaking
+
+- Dropped support for Node 12 as it exited maintenance. Added testing support for Node 18 in it's place.
+
+### Dependencies
+
+- Updates yargs to 17.5.1 which dropped support for Node 12
+- Updates `cli-progress` to 3.11.1 which doesn't have consequences for this project
+
## v1.0.1
### Dependencies
diff --git a/docs/index.html b/docs/index.html
index 03ab202..f45e918 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,4 +1,4 @@
-
\ No newline at end of file
diff --git a/docs/modules.html b/docs/modules.html
index b3f5cea..7f533c9 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1 +1 @@
-rotten-deps - v1.0.1
\ No newline at end of file
diff --git a/docs/pages/how-to/contribute-to-docs.html b/docs/pages/how-to/contribute-to-docs.html
index edfc0d4..ed64eb8 100644
--- a/docs/pages/how-to/contribute-to-docs.html
+++ b/docs/pages/how-to/contribute-to-docs.html
@@ -1,4 +1,4 @@
-Contribute to these docs | rotten-deps - v1.0.1
diff --git a/package.json b/package.json
index 484b94c..6baa5f8 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "rotten-deps",
- "version": "1.0.1",
+ "version": "2.0.0",
"description": "The command `npm outdated` only has two endpoints which are pass or fail. This dichotomy isn't very useful for CI flows which have pass, fail, or warn. This CLI utility combines `npm outdated` and `npm view` in order to establish a compliance period for dependency checks. This way if a dependency update is within your compliance period you can trigger a warn or if it's beyond your compliance period it can trigger a fail.",
"engines": {
"node": ">=14"
- Preparing search index...
- The search index is not available
rotten-deps - v2.0.0Module lib
Rotten Deps API
-Index
Type aliases
Variables
Functions
Type aliases
Report Response
Variables
Const configuration
Type declaration
create Config: (config: Config) => Config
Index
Type aliases
Variables
Functions
Type aliases
Report Response
Variables
Const configuration
Type declaration
create Config: (config: Config) => Config
Validates a raw configuration file and generates a report if any rules are misconfigured.
Parameters
config: Config
Parameters
absoluteFilePath: string
absolute path to the configuration file
-Returns FileReader
default
Type declaration
configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }
create Config: (config: Config) => Config
Returns FileReader
default
Type declaration
configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }
create Config: (config: Config) => Config
Validates a raw configuration file and generates a report if any rules are misconfigured.
Parameters
config: Config
Parameters
dependencyName: string
Returns DetailsRequest
create Outdated Request: () => OutdatedRequest
Creates a function for running
-npm outdated
Returns OutdatedRequest
Const npm
Type declaration
create Details Request: (dependencyName: string) => DetailsRequest
Returns OutdatedRequest
Const npm
Type declaration
create Details Request: (dependencyName: string) => DetailsRequest
Creates a function to run the
npm view
command for a specific dependencyParameters
dependencyName: string
Returns DetailsRequest
create Outdated Request: () => OutdatedRequest
Creates a function for running
-npm outdated
Returns OutdatedRequest
Functions
generate Report
Returns OutdatedRequest
Functions
generate Report
Compares the details on each dependency flagged as outdated in order to determine how stale a version actually is.
Parameters
c: Config
Optional r: Reporter
- Preparing search index...
- The search index is not available
rotten-deps - v1.0.1Module lib/config
- Preparing search index...
- The search index is not available
rotten-deps - v2.0.0Module lib/config
Rotten Deps configuration library
-Index
Interfaces
Variables
Functions
Variables
default
Type declaration
create Config: (config: Config) => Config
Index
Interfaces
Variables
Functions
Variables
default
Type declaration
create Config: (config: Config) => Config
Validates a raw configuration file and generates a report if any rules are misconfigured.
Parameters
config: Config
Parameters
absoluteFilePath: string
absolute path to the configuration file
-Returns FileReader
Functions
create Config
Returns FileReader
Functions
create Config
Validates a raw configuration file and generates a report if any rules are misconfigured.
Parameters
config: Config
rotten deps configuration object
-Returns Config
create File Reader
Returns Config
create File Reader
Creates a filereader function for fetching the contents of a config file at the provided path.
Parameters
absoluteFilePath: string
- Preparing search index...
- The search index is not available
rotten-deps - v1.0.1Module lib/npm-interactions
- Preparing search index...
- The search index is not available
rotten-deps - v2.0.0Module lib/npm-interactions
Rotten Deps NPM Interactions library
-Index
Interfaces
Variables
Functions
Variables
default
Type declaration
create Details Request: (dependencyName: string) => DetailsRequest
Index
Interfaces
Variables
Functions
Variables
default
Type declaration
create Details Request: (dependencyName: string) => DetailsRequest
Creates a function to run the
npm view
command for a specific dependencyParameters
dependencyName: string
Returns DetailsRequest
create Outdated Request: () => OutdatedRequest
Creates a function for running
-npm outdated
Returns OutdatedRequest
Functions
create Details Request
Returns OutdatedRequest
Functions
create Details Request
Creates a function to run the
npm view
command for a specific dependencyParameters
dependencyName: string
Returns DetailsRequest
create Outdated Request
Returns DetailsRequest
create Outdated Request
Creates a function for running
npm outdated
Returns OutdatedRequest
Generated using TypeDoc
- Preparing search index...
- The search index is not available
rotten-deps - v1.0.1Contribute to these docs
- Preparing search index...
- The search index is not available
rotten-deps - v2.0.0Contribute to these docs
How to contribute to the documentation
diff --git a/docs/pages/how-to/create-a-config-file.html b/docs/pages/how-to/create-a-config-file.html index 64f7687..1f28822 100644 --- a/docs/pages/how-to/create-a-config-file.html +++ b/docs/pages/how-to/create-a-config-file.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
rotten-deps - v1.0.1Release
- Preparing search index...
- The search index is not available
rotten-deps - v2.0.0Release
How to create and use a configuration file
diff --git a/package.json b/package.json index 484b94c..6baa5f8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rotten-deps", - "version": "1.0.1", + "version": "2.0.0", "description": "The command `npm outdated` only has two endpoints which are pass or fail. This dichotomy isn't very useful for CI flows which have pass, fail, or warn. This CLI utility combines `npm outdated` and `npm view` in order to establish a compliance period for dependency checks. This way if a dependency update is within your compliance period you can trigger a warn or if it's beyond your compliance period it can trigger a fail.", "engines": { "node": ">=14"