Skip to content
CSV Grid Editor

Pipeline schema

This page is generated from the same JSON schema the extension validates pipeline files against, so it is always exactly what the extension accepts. For the narrative version, read the Pipelines guide.

Add the $schema key to get completion and validation while you type:

{
  "$schema": "https://raw.githubusercontent.com/bash-365/csv-vscoode/main/schemas/csvpipe.schema.json",
  "name": "Clean sales export",
  "steps": [{ "kind": "trim" }]
}

Files named *.csvpipe.json are validated automatically; the $schema key only matters outside VS Code.

Top-level fields

Section titled “Top-level fields”
Field Type Required Description
name string yes Display name of the pipeline.
description string no —
applyTo array of string no Workspace-relative glob patterns for the files this pipeline applies to (used by onOpen/onSave triggers and for suggestions).
trigger "manual" | "onOpen" | "onSave" no manual: run from the panel or command; onOpen: apply to the document when a matching file opens in the grid (pre-processing, undoable); onSave: run after a matching file is saved (post-processing, e.g. export). Default: "manual".
output object no —
steps array of step yes —

Step kinds

Section titled “Step kinds”

Every step is an object with a kind. Steps run in order, each one receiving the table the previous step produced. All steps also accept the shared fields below.

Shared step fields

Section titled “Shared step fields”
Field Type Description
label string Optional label shown in logs and the panel.
disabled boolean —

filter — Filter rows (low-code)

Section titled “filter — Filter rows (low-code)”
Field Type Required Description
expression string yes JavaScript expression evaluated per row; columns are variables (e.g. price > 5 && contains(name, ‘widget’)).

compute — Compute column (low-code)

Section titled “compute — Compute column (low-code)”
Field Type Required Description
column string yes Column to add or overwrite.
expression string yes JavaScript expression, e.g. round(price * qty, 2).

rename — Rename column

Section titled “rename — Rename column”
Field Type Required Description
from string yes —
to string yes —

select — Select columns

Section titled “select — Select columns”
Field Type Required Description
columns columns yes —

drop — Drop columns

Section titled “drop — Drop columns”
Field Type Required Description
columns columns yes —

sort — Sort rows

Section titled “sort — Sort rows”
Field Type Required Description
column string yes —
direction "asc" | "desc" no Default: "asc".

dedupe — Remove duplicates

Section titled “dedupe — Remove duplicates”
Field Type Required Description
columns columns no —

trim — Trim whitespace

Section titled “trim — Trim whitespace”
Field Type Required Description
columns columns no —

changeCase — Change case

Section titled “changeCase — Change case”
Field Type Required Description
columns columns no —
case "upper" | "lower" | "title" yes —

replace — Find and replace

Section titled “replace — Find and replace”
Field Type Required Description
columns columns no —
find string yes —
replacement string no Default: "".
regex boolean no Default: false.
caseSensitive boolean no Default: false.

fillEmpty — Fill empty cells

Section titled “fillEmpty — Fill empty cells”
Field Type Required Description
columns columns no —
value string yes —

limit — Limit rows

Section titled “limit — Limit rows”
Field Type Required Description
count integer yes —
offset integer no Default: 0.

splitColumn — Split column

Section titled “splitColumn — Split column”
Field Type Required Description
column string yes —
separator string yes —
limit integer no Default: 0.
regex boolean no Default: false.
removeSource boolean no Default: false.

mergeColumns — Merge columns

Section titled “mergeColumns — Merge columns”
Field Type Required Description
columns columns yes —
separator string no Default: " ".
name string yes —
removeSources boolean no Default: false.

transpose — Transpose

Section titled “transpose — Transpose”

Takes no options beyond the shared fields.

removeEmptyRows — Remove empty rows

Section titled “removeEmptyRows — Remove empty rows”

Takes no options beyond the shared fields.

sample — Random sample

Section titled “sample — Random sample”
Field Type Required Description
count integer yes —
seed integer no Default: 42.

script — Inline JavaScript (code)

Section titled “script — Inline JavaScript (code)”
Field Type Required Description
code string yes Function body with columns, rows (array of objects), helpers and table in scope. Return rows, { columns, rows }, or nothing to keep in-place mutations.

scriptFile — Script file (code)

Section titled “scriptFile — Script file (code)”
Field Type Required Description
path string yes Workspace-relative .js file exporting (table, helpers) => table.

sql — SQL (code)

Section titled “sql — SQL (code)”
Field Type Required Description
query string yes SQLite query; the current data is available as table csv.

command — External command (code)

Section titled “command — External command (code)”
Field Type Required Description
command string yes Shell command run from the workspace root. Receives the data on stdin, must print the result to stdout.
format "csv" | "json" no Default: "csv".