fix: Documentation update

- Absolute URLs for links in `.md` files
- Update import syntax, add test for named import style commons js

Author: steveukx

examples/git-grep.md

@@ -1,6 +1,6 @@
 ## Git Grep
 
-The official documentation for [git grep](https://git-scm.com/docs/git-grep) gives the full set of options that can be passed to the `simple-git` `git.grep` method as [options](../readme.md#how-to-specify-options) (note that `-h` to hide the file name is disallowed).
+The official documentation for [git grep](https://git-scm.com/docs/git-grep) gives the full set of options that can be passed to the `simple-git` `git.grep` method as [options](https://github.com/steveukx/git-js/blob/main/readme.md#how-to-specify-options) (note that `-h` to hide the file name is disallowed).
 
 The simplest version is to search with a single search token:
 
@@ -28,7 +28,7 @@ console.log(Array.from(grepQueryBuilder('aaa').and('bbb', 'ccc')))
     // [ '-e', 'aaa', '--and', '(', '-e', 'bbb', '-e', 'ccc', ')' ]
 ```
 
-To build your own query instead of using the `grepQueryBuilder`, use the array form of [options](../readme.md#how-to-specify-options):
+To build your own query instead of using the `grepQueryBuilder`, use the array form of [options](https://github.com/steveukx/git-js/blob/main/readme.md#how-to-specify-options):
 
 ```typescript
 import simpleGit from 'simple-git';

packages/test-es-module-consumer/package.json

@@ -7,6 +7,6 @@
     "test": "node test.mjs"
   },
   "dependencies": {
-    "simple-git": "^2.48.0"
+    "simple-git": "^3.0.0"
   }
 }

packages/test-javascript-consumer/package.json

@@ -3,9 +3,9 @@
   "private": true,
   "version": "1.0.0",
   "scripts": {
-    "test": "node test.js"
+    "test": "node test.js && node test-default.js"
   },
   "dependencies": {
-    "simple-git": "^2.48.0"
+    "simple-git": "^3.0.0"
   }
 }

packages/test-javascript-consumer/test-default.js

@@ -0,0 +1,27 @@
+const {default: simpleGit, ResetMode} = require('simple-git');
+const {strictEqual} = require("assert");
+
+exec('requires default', async () => {
+   strictEqual(
+      await simpleGit().checkIsRepo(),
+      true,
+      'expected the current directory to be a valid git root',
+   );
+});
+
+exec('imports named exports', async () => {
+   strictEqual(
+      /hard/.test(ResetMode.HARD),
+      true,
+      'expected valid ResetMode enum'
+   );
+});
+
+function exec (name, runner) {
+   runner()
+      .then(() => console.log(`${ name }: OK`))
+      .catch((e) => {
+         console.error(`${ name }: ${ e.message }`);
+         throw e;
+      });
+}

packages/test-typescript-consumer/package.json

@@ -17,6 +17,6 @@
   },
   "dependencies": {
     "@simple-git/babel-config": "^1.0.0",
-    "simple-git": "^2.48.0"
+    "simple-git": "^3.0.0"
   }
 }

readme.md

@@ -280,7 +280,7 @@
 
 ## 2.25.0 TypeScript Types & Unit Tests, Commit Parsing
 
