feat(results): include repository owner in results filenames

- Adds support for duplicate repository names, e.g. when linting forks
AriPerkkio · Nov 4, 2020 · 21e45a3 · 21e45a3
1 parent e633d62
commit 21e45a3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/lib/file-client/results-writer.ts b/lib/file-client/results-writer.ts
@@ -71,13 +71,17 @@ export function writeResults(results: LintMessage[], repository: string): void {
     if (!results.length) {
         return;
     }
-    const [, repositoryName] = repository.split('/');
+
+    // Construct result file name, e.g. mui-org_material-ui.md
+    const repositoryOwnerAndName = repository.split('/').join('_');
+    const fileName = `${repositoryOwnerAndName}${RESULT_EXTENSION}`;
+
     const formattedResults = formatResults(results, repository);
     RESULTS.push(formattedResults);
 
     if (!config.CI) {
         fs.writeFileSync(
-            `${RESULTS_LOCATION}/${repositoryName}${RESULT_EXTENSION}`,
+            `${RESULTS_LOCATION}/${fileName}`,
             formattedResults,
             'utf8'
         );

diff --git a/test/integration/integration.cli.test.ts b/test/integration/integration.cli.test.ts
@@ -8,6 +8,8 @@ import {
 } from '../utils';
 import { RESULTS_LOCATION, CACHE_LOCATION } from '@file-client';
 
+const RESULTS_FILE = `${INTEGRATION_REPO_OWNER}_${INTEGRATION_REPO_NAME}.md`;
+
 describe('CLI', () => {
     beforeEach(async () => {
         await runProductionBuild();
@@ -17,12 +19,12 @@ describe('CLI', () => {
         const files = fs.readdirSync(RESULTS_LOCATION);
 
         expect(files).toHaveLength(1);
-        expect(files[0]).toMatch(`${INTEGRATION_REPO_NAME}.md`);
+        expect(files[0]).toMatch(RESULTS_FILE);
     });
 
     test("validates repository's files", () => {
         const results = fs.readFileSync(
-            `${RESULTS_LOCATION}/${INTEGRATION_REPO_NAME}.md`,
+            `${RESULTS_LOCATION}/${RESULTS_FILE}`,
             'utf8'
         );
 
@@ -92,7 +94,7 @@ describe('CLI', () => {
 
     test('excludes files matching exclude pattern', () => {
         const results = fs.readFileSync(
-            `${RESULTS_LOCATION}/${INTEGRATION_REPO_NAME}.md`,
+            `${RESULTS_LOCATION}/${RESULTS_FILE}`,
             'utf8'
         );