Using DangerJS to check changes coupling of implementation files to test or documentation files

Author: KevinEyo1

.github/workflows/check-file-diff.yml

@@ -0,0 +1,23 @@
+name: "Check File Differences"
+on:
+    pull_request:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+jobs:
+  check-couplings:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - run: npm run setup
+      - name: Run Danger
+        run: npx danger ci
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

dangerfile.ts

@@ -0,0 +1,37 @@
+import { danger } from 'danger';
+import * as logger from '@markbind/core/src/utils/logger';
+
+interface Couplings {
+  [key: string]: string[];
+}
+
+const couplings: Couplings = {
+  'packages/core/src/html/CustomListIconProcessor.ts': [
+    'docs/userGuide/syntax/lists.md',
+    'packages/cli/test/functional/test_site/testList.md',
+  ],
+  'package.json': ['package-lock.json'],
+};
+
+const { git } = danger;
+
+Promise.resolve().then(() => {
+  const allModifiedFiles = [...git.modified_files, ...git.created_files];
+  const messages: string[] = [];
+
+  Object.entries(couplings).forEach(([implementationFile, dependentFiles]) => {
+    dependentFiles.forEach((dependentFile) => {
+      if (allModifiedFiles.includes(implementationFile) && !allModifiedFiles.includes(dependentFile)) {
+        messages.push(`Changes to ${implementationFile} should include changes to ${dependentFile}`);
+      }
+    });
+  });
+
+  if (messages.length > 0) {
+    logger.warn(`Detected issues with file couplings:\n${messages.join('\n')}`);
+    logger.warn('Please ensure implementation changes are accompanied '
+     + 'by corresponding test or documentation updates.');
+  } else {
+    logger.info('All file couplings are correctly updated.');
+  }
+}).catch((err: Error) => logger.error(err));