Update documentation for importing best-practice.

Author: steveukx

.changeset/skipping-gold-skips.md

@@ -0,0 +1,10 @@
+---
+"@simple-git/test-es-module-consumer": patch
+"@simple-git/teset-javascript-consumer": patch
+"@simple-git/test-typescript-consumer": patch
+"@simple-git/test-typescript-esm-consumer": patch
+"simple-git": minor
+---
+
+Support for importing as an ES module with TypeScript moduleResolution `node16` or newer by adding
+`simpleGit` as a named export.

docs/DEBUG-LOGGING-GUIDE.md

@@ -21,7 +21,7 @@ simpleGit().init().then(() => console.log('DONE'));
 
 ```typescript
 import debug from 'debug';
-import simpleGit from 'simple-git';
+import { simpleGit } from 'simple-git';
 
 debug.enable('simple-git,simple-git:*');
 simpleGit().init().then(() => console.log('DONE'));

docs/LEGACY_NODE_VERSIONS.md

@@ -2,6 +2,7 @@
 # Legacy Node Versions
 
 From `v3.x`, `simple-git` will drop support for `node.js` version 10 or below.
+From `v3.8`, `simple-git` will no longer be tested against node version 12 or below.
 
 To use in lower versions of node, ensure you are also including the necessary polyfills from `core-js`:
 

docs/PLUGIN-COMPLETION-DETECTION.md

@@ -12,7 +12,7 @@ From version `2.46.0` onwards, you can configure this behaviour by using the
 `completion` plugin:
 
 ```typescript
-import simpleGit, { SimpleGit } from 'simple-git';
+import { simpleGit, SimpleGit } from 'simple-git';
 
 const git: SimpleGit = simpleGit({
    completion: {

docs/PLUGIN-ERRORS.md

@@ -13,7 +13,7 @@ detection plugin is the original error. Either return that error directly to all
 task's error handlers, or implement your own error detection as below:
 
 ```typescript
-import simpleGit from 'simple-git';
+import { simpleGit } from 'simple-git';
 
 const git = simpleGit({
    errors(error, result) {

docs/PLUGIN-PROGRESS-EVENTS.md

@@ -3,7 +3,7 @@
 To receive progress updates, pass a `progress` configuration option to the `simpleGit` instance:
 
 ```typescript
-import simpleGit, { SimpleGit, SimpleGitProgressEvent } from 'simple-git';
+import { simpleGit, SimpleGit, SimpleGitProgressEvent } from 'simple-git';
 
 const progress = ({method, stage, progress}: SimpleGitProgressEvent) => {
    console.log(`git.${method} ${stage} stage ${progress}% complete`);

docs/PLUGIN-TIMEOUT.md

@@ -5,7 +5,7 @@ To handle the case where the underlying `git` processes appear to hang, configur
 `stdOut` or `stdErr` streams before sending a `SIGINT` kill message.
 
 ```typescript
-import simpleGit, { GitPluginError, SimpleGit, SimpleGitProgressEvent } from 'simple-git';
+import { simpleGit, GitPluginError, SimpleGit, SimpleGitProgressEvent } from 'simple-git';
 
 const git: SimpleGit = simpleGit({
    baseDir: '/some/path', 

examples/git-change-working-directory.md

@@ -5,7 +5,7 @@ when it is created by using the `baseDir` property:
 
 ```typescript
 import { join } from 'path';
-import simpleGit from 'simple-git';
+import { simpleGit } from 'simple-git';
 
 const git = simpleGit({ baseDir: join(__dirname, 'repos') });
 ```
@@ -14,7 +14,7 @@ Or explicitly set the working directory at some later time, for example after cl
 
 ```typescript
 import { join } from 'path';
-import simpleGit, { SimpleGit } from 'simple-git';
+import { simpleGit, SimpleGit } from 'simple-git';
 
 const remote = `https://github.com/steveukx/git-js.git`;
 const target = join(__dirname, 'repos', 'git-js');
@@ -29,7 +29,7 @@ are treated as an atomic operation. To rewrite this using separate `async/await`
 
 ```typescript
 import { join } from 'path';
-import simpleGit, { SimpleGit } from 'simple-git';
+import { simpleGit, SimpleGit } from 'simple-git';
 
 const remote = `https://github.com/steveukx/git-js.git`;
 const target = join(__dirname, 'repos', 'git-js');

simple-git/readme.md

@@ -30,22 +30,22 @@ const simpleGit = require('simple-git');
 simpleGit().clean(simpleGit.CleanOptions.FORCE);
 
 // or use named properties
-const {default: simpleGit, CleanOptions} = require('simple-git');
+const {simpleGit, CleanOptions} = require('simple-git');
 simpleGit().clean(CleanOptions.FORCE);
 ```
 
 Include into your JavaScript app as an ES Module:
 
 ```javascript
-import simpleGit, { CleanOptions } from 'simple-git';
+import { simpleGit, CleanOptions } from 'simple-git';
 
 simpleGit().clean(CleanOptions.FORCE);
 ```
 
 Include in a TypeScript app using the bundled type definitions:
 
 ```typescript
-import simpleGit, { SimpleGit, CleanOptions } from 'simple-git';
+import { simpleGit, SimpleGit, CleanOptions } from 'simple-git';
 
 const git: SimpleGit = simpleGit().clean(CleanOptions.FORCE);
 ```
@@ -55,7 +55,7 @@ const git: SimpleGit = simpleGit().clean(CleanOptions.FORCE);
 Configure each `simple-git` instance with a properties object passed to the main `simpleGit` function:
 
 ```typescript
-import simpleGit, { SimpleGit, SimpleGitOptions } from 'simple-git';
+import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';
 
 const options: Partial<SimpleGitOptions> = {
    baseDir: process.cwd(),
@@ -580,7 +580,7 @@ if (mergeSummary.failed) {
 With typed errors available in TypeScript
 
 ```typescript
-import simpleGit, { MergeSummary, GitResponseError } from 'simple-git';
+import { simpleGit, MergeSummary, GitResponseError } from 'simple-git';
 try {
   const mergeSummary = await simpleGit().merge();
   console.log(`Merged ${ mergeSummary.merges.length } files`);