locmeter 0.1.1 → 0.1.2

package/README.md

@@ -44,6 +44,7 @@ Common options:
 - default `--to`: today
 - default `--from`: one year before `--to`
 - default author identity: auto-detected from your current `gh` login
+- default repo root: current directory, then common roots like `~/Developer`, `~/Code`, `~/Projects`
 - `--from YYYY-MM-DD`
 - `--to YYYY-MM-DD`
 - `--days N`

package/bin/locmeter.js

@@ -101,10 +101,13 @@ const MONTHS = {
   12: "DEC"
 };
 
+function logStep(message) {
+  process.stderr.write(`${message}\n`);
+}
+
 function parseArgs(argv) {
   const args = {
     bucket: "week",
-    root: process.cwd(),
     authorEmail: [],
     authorName: [],
     output: "github-lines-changed.png",
@@ -227,6 +230,14 @@ async function runText(command, args, cwd) {
   return stdout;
 }
 
+async function tryRunText(command, args, cwd) {
+  try {
+    return await runText(command, args, cwd);
+  } catch (error) {
+    return "";
+  }
+}
+
 async function getLogin() {
   const user = await runJson("gh", ["api", "user"]);
   return user.login;
@@ -266,6 +277,32 @@ function resolveRepoPaths(repoNames, root) {
   return { resolved, missing };
 }
 
+function candidateRoots(explicitRoot) {
+  if (explicitRoot) return [path.resolve(explicitRoot)];
+  const home = os.homedir();
+  const values = [
+    process.cwd(),
+    path.join(home, "Developer"),
+    path.join(home, "Code"),
+    path.join(home, "Projects"),
+    home
+  ];
+  return [...new Set(values.map((value) => path.resolve(value)))];
+}
+
+function resolveRepoPathsFromCandidates(repoNames, explicitRoot) {
+  const candidates = candidateRoots(explicitRoot);
+  let best = { resolved: [], missing: repoNames, root: candidates[0] };
+  for (const root of candidates) {
+    const result = resolveRepoPaths(repoNames, root);
+    if (result.resolved.length > best.resolved.length) {
+      best = { ...result, root };
+    }
+    if (result.resolved.length === repoNames.length) return { ...result, root };
+  }
+  return best;
+}
+
 async function autodetectAuthorIdentities(repoPaths, login) {
   const pairs = new Map();
   const loginLower = login.toLowerCase();
@@ -297,6 +334,15 @@ async function autodetectAuthorIdentities(repoPaths, login) {
   return { emails, names };
 }
 
+async function gitConfigIdentity() {
+  const email = (await tryRunText("git", ["config", "--global", "user.email"])).trim();
+  const name = (await tryRunText("git", ["config", "--global", "user.name"])).trim();
+  return {
+    emails: email ? [email] : [],
+    names: name ? [name] : []
+  };
+}
+
 function escapeRegex(value) {
   return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
@@ -650,27 +696,43 @@ function renderChart(series, login, startDate, endDate, bucket, outputPath) {
 async function main() {
   const args = parseArgs(process.argv.slice(2));
   const { startDate, endDate } = computeDates(args);
-  const root = path.resolve(args.root);
   const output = path.resolve(args.output);
   const jsonOutput = path.resolve(args.jsonOutput);
 
+  logStep("Resolving GitHub identity...");
   const login = await getLogin();
+  logStep(`Fetching contributed repositories for ${login}...`);
   const repoNames = await getRepositories(login);
-  const { resolved: repoPaths, missing } = resolveRepoPaths(repoNames, root);
+  const { resolved: repoPaths, missing, root } = resolveRepoPathsFromCandidates(repoNames, args.root);
+
+  if (!repoPaths.length) {
+    throw new Error(
+      `could not find any locally cloned contributed repos under ${root}; pass --root to the directory that contains your repo clones`
+    );
+  }
 
   let authorEmails = [...new Set(args.authorEmail)];
   let authorNames = [...new Set(args.authorName)];
 
   if (!authorEmails.length && !authorNames.length) {
+    logStep(`Detecting author identity from ${repoPaths.length} local repos under ${root}...`);
     const detected = await autodetectAuthorIdentities(repoPaths, login);
     authorEmails = detected.emails;
     authorNames = detected.names;
   }
 
+  if (!authorEmails.length && !authorNames.length) {
+    logStep("Falling back to global git identity...");
+    const detected = await gitConfigIdentity();
+    authorEmails = detected.emails;
+    authorNames = [...new Set([login, ...detected.names])];
+  }
+
   if (!authorEmails.length && !authorNames.length) {
     throw new Error("could not auto-detect your author identity; pass --author-email or --author-name");
   }
 
+  logStep(`Fetching commits from ${repoPaths.length} repos...`);
   const { series, rawDaily } = await aggregate(
     repoPaths,
     startDate,
@@ -680,6 +742,7 @@ async function main() {
     authorNames
   );
 
+  logStep(`Crunching numbers for ${args.bucket} buckets from ${dateIso(startDate)} to ${dateIso(endDate)}...`);
   renderChart(series, login, startDate, endDate, args.bucket, output);
 
   const values = Object.values(series);
@@ -693,6 +756,7 @@ async function main() {
         bucket: args.bucket,
         author_emails: authorEmails,
         author_names: authorNames,
+        root_used: root,
         local_repositories_used: repoPaths.map(([name]) => name),
         missing_repositories: missing,
         total_lines_changed: values.reduce((sum, value) => sum + value, 0),
@@ -705,6 +769,9 @@ async function main() {
     )
   );
 
+  logStep("Created output files:");
+  logStep(`  PNG: ${output}`);
+  logStep(`  JSON: ${jsonOutput}`);
   process.stdout.write(`${output}\n${jsonOutput}\n`);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locmeter",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Render a PNG chart of lines changed over time from your GitHub contribution repos.",
   "license": "MIT",
   "preferGlobal": true,