Something went wrong. Try again.
A collection of +180 reusable WebAssembly modules for building composable CI/CD pipelines with FluentCI fluentci.io/modules
Something went wrong. Try again.
ruff component functions #
Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted.
run #
Execute arbitrary literal CLI arguments.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
arguments |
array |
yes | Literal native CLI argument tokens, passed without shell expansion. |
Returns Contract.ExecutionResult.
version #
Print the CLI version.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
Returns Contract.ExecutionResult.
check #
Lint Python sources; fixes require fix=true.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
config |
string |
no | Named configuration selected by the native tool. |
select |
string |
no | Select supplied to the ruff check operation. |
ignore |
string |
no | Ignore supplied to the ruff check operation. |
output-format |
string |
no | Output Format supplied to the ruff check operation. |
fix |
boolean |
no | Fix supplied to the ruff check operation. |
files |
array |
no | Files selected for the native operation; paths are passed literally without shell expansion. Default: ["."]. |
Returns Contract.ExecutionResult.
format #
Format Python sources.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
config |
string |
no | Named configuration selected by the native tool. |
line-length |
integer |
no | Line Length supplied to the ruff format operation. |
files |
array |
no | Files selected for the native operation; paths are passed literally without shell expansion. Default: ["."]. |
Returns Contract.ExecutionResult.
format-check #
Check Python formatting without writing files.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
config |
string |
no | Named configuration selected by the native tool. |
files |
array |
no | Files selected for the native operation; paths are passed literally without shell expansion. Default: ["."]. |
Returns Contract.ExecutionResult.