Merge pull request #43 from studiometa/bugfix/syntax-error

[Bugfix] Handle syntax error

Author: titouanmathis

.github/workflows/tests.yml

@@ -11,12 +11,21 @@ jobs:
   unit:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 20
-        cache: npm
-    - name: Install modules
-      run: npm install
-    - name: Run tests
-      run: npm run test -- --coverage
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install modules
+        run: npm install
+      - name: Run tests
+        run: npm run test -- --coverage --coverage-reporter lcov
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage/lcov.info
+          flags: unittests
+          fail_ci_if_error: false
+          verbose: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 /.data/
 gl-prettier-codequality.json
 /.eslintcache
+/coverage/

bin/cli.js

@@ -8,7 +8,7 @@ if (cmd) {
   exec(cmd, async (error, stdout, stderr) => {
     if (error) {
       console.log(error.message);
-      await prettierFormatterGitLab(stderr || stdout);
+      await prettierFormatterGitLab(stdout + stderr);
       process.exit(1);
     }
   });

package-lock.json

@@ -17,7 +17,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "bun test test/",
+    "test": "CI=true bun test test/",
     "lint": "eslint . --cache",
     "fix": "eslint . --cache --fix"
   },

package.json

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import { diffStringsUnified } from 'jest-diff';
-import getFileInfo from '../utils/get-file-info.js';
+import { getPrettierFileInfos } from '../utils/get-prettier-file-infos.js';
 
 /**
  * @typedef {import('../types.d.ts').FileInfo} FileInfo
@@ -9,21 +9,29 @@ import getFileInfo from '../utils/get-file-info.js';
 /**
  * Format Prettier formatting errors in diff format.
  * @param {Partial<FileInfo>} fileInfo A file Prettier informations.
+ * @returns {string}
  */
-function formatDiff({ filename, input, output }) {
-  console.log(`----------------------------------------------------
+function formatDiff({ filename, input, output, error } = {}) {
+  let diff = `----------------------------------------------------
 ${filename}
-----------------------------------------------------`);
-  console.log(
-    diffStringsUnified(input || '', output || '', {
+----------------------------------------------------
+`;
+
+  if (error) {
+    diff += String(error);
+  } else {
+    diff += diffStringsUnified(input || '', output || '', {
       aColor: chalk.red,
       bColor: chalk.green,
       omitAnnotationLines: true,
       contextLines: 2,
       expand: false,
-    }),
-  );
-  console.log('');
+    });
+  }
+
+  diff += '\n';
+
+  return diff;
 }
 
 /**
@@ -32,6 +40,6 @@ ${filename}
  * @returns {Promise<void>}
  */
 export async function diff(files) {
-  const infos = await Promise.all(files.map(getFileInfo));
-  infos.forEach(formatDiff);
+  const infos = await Promise.all(files.map((file) => getPrettierFileInfos(file)));
+  return infos.map((info) => formatDiff(info));
 }

src/formatters/diff.js

@@ -1,6 +1,6 @@
 import { createHash } from 'node:crypto';
 import { showInvisibles, generateDifferences } from 'prettier-linter-helpers';
-import getFileInfo from '../utils/get-file-info.js';
+import { getPrettierFileInfos } from '../utils/get-prettier-file-infos.js';
 
 /**
  * @typedef {import('../types.d.ts').FileInfo} FileInfo
@@ -23,10 +23,26 @@ function createFingerprint(...args) {
 /**
  * Format a file.
  * @param {Partial<FileInfo>} fileInfo
- * @returns {CodeQualityReport}
+ * @returns {CodeQualityReport[]}
  */
