libyear

https://www.npmjs.com/package/libyear
Admin
A Node.js implementation that measures software dependency freshness through metrics like drift,...
Tokens:40,797
Snippets:686
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Libyear Package

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Install the libyear package using npm.

```bash
npm i libyear
```

--------------------------------

### Install libyear with npm

Source: https://www.npmjs.com/package/libyear/v/0.1.7

Install libyear as a development dependency using npm.

```bash
npm install --save-dev libyear
```

--------------------------------

### Install libyear package

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=dependencies

Command to install a specific version of libyear.

```bash
npm i libyear@0.3.0
```

--------------------------------

### Install libyear with npm

Source: https://www.npmjs.com/package/libyear/v/0.2.0

Use npx to run libyear directly without installation.

```bash
npx libyear
```

--------------------------------

### Enable Corepack and Install Dependencies

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Use these commands to set up the development environment for the libyear project.

```bash
corepack enable
yarn install
```

--------------------------------

### Install Libyear Package

Source: https://www.npmjs.com/package/libyear/v/0.1.8?activeTab=readme

Install a specific version of the libyear package using npm.

```bash
npm i libyear@0.1.8
```

--------------------------------

### Configuration File Structure Example

Source: https://www.npmjs.com/package/libyear?activeTab=dependents

This JSON structure outlines the configuration options available for libyear, including overrides for specific packages and global limits for various metrics like drift, pulse, releases, major, minor, and patch versions.

```json
{
  "overrides": {
    "^@types/": {
      "defer": "2020-01-01", // string (ISO formatted Date)
      "drift": null, // number (default: null)
      "pulse": null, // number (default: null)
      "releases": null, // integer (default: null)
      "major": null, // integer (default: null)
      "minor": null, // integer (default: null)
      "patch": null, // integer (default: null)
    }
  },
  "limit": {
    "drift": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "pulse": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "releases": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "major": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "minor": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "patch": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
  }
}
```

--------------------------------

### Override Specific Dependency Configuration

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Example of how to configure overrides for a specific dependency using a regular expression. Ensure to use start and end anchors for precise matching.

```json
{
  "overrides": {
    "^libyear$": {}
  }
}
```

--------------------------------

### Install libyear package

Source: https://www.npmjs.com/package/libyear/v/0.1.7

Install a specific version of the libyear package using npm.

```bash
npm i libyear@0.1.7
```

--------------------------------

### Install and Run libyear with Yarn Classic

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Install libyear as a dev dependency and then run it using the 'yarn libyear' command for projects managed with Yarn Classic (v1).

```bash
yarn add --dev libyear
yarn libyear
```

--------------------------------

### Install libyear package

Source: https://www.npmjs.com/package/libyear/v/0.2.0

Install a specific version of the libyear package using npm.

```bash
npm i libyear@0.2.0
```

--------------------------------

### Install libyear with Yarn Berry

Source: https://www.npmjs.com/package/libyear/v/0.2.0

Use `yarn dlx` to execute libyear with Yarn Berry (v2+).

```bash
yarn dlx libyear
```

--------------------------------

### Install libyear with yarn classic

Source: https://www.npmjs.com/package/libyear/v/0.1.7

Install libyear as a development dependency using yarn classic.

```bash
yarn install --save-dev libyear
```

--------------------------------

### Configure libyear with CLI flags

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=dependencies

Examples of using CLI flags to set package manager and drift thresholds.

```bash
--package-manager berry
```

```bash
--threshold-drift-collective=<libyears>
```

```bash
--threshold-drift-individual=<libyears>
```

```bash
--threshold-pulse-collective=<libyears>
```

```bash
--threshold-pulse-individual=<libyears>
```

--------------------------------

### Install libyear with Yarn Classic

Source: https://www.npmjs.com/package/libyear/v/0.2.0

Install libyear as a dev dependency for Yarn Classic (v1). Add a script to package.json for easy execution.

```bash
yarn install --save-dev libyear
```

```json
{
  "scripts": {
    "libyear": "libyear"
  }
}
```

```bash
yarn libyear
```

--------------------------------

### Install libyear with yarn classic

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=versions

Install libyear as a development dependency using yarn classic. This allows running libyear via npm scripts.

```bash
yarn add --dev libyear
```

--------------------------------

### Configure libyear with CLI options

Source: https://www.npmjs.com/package/libyear?activeTab=dependents

