Add basic examples

Author: lahmatiy

examples/commits.js

@@ -0,0 +1,40 @@
+import { createGitReader } from '@discoveryjs/scan-git';
+import { gitDir } from './get-git-dir.js';
+
+const repo = await createGitReader(gitDir);
+
+console.log('createGitReader:', repo.initTime, 'ms');
+
+async function collectCommits() {
+    const startTime = Date.now();
+    // read all commits reachable from HEAD
+    const commits = await repo.log({
+        ref: 'master',
+        depth: Infinity
+    });
+
+    console.log(commits.length, 'commits read');
+    console.log('time:', Date.now() - startTime, 'ms');
+    console.log('mem:', process.memoryUsage());
+
+    // prepare commits data for analysis
+    // const commitIdxByOid = commits.reduce((map, commit, idx) => map.set(commit.oid, idx), new Map());
+    // for (const commit of commits) {
+    //     for (let i = 0; i < commit.parent.length; i++) {
+    //         commit.parent[i] = commitIdxByOid.get(commit.parent[i]);
+    //     }
+    // }
+
+    // writeFileSync(
+    //     'commits.json',
+    //     JSON.stringify(commits, (key, value) =>
+    //         key === 'timezone' || key === 'tree'
+    //             ? undefined
+    //             : key === 'message' && value.includes('\n')
+    //             ? value.slice(0, value.indexOf('\n'))
+    //             : value
+    //     )
+    // );
+}
+
+collectCommits();

examples/get-git-dir.js

@@ -0,0 +1,3 @@
+import { resolve } from 'path';
+
+export const gitDir = resolve(process.argv[2] || '.git');

examples/list-files.js

@@ -0,0 +1,27 @@
+import { gitDir } from './get-git-dir.js';
+import { createGitReader } from '../lib/index.js';
+
+const repo = await createGitReader(gitDir);
+
+console.log('createGitReader:', repo.initTime, 'ms');
+
+async function example(oneMoreRun) {
+    const startTime = Date.now();
+    const files = await repo.listFiles();
+
+    console.log();
+    console.log(oneMoreRun ? '[COLD RUN]' : '[HOT RUN]');
+    console.log(
+        files.length,
+        'files in',
+        Date.now() - startTime,
+        'ms, mem:',
+        process.memoryUsage()
+    );
+
+    if (oneMoreRun) {
+        example();
+    }
+}
+
+example(true);

examples/stat.js

@@ -0,0 +1,21 @@
+import { createGitReader } from '../lib/index.js';
+import { gitDir } from './get-git-dir.js';
+
+const repo = await createGitReader(gitDir);
+
+console.log('createGitReader:', repo.initTime, 'ms');
+
+async function example() {
+    const startTime = Date.now();
+    const stats = await repo.stat();
+
+    console.log('Done in', Date.now() - startTime, 'ms');
+    console.log(process.memoryUsage());
+
+    console.log('loose objects:', stats.objects.loose.objects.count);
+    console.log('packed objects:', stats.objects.packed.objects.count);
+
+    // writeFileSync('./stat.json', JSON.stringify(stats), 'utf8');
+}
+
+example();