-- See [Legacy Node Versions](./docs/LEGACY_NODE_VERSIONS.md) for details of how to use `simple-git` with `node.js`
+- See [Legacy Node Versions](https://github.com/steveukx/git-js/blob/main/docs/LEGACY_NODE_VERSIONS.md) for details of how to use `simple-git` with `node.js`
   versions 11 and below.  
 - To help keep the TypeScript definitions in line with functionality, unit tests are now written in TypeScript.
 - When using `git.commit`, the first argument must be a string or array of strings. Passing another data type has long
@@ -356,7 +356,7 @@
 ## 2.13.0 - Upgraded Pull & Merge and parser for Push  
 
 - `.push` and `.pushTags` rewritten as v2 style tasks. The git response is now parsed and returned as a
-  [PushResult](./typings/response.d.ts)
+  [PushResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts)
 
 - Pull and merge rewritten to fit the TypeScript tasks style. 
 
@@ -371,12 +371,12 @@
 - until now, `simple-git` reject all pending tasks in the queue when a task has failed. From `2.11.0`, only
   tasks chained from the failing one will be rejected, other tasks can continue to be processed as normal,
   giving the developer more control over which tasks should be treated as atomic chains, and which can be
-  [run in parallel](./readme.md#concurrent--parallel-requests).
+  [run in parallel](https://github.com/steveukx/git-js/blob/main/readme.md#concurrent--parallel-requests).
 
   To support this, and to prevent the issues seen when `git` is run concurrently in too many child processes,
   `simple-git` will limit the number of tasks running in parallel at any one time to be at most 1 from each
   chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains (
-  [configurable](./readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor). 
+  [configurable](https://github.com/steveukx/git-js/blob/main/readme.md#configuration) by passing `{maxConcurrentProcesses: x}` in the `simpleGit` constructor). 
 
 - add support to `git.status()` for parsing the response of a repo that has no commits yet, previously
   it wouldn't determine the branch name correctly.
@@ -395,7 +395,7 @@ await simpleGit().checkout({'branch-name': null});
 ```
 
 - `git.init` now supports both object and array forms of supplying trailing options and now
-  parses the response to return an [InitResult](./typings/response.d.ts);
+  parses the response to return an [InitResult](https://github.com/steveukx/git-js/blob/main/simple-git/typings/response.d.ts);
 
 ```typescript
 import simpleGit, { InitResult } from 'simple-git';
@@ -476,21 +476,21 @@ expect(simpleGit().init().then).toBe(expect.any(Function));
 - The main export from `simple-git` no longer shows the deprecation notice for using the
   `.then` function, it now exposes the promise chain generated from the most recently run
   task, allowing the combination of chain building and ad-hoc splitting off to a new promise chain.
-  - See the [unit](./test/unit/promises.spec.js) and [integration](./test/integration/promise-from-root.spec.js) tests.
-  - See the [typescript consumer](./test/consumer/ts-default-from-root.spec.ts) test.
+  - See the [unit](https://github.com/steveukx/git-js/blob/main/simple-git/test/unit/promises.spec.js) and [integration](https://github.com/steveukx/git-js/blob/main/simple-git/test/integration/promise-from-root.spec.js) tests.
+  - See the [typescript consumer](https://github.com/steveukx/git-js/blob/main/simple-git/test/consumer/ts-default-from-root.spec.ts) test.
 
 ### TypeScript Importing
 
 - Promise / async interface and TypeScript types all available from the `simple-git` import rather than needing
-  `simple-git/promise`, see examples in the [ReadMe](./readme.md) or in the [consumer tests](./test/consumer).
+  `simple-git/promise`, see examples in the [ReadMe](https://github.com/steveukx/git-js/blob/main/readme.md) or in the [consumer tests](https://github.com/steveukx/git-js/blob/main/simple-git/test/consumer).
 
 ### Typed Errors
 
 - Tasks that previously validated their usage and rejected with a `TypeError` will now reject with a
- [`TaskConfigurationError`](./src/lib/errors/task-configuration-error.ts).
+ [`TaskConfigurationError`](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/errors/task-configuration-error.ts).
 
 - Tasks that previously rejected with a custom object (currently only `git.merge` when the auto-merge fails)
-  will now reject with a [`GitResponseError`](./src/lib/errors/git-response-error.ts) where previously it
+  will now reject with a [`GitResponseError`](https://github.com/steveukx/git-js/blob/main/simple-git/src/lib/errors/git-response-error.ts) where previously it
   was a modified `Error`.
 
 ### Git Clean
@@ -537,4 +537,4 @@ please only use the documented public API.
 
 ## v1 and below
 
-Please see the [historical changelog](./docs/CHANGELOG-HISTORICAL.md);
+Please see the [historical changelog](https://github.com/steveukx/git-js/blob/main/docs/CHANGELOG-HISTORICAL.md);