Example of using CLI flags to customize libyear's behavior, such as including all dependencies and setting drift limits.

```bash
npx libyear --all --limit-drift-collective=5 --limit-drift-individual=2
```

--------------------------------

### Install Libyear Package

Source: https://www.npmjs.com/package/libyear/v/0.9.2?activeTab=code

Install the libyear package version 0.9.2 using npm. This command adds the specified version of the package to your project's dependencies.

```bash
npm i libyear@0.9.2
```

--------------------------------

### Override Type Definition Dependencies

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Example demonstrating how to set a more lenient pulse limit for type definition dependencies using a regular expression override.

```json
{
  "overrides": {
    "^@types/": {
      "pulse": null
    }
  }
}
```

--------------------------------

### Include all dependencies with libyear

Source: https://www.npmjs.com/package/libyear/v/0.7.0?activeTab=dependencies

Use the --all flag to include dependencies from the entire project, supported with 'berry' or 'pnpm'.

```bash
--all
```

--------------------------------

### Specify configuration file with --config

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Provide a path to a custom libyear configuration file using the --config option.

```bash
npx libyear --config=./.libyearrc.json
```

--------------------------------

### Include all dependencies with --all

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Use the --all flag to include dependencies from the entire project. Note: This option is only supported with Yarn Berry or pnpm.

```bash
npx libyear --all
```

--------------------------------

### Configure libyear with a JSON file

Source: https://www.npmjs.com/package/libyear/v/0.7.0?activeTab=dependencies

Specify a custom path to the libyear configuration file using the --config flag.

```bash
--config=<path>
```

--------------------------------

### Add libyear script to package.json

Source: https://www.npmjs.com/package/libyear/v/0.1.7

Add a script to your package.json to easily run libyear.

```json
{
  "scripts": {
    "libyear": "libyear"
  }
}
```

--------------------------------

### Configure libyear CLI thresholds

Source: https://www.npmjs.com/package/libyear/v/0.2.0

Set thresholds for collective and individual drift and pulse metrics to enforce dependency freshness rules in CI.

```bash
--threshold-drift-collective=<libyears>
```

```bash
--threshold-drift-individual=<libyears>
```

```bash
--threshold-pulse-collective=<libyears>
```

```bash
--threshold-pulse-individual=<libyears>
```

--------------------------------

### CLI Option: Package Manager

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Specify the package manager to be used by libyear. Defaults to inference.

```bash
--package-manager <berry|npm|yarn>
```

--------------------------------

### Run libyear with yarn classic

Source: https://www.npmjs.com/package/libyear/v/0.1.7

Run the libyear script defined in package.json using yarn classic.

```bash
yarn libyear
```

--------------------------------

### Run libyear with pnpm

Source: https://www.npmjs.com/package/libyear?activeTab=readme

Execute the libyear CLI using pnpx for projects managed with pnpm. This command runs the default analysis.

```bash
pnpx libyear
```

--------------------------------

### Libyear Configuration Structure

Source: https://www.npmjs.com/package/libyear/v/0.6.2?activeTab=code

Defines the expected structure for libyear configuration files, including overrides and threshold settings for different metrics.

```json
{
  "overrides": {
    "^@types/": {
      "defer": "2020-01-01", // string (ISO formatted Date)
      "drift": null, // number (default: null)
      "pulse": null, // number (default: null)
      "releases": null, // integer (default: null)
      "major": null, // integer (default: null)
      "minor": null, // integer (default: null)
      "patch": null, // integer (default: null)
    }
  },
  "threshold": {
    "drift": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "pulse": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "releases": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "major": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "minor": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "patch": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    }
  }
}
```

--------------------------------

### CLI Option: Threshold Releases Individual

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for individual releases metrics. Exits with failure if any exceed it.

```bash
--threshold-releases-individual=<count>
-r=<count>
```

--------------------------------

### Specify package manager for libyear

Source: https://www.npmjs.com/package/libyear/v/0.7.0?activeTab=dependencies

Manually set the package manager (e.g., 'berry', 'npm', 'pnpm', 'yarn') for libyear using the --package-manager flag.

```bash
--package-manager
```

--------------------------------

### Libyear Configuration Structure

Source: https://www.npmjs.com/package/libyear/v/0.6.2?activeTab=readme

This JSON structure outlines the configuration options for libyear, including overrides and thresholds for different metrics like drift, pulse, releases, major, minor, and patch.

