Improve file annotations for src/build

.github/workflows/test.yml

@@ -10,10 +10,15 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-    - name: Run plugin check
-      uses: ./
-      with:
-        build-dir: 'hello-dolly'
+      - name: Simulate a build step
+        run: |
+          mkdir build/
+          mv hello.php build/
+
+      - name: Run plugin check
+        uses: ./
+        with:
+          build-dir: 'build'

README.md

@@ -39,16 +39,10 @@ jobs:
 
 The following inputs are supported:
 
-* `build-dir` (string): path to the built plugin files if there is a build process involved.
-  **Note:**: file annotations may be incorrect and not working in this case. This is still an open todo.
+* `build-dir` (string): path to the build directory if there is a build process involved.
+  **Note:**: file annotations will still be made against the source files.
 * `checks` (string): only run specific checks, separated by comma.
 * `categories` (string): only run checks from specific categories, separated by comma.
 * `ignore-warnings` (bool): ignore warnings.
 * `ignore-errors` (bool): ignore errors.
 * `include-experimental` (bool): include experimental checks.
-
-
-## To-do
-
-* PR comments
-* Changing the path of the file annotations when there is a build step involved

action.yml

@@ -114,9 +114,8 @@ runs:
 
     - name: Process results
       run: |
-        cat ${{ runner.temp }}/plugin-check-results.txt
         RELATIVE_DIR=$(echo $PLUGIN_DIR | sed "s@$GITHUB_WORKSPACE@@g")
-        node dist/index.js ${{ runner.temp }}/plugin-check-results.txt $RELATIVE_DIR
+        node dist/index.js ${{ runner.temp }}/plugin-check-results.txt
       shell: bash
       env:
         INPUT_REPO_TOKEN: ${{ inputs.repo-token }}

dist/index.js

@@ -25886,12 +25886,12 @@ const core_1 = __nccwpck_require__(2186);
 const node_fs_1 = __nccwpck_require__(7561);
 const args = process.argv.slice(2);
 const file = args[0];
-const pluginDir = args[1] || '';
 if (!(0, node_fs_1.existsSync)(file)) {
-    (0, core_1.setFailed)('Results file does not exist');
-    process.exit(0);
+    (0, core_1.setFailed)('Results file does not exist.');
 }
-const fileContents = (0, node_fs_1.readFileSync)(file, { encoding: 'utf8' }).split('\n');
+const fileContents = (0, node_fs_1.existsSync)(file)
+    ? (0, node_fs_1.readFileSync)(file, { encoding: 'utf8' }).split('\n')
+    : [];
 for (let i = 0; i < fileContents.length - 1; i++) {
     const line = fileContents[i];
     if (!line.startsWith('FILE: ')) {
@@ -25900,10 +25900,13 @@ for (let i = 0; i < fileContents.length - 1; i++) {
     const fileName = line.split('FILE: ')[1];
     const results = JSON.parse(fileContents[++i]) || [];
     for (const result of results) {
+        if (result.type === 'ERROR') {
+            process.exitCode = 1;
+        }
         const func = result.type === 'ERROR' ? core_1.error : core_1.warning;
         func(result.message, {
             title: result.code,
-            file: `${pluginDir}/${fileName}`,
+            file: fileName,
             startLine: result.line,
             startColumn: result.column,
         });

src/main.ts

@@ -4,14 +4,14 @@ import { existsSync, readFileSync } from 'node:fs';
 const args = process.argv.slice(2);
 
 const file = args[0];
-const pluginDir = args[1] || '';
 
 if (!existsSync(file)) {
-	setFailed('Results file does not exist');
-	process.exit(0);
+	setFailed('Results file does not exist.');
 }
 
-const fileContents = readFileSync(file, { encoding: 'utf8' }).split('\n');
+const fileContents = existsSync(file)
+	? readFileSync(file, { encoding: 'utf8' }).split('\n')
+	: [];
 
 type Result = {
 	line: number;
@@ -31,10 +31,13 @@ for (let i = 0; i < fileContents.length - 1; i++) {
 	const results: Result[] = JSON.parse(fileContents[++i]) || [];
 
 	for (const result of results) {
+		if (result.type === 'ERROR') {
+			process.exitCode = 1;
+		}
 		const func = result.type === 'ERROR' ? error : warning;
 		func(result.message, {
 			title: result.code,
-			file: `${pluginDir}/${fileName}`,
+			file: fileName,
 			startLine: result.line,
 			startColumn: result.column,
 		});