Skip to content

Commit 941d80d

Browse files
committed
Add docs about options ignore platform reqs
1 parent 32e2587 commit 941d80d

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "ignore_platform_requirements"
3+
date: 2026-01-25T10:00:00+01:00
4+
anchor: "ignore-platform-requirements"
5+
weight:
6+
---
7+
8+
## Configuration
9+
10+
<div className="config-wrapper"><div className="config">__name__: ignore_platform_requirements</div>
11+
<div className="config">__type__: int</div>
12+
<div className="config">__default__: 0</div></div>
13+
14+
```json showLineNumbers
15+
{
16+
"name": "company/project",
17+
"extra": {
18+
"violinist": {
19+
// highlight-next-line
20+
"ignore_platform_requirements": 0
21+
}
22+
}
23+
}
24+
```
25+
26+
Ignore PHP platform requirements when checking for updates.
27+
28+
## Explanation
29+
30+
When enabled, Violinist will pass the `--ignore-platform-reqs` flag to Composer commands. This tells Composer to ignore platform requirements (PHP version, extensions, etc.) when resolving and updating dependencies.
31+
32+
This can be useful when the PHP version or extensions available in Violinist's environment differ from your production environment.
33+
34+
## Example
35+
36+
Say you have a project that requires PHP 8.2, but Violinist runs with a different PHP version. Without this option, Composer might refuse to update packages because of the PHP version mismatch. To work around this, enable `ignore_platform_requirements`:
37+
38+
```json showLineNumbers
39+
{
40+
"name": "company/project",
41+
"description": "My awesome project",
42+
"require": {
43+
"php": "^8.2",
44+
"vendor/package": "~1.0.0"
45+
},
46+
"extra": {
47+
"violinist": {
48+
// highlight-next-line
49+
"ignore_platform_requirements": 1
50+
}
51+
}
52+
}
53+
```
54+
55+
With this configuration, Violinist will ignore the PHP version requirement and proceed with checking for updates. Your CI pipeline should still verify that the updated dependencies work correctly with your actual PHP version.

0 commit comments

Comments
 (0)