Add file option, to specify custom .gitlab-ci.yml locations inside cwd (#84)

Author: firecow

src/default-cmd.ts

@@ -7,9 +7,11 @@ import * as state from "./state";
 import {ExitError} from "./types/exit-error";
 import {assert} from "./asserts";
 
-const checkFolderAndFile = (cwd: string) => {
+const checkFolderAndFile = (cwd: string, file?: string) => {
     assert(fs.pathExistsSync(cwd), `${cwd} is not a directory`);
-    assert(fs.existsSync(`${cwd}/.gitlab-ci.yml`), `${cwd} does not contain .gitlab-ci.yml`);
+
+    const gitlabFilePath = file ? `${cwd}/${file}` : `${cwd}/.gitlab-ci.yml`;
+    assert(fs.existsSync(gitlabFilePath), `${cwd} does not contain ${file ?? ".gitlab-ci.yml"}`);
 };
 
 exports.command = "$0 [job]";
@@ -27,20 +29,20 @@ export async function handler(argv: any) {
     if (argv.completion != null) {
         yargs.showCompletionScript();
     } else if (argv.list != null) {
-        checkFolderAndFile(cwd);
+        checkFolderAndFile(cwd, argv.file);
         const pipelineIid = await state.getPipelineIid(cwd);
-        const parser = await Parser.create(cwd, pipelineIid);
+        const parser = await Parser.create(cwd, pipelineIid, false, argv.file);
         Commander.runList(parser);
     } else if (argv.job) {
-        checkFolderAndFile(cwd);
+        checkFolderAndFile(cwd, argv.file);
         const pipelineIid = await state.getPipelineIid(cwd);
-        const parser = await Parser.create(cwd, pipelineIid);
+        const parser = await Parser.create(cwd, pipelineIid, false, argv.file);
         await Commander.runSingleJob(parser, argv.job, argv.needs, argv.privileged);
     } else {
-        checkFolderAndFile(cwd);
+        checkFolderAndFile(cwd, argv.file);
         await state.incrementPipelineIid(cwd);
         const pipelineIid = await state.getPipelineIid(cwd);
-        const parser = await Parser.create(cwd, pipelineIid);
+        const parser = await Parser.create(cwd, pipelineIid, false, argv.file);
         await Commander.runPipeline(parser, argv.manual || [], argv.privileged);
     }
 }

src/index.ts

@@ -44,7 +44,7 @@ process.on('unhandledRejection', e => {
         })
         .option("cwd", {
             type: "string",
-            description: "Path to a gitlab-ci.yml",
+            description: "Path to a current working directory",
             requiresArg: true
         })
         .option("completion", {
@@ -57,6 +57,11 @@ process.on('unhandledRejection', e => {
             description: "Run needed jobs, when executing a single job",
             requiresArg: false
         })
+        .option("file", {
+            type: "string",
+            description: "Specify custom location of the .gitlab-ci.yml. Relative to cwd, eg. (gitlab/.gitlab-ci.yml)",
+            requiresArg: false
+        })
         .option("privileged", {
             type: "boolean",
             default: false,
@@ -67,7 +72,7 @@ process.on('unhandledRejection', e => {
             try {
                 const cwd = yargsArgv.cwd || process.cwd();
                 const pipelineIid = await state.getPipelineIid(cwd);
-                const parser = await Parser.create(cwd, pipelineIid, true);
+                const parser = await Parser.create(cwd, pipelineIid, true, yargsArgv.file);
                 return parser.getJobNames();
             } catch (e) {
                 return ["Parser-Failed!"];

src/parser.ts

@@ -20,6 +20,7 @@ export class Parser {
     private readonly jobs: Map<string, Job> = new Map();
     private readonly stages: Map<string, Stage> = new Map();
     private readonly cwd: string;
+    private readonly file?: string;
     private readonly pipelineIid: number;
 
     private gitRemote: GitRemote | null = null;
@@ -29,14 +30,15 @@ export class Parser {
     private maxJobNameLength = 0;
     private readonly tabCompletionPhase: boolean;
 
-    private constructor(cwd: string, pipelineIid: number, tabCompletionPhase: boolean) {
+    private constructor(cwd: string, pipelineIid: number, tabCompletionPhase: boolean, file?: string) {
         this.cwd = cwd;
         this.pipelineIid = pipelineIid;
         this.tabCompletionPhase = tabCompletionPhase;
+        this.file = file;
     }
 
-    static async create(cwd: string, pipelineIid: number, tabCompletionPhase = false) {
-        const parser = new Parser(cwd, pipelineIid, tabCompletionPhase);
+    static async create(cwd: string, pipelineIid: number, tabCompletionPhase: boolean, file: string) {
+        const parser = new Parser(cwd, pipelineIid, tabCompletionPhase, file);
 
         const time = process.hrtime();
         await parser.init();
@@ -131,7 +133,7 @@ export class Parser {
         this.userVariables = await Parser.initUserVariables(cwd, this.gitRemote, process.env.HOME);
 
         let ymlPath, yamlDataList: any[] = [];
-        ymlPath = `${cwd}/.gitlab-ci.yml`;
+        ymlPath = this.file ? `${cwd}/${this.file}` : `${cwd}/.gitlab-ci.yml`;
         const gitlabCiData = await Parser.loadYaml(ymlPath);
         yamlDataList = yamlDataList.concat(await Parser.prepareIncludes(gitlabCiData, cwd, this.gitRemote, this.tabCompletionPhase));