feat(list-csv): remove description, improve allowFailure and needs output

- Remove description column from --list-csv entirely for stable CSV
  structure (description is already visible in --list)
- Improve allowFailure to properly render exit_codes as [code1,code2]
- Improve needs to show empty string when null (stage ordering) vs []
  when explicitly set to no dependencies

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: bcouetil

.gitignore

@@ -9,4 +9,6 @@
 /.gitlab-ci-local/
 .DS_Store
 .vscode
+.history
+/tmp/
 /.gitlab-ci.yml

README.md

@@ -201,25 +201,27 @@ deploy-job               deploy  never       false          [build-job]
 The command `gitlab-ci-local --list-csv` will output the pipeline jobs as csv formatted list and will also filter all
 jobs which are set
 to `when: never`.
-The description will always be wrapped in quotes (even if there is none) to prevent semicolons in the description
-disturb the csv structure.
 
 ```text
-name;description;stage;when;allow_failure;needs
-test-job;"Run Tests";test;on_success;false;[]
-build-job;"";build;on_success;true;[test-job]
+name;stage;when;allowFailure;needs
+test-job;test;on_success;false;
+build-job;build;on_success;true;[test-job]
+deploy-job;deploy;on_success;[99];
 ```
 
+- **allowFailure**: `true`, `false`, or `[exit_code1,exit_code2]` when specific exit codes are allowed to fail
+- **needs**: empty when not specified (job follows stage ordering), `[]` when explicitly set to no dependencies (job starts immediately)
+
 #### --list-csv-all
 
-Same as `--list-csv-all` but will also print out jobs which are set to `when: never` (directly and implicit e.g. via
+Same as `--list-csv` but will also print out jobs which are set to `when: never` (directly and implicit e.g. via
 rules).
 
 ```text
-name;description;stage;when;allow_failure;needs
-test-job;"Run Tests";test;on_success;false;[]
-build-job;"";build;on_success;true;[test-job]
-deploy-job;"";deploy;never;false;[build-job]
+name;stage;when;allowFailure;needs
+test-job;test;on_success;false;
+build-job;build;on_success;true;[test-job]
+deploy-job;deploy;never;false;
 ```
 
 ## Quirks

src/commander.ts

@@ -267,10 +267,20 @@ export class Commander {
             jobs = jobs.filter(j => j.when !== "never");
         }
 
-        writeStreams.stdout("name;description;stage;when;allowFailure;needs\n");
+        writeStreams.stdout("name;stage;when;allowFailure;needs\n");
+
         jobs.forEach((job) => {
-            const needs = job.needs?.filter(n => !n.project && !n.pipeline).map(n => n.job).join(",") ?? [];
-            writeStreams.stdout(`${job.name};"${job.description}";${job.stage};${job.when};${job.allowFailure ? "true" : "false"};[${needs}]\n`);
+            const needs = job.needs === null ? "" : `[${job.needs.filter(n => !n.project && !n.pipeline).map(n => n.job).join(",")}]`;
+            let allowFailure: string;
+            if (typeof job.allowFailure === "object") {
+                const codes = Array.isArray(job.allowFailure.exit_codes) ? job.allowFailure.exit_codes : [job.allowFailure.exit_codes];
+                allowFailure = `[${codes.join(",")}]`;
+            } else {
+                allowFailure = job.allowFailure ? "true" : "false";
+            }
+
+            const row = [job.name, job.stage, job.when, allowFailure, needs].join(";");
+            writeStreams.stdout(`${row}\n`);
         });
     }
 

tests/test-cases/list-csv-case/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ---
-stages: [test, build]
+stages: [test, build, deploy]
 
 # @Description Run Tests
 test-job:
@@ -14,3 +14,18 @@ build-job:
   allow_failure: true
   script:
     - 'echo "Build something"'
+
+exit-codes-job:
+  stage: build
+  needs: []
+  allow_failure:
+    exit_codes: [42, 137]
+  script:
+    - 'echo "Exit codes"'
+
+deploy-job:
+  stage: deploy
+  allow_failure:
+    exit_codes: 1
+  script:
+    - 'echo "Deploy"'

tests/test-cases/list-csv-case/integration.test.ts

@@ -16,9 +16,11 @@ test.concurrent("list-csv-case --list-csv", async () => {
     }, writeStreams);
 
     const expected = [
-        "name;description;stage;when;allowFailure;needs",
-        "test-job;\"Run Tests\";test;on_success;false;[]",
-        "build-job;\"\";build;on_success;true;[test-job]",
+        "name;stage;when;allowFailure;needs",
+        "test-job;test;on_success;false;",
+        "build-job;build;on_success;true;[test-job]",
+        "exit-codes-job;build;on_success;[42,137];[]",
+        "deploy-job;deploy;on_success;[1];",
     ];
     expect(writeStreams.stdoutLines).toEqual(expect.arrayContaining(expected));
 });
@@ -34,10 +36,11 @@ test.concurrent("list-csv-case --list-csv colon should add process descriptors w
     }, writeStreams);
 
     const expected = [
-        "name;description;stage;when;allowFailure;needs",
-        "test-job;\"Run;Tests\";test;on_success;false;[]",
-        "build-job;\"\";build;on_success;true;[test-job]",
+        "name;stage;when;allowFailure;needs",
+        "test-job;test;on_success;false;",
+        "build-job;build;on_success;true;[test-job]",
     ];
     expect(writeStreams.stdoutLines).toEqual(expect.arrayContaining(expected));
 });
 
+