WIP Fix parsing of !reference tag

Fix: #50

Author: titouanmathis

package-lock.json

@@ -48,8 +48,8 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "jest-diff": "^29.7.0",
-    "js-yaml": "^4.1.0",
-    "prettier-linter-helpers": "^1.0.0"
+    "prettier-linter-helpers": "^1.0.0",
+    "yaml": "2.7.0"
   },
   "peerDependencies": {
     "prettier": "^3.0"

package.json

@@ -1,44 +1,19 @@
 #!/usr/bin/env node
-import { readFileSync, mkdirSync, writeFileSync } from 'node:fs';
-import { cwd, env } from 'node:process';
-import { join, resolve, dirname } from 'node:path';
-import yaml from 'js-yaml';
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { env } from 'node:process';
+import { dirname } from 'node:path';
 import { diff } from './formatters/diff.js';
 import { gitlab } from './formatters/gitlab.js';
 import { parse } from './utils/parse-prettier-results.js';
-
-const {
-  // Used as a fallback for local testing.
-  CI_CONFIG_PATH = '.gitlab-ci.yml',
-  CI_JOB_NAME,
-  CI_PROJECT_DIR = cwd(),
-} = env;
-
-/**
- * Get the output path for the report file.
- * @returns {string}
- */
-function getOutputPath() {
-  const jobs = yaml.load(readFileSync(join(CI_PROJECT_DIR, CI_CONFIG_PATH), 'utf-8'));
-  const { artifacts } = jobs[CI_JOB_NAME];
-  const location = artifacts && artifacts.reports && artifacts.reports.codequality;
-  const msg = `Expected ${CI_JOB_NAME}.artifacts.reports.codequality to be one exact path`;
-  if (!location) {
-    throw new Error(`${msg}, but no value was found.`);
-  }
-  if (Array.isArray(location)) {
-    throw new Error(`${msg}, but found an array instead.`);
-  }
-  return resolve(CI_PROJECT_DIR, location);
-}
+import { getOutputPath } from './utils/get-output-path.js';
 
 /**
  * Format Prettier results for GitLab Code Quality Reports.
  * @param   {string} results
  * @returns {Promise<void>}
  */
 export async function prettierFormatterGitLab(results) {
-  const { PRETTIER_CODE_QUALITY_REPORT } = env;
+  const { CI_JOB_NAME, PRETTIER_CODE_QUALITY_REPORT } = env;
   if (CI_JOB_NAME || PRETTIER_CODE_QUALITY_REPORT) {
     const files = parse(results);
 

src/index.js

@@ -0,0 +1,46 @@
+import { readFileSync } from 'node:fs';
+import { cwd, env } from 'node:process';
+import { join, resolve } from 'node:path';
+import { parseDocument } from 'yaml';
+
+/** @type {yaml.CollectionTag} */
+const referenceTag = {
+  tag: '!reference',
+  collection: 'seq',
+  default: false,
+  resolve() {
+    // We only allow the syntax. We don’t actually resolve the reference.
+  },
+};
+
+/**
+ * Get the output path for the report file.
+ * @returns {string}
+ */
+export function getOutputPath() {
+  const {
+    // Used as a fallback for local testing.
+    CI_CONFIG_PATH = '.gitlab-ci.yml',
+    CI_JOB_NAME,
+    CI_PROJECT_DIR = cwd(),
+  } = env;
+
+  const jobs = parseDocument(readFileSync(join(CI_PROJECT_DIR, CI_CONFIG_PATH), 'utf-8'), {
+    version: '1.1',
+    customTags: [referenceTag],
+  });
+
+  const { artifacts } = jobs[CI_JOB_NAME];
+  const location = artifacts && artifacts.reports && artifacts.reports.codequality;
+  const msg = `Expected ${CI_JOB_NAME}.artifacts.reports.codequality to be one exact path`;
+
+  if (!location) {
+    throw new Error(`${msg}, but no value was found.`);
+  }
+
+  if (Array.isArray(location)) {
+    throw new Error(`${msg}, but found an array instead.`);
+  }
+
+  return resolve(CI_PROJECT_DIR, location);
+}