Fix CLI where files are being synced from the project document instead of from the filesystem

CLI sync should not create files as this is the role of the versionning
system (git). This allow a project to contain file from 2 different
repos (like a webapp and a API CMS).

This is a fix from a recent addition that was also consider a fix. The
fix was wrong so the document-paths-fetcher.ts file is patched.

The stats command also reflect which document from Accent’s project is
found in the filesystem.

Author: simonprev

cli/src/commands/stats.ts

@@ -10,6 +10,7 @@ import {CLIError} from '@oclif/errors';
 import Formatter from '../services/formatters/project-stats';
 import ProjectFetcher from '../services/project-fetcher';
 import {Revision} from '../types/project';
+import DocumentPathsFetcher from '../services/document-paths-fetcher';
 
 export default class Stats extends Command {
   static description = 'Fetch stats from the API and display them beautifully';
@@ -44,9 +45,15 @@ export default class Stats extends Command {
       this.project = response.project;
     }
 
+    const documents = this.projectConfig.files();
+    const targets = documents.flatMap((document) => {
+      return new DocumentPathsFetcher().fetch(this.project!, document);
+    });
+
     const formatter = new Formatter(
       this.project!,
       this.projectConfig.config,
+      targets,
       flags.version
     );
 

cli/src/commands/sync.ts

@@ -149,6 +149,7 @@ export default class Sync extends Command {
         formatter.logSync(path, documentPath);
       }
     }
+    console.log('');
   }
 
   private async addTranslationsDocumentConfig(document: Document) {
@@ -191,5 +192,6 @@ export default class Sync extends Command {
         );
       }
     }
+    console.log('');
   }
 }

cli/src/services/document-paths-fetcher.ts

@@ -8,7 +8,7 @@ export default class DocumentPathsFetcher {
   fetch(project: Project, document: Document): DocumentPath[] {
     const languageSlugs = fetchFromRevisions(project.revisions);
     const documentPaths: Set<string> = new Set();
-    project.documents.entries.forEach(({path}) => documentPaths.add(path));
+
     document.paths.forEach((documentPath) => {
       const name = document.parseDocumentName(documentPath, document.config);
       documentPaths.add(name);

cli/src/services/formatters/commit-operation.ts

@@ -15,7 +15,6 @@ export default class CommitOperationFormatter {
       chalk.bold.white(path),
       chalk.gray.dim(documentPath)
     );
-    console.log('');
   }
 
   logAddTranslations(path: string, documentPath: string) {
@@ -25,7 +24,6 @@ export default class CommitOperationFormatter {
       chalk.bold.white(path),
       chalk.gray.dim(documentPath)
     );
-    console.log('');
   }
 
   logEmptyExistingTarget(path: string) {

cli/src/services/formatters/project-stats.ts

@@ -18,16 +18,29 @@ import {
 } from '../revision-slug-fetcher';
 import Base from './base';
 
+interface DocumentTarget {
+  documentPath: string;
+  path: string;
+  language: string;
+}
+
 export default class ProjectStatsFormatter extends Base {
   private readonly project: Project;
   private readonly config: Config;
+  private readonly targets: DocumentTarget[];
   private readonly version: string | undefined;
 
-  constructor(project: Project, config: Config, version?: string) {
+  constructor(
+    project: Project,
+    config: Config,
+    targets: DocumentTarget[],
+    version?: string
+  ) {
     super();
     this.project = project;
     this.config = config;
     this.version = version;
+    this.targets = targets;
   }
 
   percentageReviewedString(number: number, translationsCount: number) {
@@ -142,11 +155,39 @@ export default class ProjectStatsFormatter extends Base {
           `(${this.project.documents.meta.totalEntries})`
         )
       );
-      this.project.documents.entries.forEach((document: Document) => {
-        console.log(chalk.gray('Format:'), chalk.white.bold(document.format));
-        console.log(chalk.gray('Path:'), chalk.white.bold(document.path));
-        console.log('');
-      });
+      this.project.documents.entries
+        .sort((a, b) => {
+          const existingTargetA = this.targets.find(
+            (target) => a.path === target.documentPath
+          );
+          const existingTargetB = this.targets.find(
+            (target) => b.path === target.documentPath
+          );
+
+          if (existingTargetA) return -1;
+          if (existingTargetB) return 1;
+          return 0;
+        })
+        .forEach((document: Document) => {
+          const existingTarget = this.targets.find(
+            (target) => document.path === target.documentPath
+          );
+
+          if (existingTarget) {
+            console.log(
+              chalk.white(document.path),
+              chalk.whiteBright.underline(existingTarget.path)
+            );
+          } else {
+            console.log(
+              chalk.gray.dim(document.path),
+              chalk.gray.dim('-'),
+              chalk.gray.dim(document.format),
+              chalk.gray.dim('(No matches in config file)')
+            );
+          }
+        });
+      console.log('');
     }
 
     if (this.project.versions.meta.totalEntries !== 0) {
@@ -196,7 +237,7 @@ export default class ProjectStatsFormatter extends Base {
 
     console.log(
       chalk.magenta('Project URL:'),
-      chalk.gray.dim(`${this.config.apiUrl}/app/projects/${this.project.id}`)
+      chalk.gray(`${this.config.apiUrl}/app/projects/${this.project.id}`)
     );
     console.log('');
   }