support for custom source details

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

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.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk/analyze-tracking",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Analyzes tracking code in a project and generates data schemas",
   "main": "src/index.js",
   "bin": {

src/index.js

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

src/repoDetails.js

@@ -57,7 +57,7 @@ function toISODateString(date) {
     + pad(date.getUTCSeconds())+'Z';
 }
 
-async function getRepoDetails(targetDir) {
+async function getRepoDetails(targetDir, customSourceDetails) {
   const repoUrl = await getRepositoryUrl(targetDir);
   const commitHash = await getCommitHash(targetDir);
   const commitEpochTime = await getCommitTimestamp(targetDir, commitHash);
@@ -67,6 +67,11 @@ async function getRepoDetails(targetDir) {
   if (!!repoUrl) repoDetails.repository = repoUrl;
   if (!!commitHash) repoDetails.commit = commitHash;
   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;
 }