```json
{
  "overrides": {
    "^@types/": {
      "defer": "2020-01-01",
      "drift": null,
      "pulse": null,
      "releases": null,
      "major": null,
      "minor": null,
      "patch": null
    }
  },
  "threshold": {
    "drift": {
      "collective": null,
      "individual": null
    },
    "pulse": {
      "collective": null,
      "individual": null
    },
    "releases": {
      "collective": null,
      "individual": null
    },
    "major": {
      "collective": null,
      "individual": null
    },
    "minor": {
      "collective": null,
      "individual": null
    },
    "patch": {
      "collective": null,
      "individual": null
    }
  }
}
```

--------------------------------

### Libyear Configuration Structure

Source: https://www.npmjs.com/package/libyear?activeTab=code

Defines the overall structure for libyear configuration, including overrides and limit settings for various metrics.

```json
{
  "overrides": {
    "^@types/": {
      "defer": "2020-01-01", // string (ISO formatted Date)
      "drift": null, // number (default: null)
      "pulse": null, // number (default: null)
      "releases": null, // integer (default: null)
      "major": null, // integer (default: null)
      "minor": null, // integer (default: null)
      "patch": null, // integer (default: null)
    }
  },
  "limit": {
    "drift": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "pulse": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "releases": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "major": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "minor": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
    "patch": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    }
  }
}
```

--------------------------------

### Configure drift threshold (individual)

Source: https://www.npmjs.com/package/libyear/v/0.1.8?activeTab=dependents

Set a threshold for individual dependency drift. The process will exit with a failure code if any dependency's drift exceeds this value.

```bash
libyear --threshold-drift-individual 10
```

--------------------------------

### Libyear Configuration Structure

Source: https://www.npmjs.com/package/libyear/v/0.5.0?activeTab=code

Defines the overall structure for libyear configuration, including overrides and thresholds for drift, pulse, and releases.

```json
{
  "overrides": {
    "^@types/": {
      "defer": "2020-01-01", // string (ISO formatted Date)
      "drift": null, // number (default: null)
      "pulse": null, // number (default: null)
      "releases": null, // integer (default: null)
    },
  },
  "threshold": {
    "drift": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "pulse": {
      "collective": null, // number (default: null)
      "individual": null, // number (default: null)
    },
    "releases": {
      "collective": null, // integer (default: null)
      "individual": null, // integer (default: null)
    },
  },
}
```

--------------------------------

### Set individual releases threshold

Source: https://www.npmjs.com/package/libyear/v/0.4.2

Configure libyear to exit with an error if any single dependency has a release count between current and latest that exceeds a specified number. Use the -r flag.

```bash
--threshold-releases-individual=<count>
```

--------------------------------

### Set collective releases threshold

Source: https://www.npmjs.com/package/libyear/v/0.4.2

Configure libyear to exit with an error if the total number of stable releases between current and latest dependencies exceeds a specified count. Use the -R flag.

```bash
--threshold-releases-collective=<count>
```

--------------------------------

### Set Individual Pulse Threshold

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=code

Configure libyear to exit with an error if any single dependency's pulse exceeds a specified number of libyears. Use the -p flag.

```bash
--threshold-pulse-individual=<libyears>
```

--------------------------------

### CLI Option: Threshold Drift Individual

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for individual drift metrics. Exits with failure if any exceed it.

```bash
--threshold-drift-individual=<libyears>
-d=<libyears>
```

--------------------------------

### Output libyear report as JSON

Source: https://www.npmjs.com/package/libyear?activeTab=dependents

Generate the libyear report in JSON format for programmatic use.

```bash
npx libyear --json
```

--------------------------------

### CLI Option: Threshold Pulse Individual

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for individual pulse metrics. Exits with failure if any exceed it.

```bash
--threshold-pulse-individual=<libyears>
-p=<libyears>
```

--------------------------------

### Configure libyear pulse thresholds

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=dependencies

Set thresholds for collective and individual dependency pulse using CLI flags. A breach will cause the process to exit with a failure code.

```bash
--threshold-pulse-collective=<libyears>
```

```bash
--threshold-pulse-individual=<libyears>
```

--------------------------------

### Set Individual Drift Threshold

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=code

Configure libyear to exit with an error if any single dependency's drift exceeds a specified number of libyears. Use the -d flag.