-function formatFile({ filename, input, output }) {
+function formatFile({ filename, input, output, error }) {
   const { INSERT, DELETE, REPLACE } = generateDifferences;
+
+  if (error) {
+    return [
+      {
+        type: 'issue',
+        check_name: 'prettier',
+        description: String(error),
+        severity: 'major',
+        fingerprint: createFingerprint(filename, error.message),
+        location: {
+          path: filename,
+        },
+      },
+    ];
+  }
+
   const differences = generateDifferences(input, output);
 
   return differences.map(({ offset, operation, deleteText = '', insertText = '' }) => {
@@ -74,6 +90,6 @@ function formatFile({ filename, input, output }) {
  * @returns {Promise<CodeQualityReport[]>}
  */
 export async function gitlab(files) {
-  const infos = await Promise.all(files.map(getFileInfo));
+  const infos = await Promise.all(files.map((file) => getPrettierFileInfos(file)));
   return infos.reduce((acc, fileInfo) => [...acc, ...formatFile(fileInfo)], []);
 }

src/formatters/gitlab.js

@@ -5,6 +5,7 @@ import { join, resolve, dirname } from 'node:path';
 import yaml from 'js-yaml';
 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.
@@ -31,23 +32,6 @@ function getOutputPath() {
   return resolve(CI_PROJECT_DIR, location);
 }
 
-/**
- * Parse the `prettier --list-different` output to format a GitLab Code Quality report JSON.
- * @param  {string}        results The output of a `prettier --list-different` failing command.
- * @returns {Array<object>}
- */
-function parse(results) {
-  return results
-    .split('\n')
-    .filter(
-      (line) =>
-        Boolean(line) &&
-        !line.startsWith('Checking formatting...') &&
-        !line.includes('Code style issues found'),
-    )
-    .map((line) => line.replace('[warn] ', ''));
-}
-
 /**
  * Format Prettier results for GitLab Code Quality Reports.
  * @param   {string} results
@@ -58,7 +42,8 @@ export async function prettierFormatterGitLab(results) {
   if (CI_JOB_NAME || PRETTIER_CODE_QUALITY_REPORT) {
     const files = parse(results);
 
-    const [data] = await Promise.all([gitlab(files), diff(files)]);
+    const [data, diffs] = await Promise.all([gitlab(files), diff(files)]);
+    diffs.forEach((diff) => console.log(diff));
     const outputPath = PRETTIER_CODE_QUALITY_REPORT || getOutputPath();
     const dir = dirname(outputPath);
     mkdirSync(dir, { recursive: true });

src/index.js

@@ -1,8 +1,9 @@
 export interface FileInfo {
    filename: string;
-   input: string;
-   output: string;
-   isFormatted: boolean;
+   input?: string;
+   output?: string;
+   isFormatted?: boolean;
+   error?: Error;
 }
 
 export interface CodeQualityReport {

src/types.d.ts

@@ -0,0 +1,67 @@
+import { readFileSync } from 'node:fs';
+import { relative, dirname } from 'node:path';
+import {
+  resolveConfig,
+  resolveConfigFile,
+  getFileInfo as prettierGetFileInfo,
+  check,
+  format,
+} from 'prettier';
+
+/**
+ * @typedef {import('../types.d.ts').FileInfo} FileInfo
+ */
+
+/**
+ * Get Prettier file informations.
+ * @param {string} filePath The absolute path to the file.
+ * @returns {Promise<FileInfo>} An object with Prettier informations.
+ */
+async function getFileInfos(filePath) {
+  const input = readFileSync(filePath, 'utf8').toString();
+  const [options, configPath] = await Promise.all([
+    resolveConfig(filePath),
+    resolveConfigFile(filePath),
+  ]);
+  const filename = relative(dirname(configPath), filePath);
+  const infos = await prettierGetFileInfo(filePath, options);
+
+  if (!options.parser) {
+    options.parser = infos.inferredParser;
+  }
+
+  try {
+    const [isFormatted, output] = await Promise.all([
+      check(input, options),
+      format(input, options),
+    ]);
+
+    return {
+      filename,
+      input,
+      output,
+      isFormatted,
+    };
+  } catch (error) {
+    return {
+      filename,
+      error,
+    };
+  }
+}
+
+const cache = new Map();
+
+/**
+ * Get Prettier information for a given file.
+ * @param   {string} filePath The absolute path to the file.
+ * @returns {Promise<FileInfo>}
+ */
+export async function getPrettierFileInfos(filePath) {
+  if (!cache.has(filePath)) {
+    const fileInfo = await getFileInfos(filePath);
+    cache.set(filePath, fileInfo);
+  }
+
+  return cache.get(filePath);
+}