diff --git a/CHANGELOG.md b/CHANGELOG.md index 11bf425..17f8b8f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,27 @@ +## v1.0.0 + +🎉 With the hem and haw of the CHANGELOG all of the previous betas weren't done in a way to nicely rollup for the v1.0.0 release notes. So instead here is a nice list of the features I'm launching this with: + +### API + +- Everything is organized so that you can directly import `rotten-deps` and use it for programmatic report generation. You can also import the individual libraries for processing config and interacting with NPM but this isn't officially supported at this moment. + +### CLI + +- You can set a default expiration via the CLI flag `--default-expiration` +- You can output raw JSON instead of a table using the `--json` flag +- By default you get a nice table display + +### Exit codes for CI + +As mentioned in the main `README.md` the project uses exit codes to differentiate between a success (no outdated), a warn (some outdated but within compliance windows), and a fail (something is outdated beyond compliance window). + +### Configuration + +- You can flat out ignore a dependency from the check using the `ignore` property of a rule +- You can give a dependency it's own compliance window separate from the default expiration +- You can provide a reason for the whitelist to help you remember why you whitelisted it in the first place (e.g. Depends on Bootstrap v1.2.3 upgrade) + ## v1.0.0-beta.26 ### Enhancement diff --git a/docs/index.html b/docs/index.html index f6178f5..2d0d9e5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
- Preparing search index...
- The search index is not available
rotten-deps - v1.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.0-beta.26Module lib/config
- Preparing search index...
- The search index is not available
rotten-deps - v1.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.0-beta.26Module lib/npm-interactions
- Preparing search index...
- The search index is not available
rotten-deps - v1.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.0-beta.26Contribute to these docs
- Preparing search index...
- The search index is not available
rotten-deps - v1.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 abba6ac..0bba2f1 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.0-beta.26Release
- Preparing search index...
- The search index is not available
rotten-deps - v1.0.0Release
How to create and use a configuration file
diff --git a/package.json b/package.json index 74ae4d5..fc941c3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rotten-deps", - "version": "1.0.0-beta.26", + "version": "1.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.", "main": "lib/index.js", "bin": "bin/rotten-deps.js",