```bash
--threshold-drift-individual=<libyears>
```

--------------------------------

### Set Pulse Threshold (Individual)

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=code

Configure libyear to exit with a failure code if any individual dependency's pulse check exceeds a specified number of libyears. Use the -p flag for individual pulse.

```bash
libyear --threshold-pulse-individual=<libyears>
```

--------------------------------

### Disable dev dependencies in libyear

Source: https://www.npmjs.com/package/libyear?activeTab=dependents

Run libyear excluding development dependencies. Note: This option is only supported for npm and pnpm.

```bash
npx libyear --no-dev
```

--------------------------------

### Configure libyear drift thresholds

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=dependencies

Set thresholds for collective and individual dependency drift using CLI flags. A breach will cause the process to exit with a failure code.

```bash
--threshold-drift-collective=<libyears>
```

```bash
--threshold-drift-individual=<libyears>
```

--------------------------------

### Set individual pulse limit with --limit-pulse-individual

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Set a maximum threshold for individual dependency pulse metrics. If any dependency exceeds this limit, the process will exit with a failure code. Accepts a number of libyears.

```bash
npx libyear -p=3
```

--------------------------------

### Configure pulse threshold (collective)

Source: https://www.npmjs.com/package/libyear/v/0.1.8?activeTab=dependents

Set a threshold for the collective pulse metric. The process will exit with a failure code if the total pulse metric surpasses this value.

```bash
libyear --threshold-pulse-collective 5
```

--------------------------------

### Set individual drift limit with --limit-drift-individual

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Set a maximum threshold for individual dependency drift metrics. If any dependency exceeds this limit, the process will exit with a failure code. Accepts a number of libyears.

```bash
npx libyear -d=2
```

--------------------------------

### CLI Option: Threshold Releases Collective

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for the collective releases metric. Exits with failure if exceeded.

```bash
--threshold-releases-collective=<count>
-R=<count>
```

--------------------------------

### Set Collective Pulse Threshold

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=code

Configure libyear to exit with an error if the total dependency pulse exceeds a specified number of libyears. Use the -P flag.

```bash
--threshold-pulse-collective=<libyears>
```

--------------------------------

### Set Drift Threshold (Collective)

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=code

Configure libyear to exit with a failure code if the total dependency drift exceeds a specified number of libyears. Use the -D flag for collective drift.

```bash
libyear --threshold-drift-collective=<libyears>
```

--------------------------------

### Set collective releases limit with --limit-releases-collective

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Set a maximum threshold for the total number of stable releases between current and latest versions. If exceeded, the process will exit with a failure code. Accepts an integer count.

```bash
npx libyear -R=20
```

--------------------------------

### Set Pulse Threshold (Collective)

Source: https://www.npmjs.com/package/libyear/v/0.3.0?activeTab=code

Configure libyear to exit with a failure code if the total dependency pulse check exceeds a specified number of libyears. Use the -P flag for collective pulse.

```bash
libyear --threshold-pulse-collective=<libyears>
```

--------------------------------

### Set Collective Drift Threshold

Source: https://www.npmjs.com/package/libyear/v/0.2.0?activeTab=code

Configure libyear to exit with an error if the total dependency drift exceeds a specified number of libyears. Use the -D flag.

```bash
--threshold-drift-collective=<libyears>
```

--------------------------------

### Set collective pulse limit with --limit-pulse-collective

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Set a maximum threshold for the collective pulse metric. If exceeded, the process will exit with a failure code. Accepts a number of libyears.

```bash
npx libyear -P=10
```

--------------------------------

### CLI Option: Threshold Drift Collective

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for the collective drift metric. Exits with failure if exceeded.

```bash
--threshold-drift-collective=<libyears>
-D=<libyears>
```

--------------------------------

### CLI Option: Threshold Pulse Collective

Source: https://www.npmjs.com/package/libyear/v/0.4.2?activeTab=code

Set a threshold for the collective pulse metric. Exits with failure if exceeded.

```bash
--threshold-pulse-collective=<libyears>
-P=<libyears>
```

--------------------------------

### Set collective drift limit with --limit-drift-collective

Source: https://www.npmjs.com/package/libyear?activeTab=versions

Set a maximum threshold for the collective drift metric. If exceeded, the process will exit with a failure code. Accepts a number of libyears.

```bash
npx libyear -D=5
```
Tokens:
Raw