@flisk/analyze-tracking 0.2.4 → 0.2.6

package/README.md

@@ -12,7 +12,10 @@ npx @flisk/analyze-tracking /path/to/project [options]
 
 Optional arguments:
 - `-o, --output <output_file>`: Name of the output file (default: `tracking-schema.yaml`)
-- `-c, --customFunction <output_file>`: Name of your custom tracking function
+- `-c, --customFunction <function_name>`: Name of your custom tracking function
+- `-u, --repositoryUrl <git_url>`: URL to your repository
+- `-h, --commitHash <commit_sha>`: Latest commit hash
+- `-t, --commitTimestamp <iso_timestamp>`: Timestamp of latest commit
 
 Note: Custom Functions only support the following format:
 ```js

package/bin/cli.js

@@ -22,13 +22,41 @@ const optionDefinitions = [
     alias: 'c',
     type: String,
   },
+  {
+    name: 'repositoryUrl',
+    alias: 'u',
+    type: String,
+  },
+  {
+    name: 'commitHash',
+    alias: 'h',
+    type: String,
+  },
+  {
+    name: 'commitTimestamp',
+    alias: 't',
+    type: String,
+  },
 ]
 const options = commandLineArgs(optionDefinitions);
-const { targetDir, output, customFunction } = options;
+const {
+  targetDir,
+  output,
+  customFunction,
+  repositoryUrl,
+  commitHash,
+  commitTimestamp,
+} = options;
+
+const customSourceDetails = {
+  repositoryUrl,
+  commitHash,
+  commitTimestamp,
+};
 
 if (!targetDir) {
   console.error('Please provide the path to the repository.');
   process.exit(1);
 }
 
-run(path.resolve(targetDir), output, customFunction);
+run(path.resolve(targetDir), output, customFunction, customSourceDetails);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk/analyze-tracking",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Analyzes tracking code in a project and generates data schemas",
   "main": "src/index.js",
   "bin": {
@@ -26,6 +26,7 @@
     "acorn-jsx-walk": "^2.0.0",
     "acorn-walk": "^8.3.3",
     "command-line-args": "^6.0.0",
+    "isomorphic-git": "^1.27.1",
     "js-yaml": "^4.1.0",
     "typescript": "^5.5.4"
   },

package/src/index.js

@@ -2,9 +2,9 @@ const { analyzeDirectory } = require('./analyze');
 const { getRepoDetails } = require('./repoDetails');
 const { generateYamlSchema } = require('./yamlGenerator');
 
-function run(targetDir, outputPath, customFunction) {
+async function run(targetDir, outputPath, customFunction, customSourceDetails) {
   const events = analyzeDirectory(targetDir, customFunction);
-  const repoDetails = getRepoDetails(targetDir);
+  const repoDetails = await getRepoDetails(targetDir, customSourceDetails);
   generateYamlSchema(events, repoDetails, outputPath);
 }
 

package/src/repoDetails.js

@@ -1,8 +1,13 @@
-const { execSync } = require('child_process');
+const fs = require('fs');
+const git = require('isomorphic-git');
 
-function getRepositoryUrl(targetDir) {
+async function getRepositoryUrl(targetDir) {
   try {
-    const repoUrl = execSync('git config --get remote.origin.url', { cwd: targetDir, encoding: 'utf8' });
+    const repoUrl = await git.getConfig({
+      fs,
+      dir: targetDir,
+      path: 'remote.origin.url',
+    });
     return repoUrl.trim();
   } catch (error) {
     console.warn('Could not determine repository URL. Will exclude.');
@@ -10,9 +15,13 @@ function getRepositoryUrl(targetDir) {
   }
 }
 
-function getCommitHash(targetDir) {
+async function getCommitHash(targetDir) {
   try {
-    const commitHash = execSync('git rev-parse HEAD', { cwd: targetDir, encoding: 'utf8' });
+    const commitHash = await git.resolveRef({
+      fs,
+      dir: targetDir,
+      ref: 'HEAD',
+    });
     return commitHash.trim();
   } catch (error) {
     console.warn('Could not determine latest commit hash. Will exclude.');
@@ -20,13 +29,17 @@ function getCommitHash(targetDir) {
   }
 }
 
-function getCommitTimestamp(targetDir, commitHash) {
+async function getCommitTimestamp(targetDir, commitHash) {
   try {
-    const commitTimestamp = execSync(`git --no-pager show -s --format=%ct ${commitHash}`, { cwd: targetDir, encoding: 'utf8' });
-    const unixTimeSeconds = commitTimestamp.trim();
+    const { commit } = await git.readCommit({
+      fs,
+      dir: targetDir,
+      oid: commitHash,
+    });
+    const unixTimeSeconds = commit.committer.timestamp;
     return new Date(unixTimeSeconds * 1000);
   } catch (error) {
-    console.warn('Could not retrieve commit timestamp. Using current timestamp as default.')
+    console.warn('Could not retrieve commit timestamp. Using current timestamp as default.');
     return new Date();
   }
 }
@@ -41,19 +54,23 @@ function toISODateString(date) {
     + pad(date.getUTCDate())+'T'
     + pad(date.getUTCHours())+':'
     + pad(date.getUTCMinutes())+':'
-    + pad(date.getUTCSeconds())+'Z'
+    + pad(date.getUTCSeconds())+'Z';
 }
 
-function getRepoDetails(targetDir) {
-  const repoUrl = getRepositoryUrl(targetDir);
-  const commitHash = getCommitHash(targetDir);
-  const commitEpochTime = getCommitTimestamp(targetDir, commitHash);
+async function getRepoDetails(targetDir, customSourceDetails) {
+  const repoUrl = await getRepositoryUrl(targetDir);
+  const commitHash = await getCommitHash(targetDir);
+  const commitEpochTime = await getCommitTimestamp(targetDir, commitHash);
   const commitTimestamp = toISODateString(commitEpochTime);
 
   const repoDetails = {};
   if (!!repoUrl) repoDetails.repository = repoUrl;
   if (!!commitHash) repoDetails.commit = commitHash;
-  repoDetails.timestamp = commitTimestamp
+  repoDetails.timestamp = commitTimestamp;
+
+  if (!!customSourceDetails?.repositoryUrl) repoDetails.repository = customSourceDetails.repositoryUrl;
+  if (!!customSourceDetails?.commitHash) repoDetails.commit = customSourceDetails.commitHash;
+  if (!!customSourceDetails?.commitTimestamp) repoDetails.timestamp = customSourceDetails.commitTimestamp;
 
   return repoDetails;
 }