From 6aae19ea5543fc93b5bf27f8215f157728acb795 Mon Sep 17 00:00:00 2001
From: Sam Magura <srmagura@gmail.com>
Date: Wed, 29 Sep 2021 00:48:41 -0400
Subject: [PATCH 1/4] 1556: move examples/basic to
 src/test/renderer/testProject

---
 .gitignore                                          |   3 ++-
 internal-docs/visual-regression-tests.md            |   5 +++++
 src/test/capture-screenshots.ts                     |   4 ++--
 .../test/renderer/testProject}/.gitignore           |   0
 .../test/renderer/testProject}/README.md            |   0
 .../test/renderer/testProject}/inc/class-example.md |   0
 .../test/renderer/testProject}/media/logo-128.png   | Bin
 .../basic => src/test/renderer/testProject}/run     |   0
 .../basic => src/test/renderer/testProject}/run.bat |   0
 .../test/renderer/testProject}/src/access.ts        |   0
 .../test/renderer/testProject}/src/classes.ts       |   0
 .../renderer/testProject}/src/default-export.ts     |   0
 .../test/renderer/testProject}/src/enumerations.ts  |   0
 .../test/renderer/testProject}/src/flattened.ts     |   0
 .../test/renderer/testProject}/src/functions.ts     |   0
 .../test/renderer/testProject}/src/generics.ts      |   0
 .../test/renderer/testProject}/src/hidden.ts        |   0
 .../test/renderer/testProject}/src/index.ts         |   0
 .../test/renderer/testProject}/src/markdown.ts      |   0
 .../test/renderer/testProject}/src/mixin.ts         |   0
 .../test/renderer/testProject}/src/mod.ts           |   0
 .../test/renderer/testProject}/src/mod2.ts          |   0
 .../test/renderer/testProject}/src/modules.ts       |   0
 .../test/renderer/testProject}/src/single-export.ts |   0
 .../test/renderer/testProject}/src/weird-names.ts   |   0
 .../test/renderer/testProject}/tsconfig.json        |   0
 tsconfig.json                                       |   3 ++-
 27 files changed, 11 insertions(+), 4 deletions(-)
 create mode 100644 internal-docs/visual-regression-tests.md
 rename {examples/basic => src/test/renderer/testProject}/.gitignore (100%)
 rename {examples/basic => src/test/renderer/testProject}/README.md (100%)
 rename {examples/basic => src/test/renderer/testProject}/inc/class-example.md (100%)
 rename {examples/basic => src/test/renderer/testProject}/media/logo-128.png (100%)
 rename {examples/basic => src/test/renderer/testProject}/run (100%)
 mode change 100755 => 100644
 rename {examples/basic => src/test/renderer/testProject}/run.bat (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/access.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/classes.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/default-export.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/enumerations.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/flattened.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/functions.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/generics.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/hidden.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/index.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/markdown.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/mixin.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/mod.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/mod2.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/modules.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/single-export.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/src/weird-names.ts (100%)
 rename {examples/basic => src/test/renderer/testProject}/tsconfig.json (100%)

diff --git a/.gitignore b/.gitignore
index 2df4b554f..e0a1a7b7d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,8 +7,9 @@ yarn.lock
 .nyc_output
 yarn-error.log
 
+/src/test/renderer/testProject/doc
+/src/test/renderer/testProject/json.json
 /examples/*/doc
-/examples/basic/json.json
 /node_modules/
 /coverage/
 /dist/
diff --git a/internal-docs/visual-regression-tests.md b/internal-docs/visual-regression-tests.md
new file mode 100644
index 000000000..7015e2dac
--- /dev/null
+++ b/internal-docs/visual-regression-tests.md
@@ -0,0 +1,5 @@
+# Running the Visual Regression Tests
+
+1. Build screenshots: `npm run test:visual`. All items should be considered new.
+2. Accept the screenshots: `npm run test:visual:accept`
+3. Run `npm run test:visual` again. All items should pass.
diff --git a/src/test/capture-screenshots.ts b/src/test/capture-screenshots.ts
index f19486b32..3aa822e2b 100644
--- a/src/test/capture-screenshots.ts
+++ b/src/test/capture-screenshots.ts
@@ -7,7 +7,7 @@ import { Application, TSConfigReader, EntryPointStrategy } from "..";
 import { remove } from "../lib/utils";
 
 const concurrency = 10;
-const src = join(__dirname, "../../examples/basic/src");
+const src = join(__dirname, "../../src/test/renderer/testProject/src");
 const baseDirectory = join(__dirname, "../../dist/tmp/capture");
 const outputDirectory = join(__dirname, "../../dist/tmp/__screenshots__");
 const globPattern = "**/*.html";
@@ -67,7 +67,7 @@ export async function captureRegressionScreenshots() {
         tsconfig: join(src, "..", "tsconfig.json"),
         plugin: [],
         entryPoints: [src],
-        entryPointStrategy: EntryPointStrategy.Expand,
+        entryPointStrategy: EntryPointStrategy.Resolve,
     });
     const project = app.convert();
     if (!project) throw new Error("Failed to convert.");
diff --git a/examples/basic/.gitignore b/src/test/renderer/testProject/.gitignore
similarity index 100%
rename from examples/basic/.gitignore
rename to src/test/renderer/testProject/.gitignore
diff --git a/examples/basic/README.md b/src/test/renderer/testProject/README.md
similarity index 100%
rename from examples/basic/README.md
rename to src/test/renderer/testProject/README.md
diff --git a/examples/basic/inc/class-example.md b/src/test/renderer/testProject/inc/class-example.md
similarity index 100%
rename from examples/basic/inc/class-example.md
rename to src/test/renderer/testProject/inc/class-example.md
diff --git a/examples/basic/media/logo-128.png b/src/test/renderer/testProject/media/logo-128.png
similarity index 100%
rename from examples/basic/media/logo-128.png
rename to src/test/renderer/testProject/media/logo-128.png
diff --git a/examples/basic/run b/src/test/renderer/testProject/run
old mode 100755
new mode 100644
similarity index 100%
rename from examples/basic/run
rename to src/test/renderer/testProject/run
diff --git a/examples/basic/run.bat b/src/test/renderer/testProject/run.bat
similarity index 100%
rename from examples/basic/run.bat
rename to src/test/renderer/testProject/run.bat
diff --git a/examples/basic/src/access.ts b/src/test/renderer/testProject/src/access.ts
similarity index 100%
rename from examples/basic/src/access.ts
rename to src/test/renderer/testProject/src/access.ts
diff --git a/examples/basic/src/classes.ts b/src/test/renderer/testProject/src/classes.ts
similarity index 100%
rename from examples/basic/src/classes.ts
rename to src/test/renderer/testProject/src/classes.ts
diff --git a/examples/basic/src/default-export.ts b/src/test/renderer/testProject/src/default-export.ts
similarity index 100%
rename from examples/basic/src/default-export.ts
rename to src/test/renderer/testProject/src/default-export.ts
diff --git a/examples/basic/src/enumerations.ts b/src/test/renderer/testProject/src/enumerations.ts
similarity index 100%
rename from examples/basic/src/enumerations.ts
rename to src/test/renderer/testProject/src/enumerations.ts
diff --git a/examples/basic/src/flattened.ts b/src/test/renderer/testProject/src/flattened.ts
similarity index 100%
rename from examples/basic/src/flattened.ts
rename to src/test/renderer/testProject/src/flattened.ts
diff --git a/examples/basic/src/functions.ts b/src/test/renderer/testProject/src/functions.ts
similarity index 100%
rename from examples/basic/src/functions.ts
rename to src/test/renderer/testProject/src/functions.ts
diff --git a/examples/basic/src/generics.ts b/src/test/renderer/testProject/src/generics.ts
similarity index 100%
rename from examples/basic/src/generics.ts
rename to src/test/renderer/testProject/src/generics.ts
diff --git a/examples/basic/src/hidden.ts b/src/test/renderer/testProject/src/hidden.ts
similarity index 100%
rename from examples/basic/src/hidden.ts
rename to src/test/renderer/testProject/src/hidden.ts
diff --git a/examples/basic/src/index.ts b/src/test/renderer/testProject/src/index.ts
similarity index 100%
rename from examples/basic/src/index.ts
rename to src/test/renderer/testProject/src/index.ts
diff --git a/examples/basic/src/markdown.ts b/src/test/renderer/testProject/src/markdown.ts
similarity index 100%
rename from examples/basic/src/markdown.ts
rename to src/test/renderer/testProject/src/markdown.ts
diff --git a/examples/basic/src/mixin.ts b/src/test/renderer/testProject/src/mixin.ts
similarity index 100%
rename from examples/basic/src/mixin.ts
rename to src/test/renderer/testProject/src/mixin.ts
diff --git a/examples/basic/src/mod.ts b/src/test/renderer/testProject/src/mod.ts
similarity index 100%
rename from examples/basic/src/mod.ts
rename to src/test/renderer/testProject/src/mod.ts
diff --git a/examples/basic/src/mod2.ts b/src/test/renderer/testProject/src/mod2.ts
similarity index 100%
rename from examples/basic/src/mod2.ts
rename to src/test/renderer/testProject/src/mod2.ts
diff --git a/examples/basic/src/modules.ts b/src/test/renderer/testProject/src/modules.ts
similarity index 100%
rename from examples/basic/src/modules.ts
rename to src/test/renderer/testProject/src/modules.ts
diff --git a/examples/basic/src/single-export.ts b/src/test/renderer/testProject/src/single-export.ts
similarity index 100%
rename from examples/basic/src/single-export.ts
rename to src/test/renderer/testProject/src/single-export.ts
diff --git a/examples/basic/src/weird-names.ts b/src/test/renderer/testProject/src/weird-names.ts
similarity index 100%
rename from examples/basic/src/weird-names.ts
rename to src/test/renderer/testProject/src/weird-names.ts
diff --git a/examples/basic/tsconfig.json b/src/test/renderer/testProject/tsconfig.json
similarity index 100%
rename from examples/basic/tsconfig.json
rename to src/test/renderer/testProject/tsconfig.json
diff --git a/tsconfig.json b/tsconfig.json
index 407322a9c..47572867f 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -44,6 +44,7 @@
         "src/test/.dot",
         "src/test/module",
         "src/test/packages",
-        "src/test/slow/entry-points"
+        "src/test/slow/entry-points",
+        "src/test/renderer/testProject"
     ]
 }

From 5cb6cb6e2f1a33ae2a6f53dffed0e6fc77d21b09 Mon Sep 17 00:00:00 2001
From: Sam Magura <srmagura@gmail.com>
Date: Wed, 29 Sep 2021 00:56:41 -0400
Subject: [PATCH 2/4] 1556: move examples/self to src/test/renderer/self

---
 .gitignore                            | 3 +--
 examples/self/run                     | 3 ---
 examples/self/run.bat                 | 7 -------
 src/test/renderer/self/run            | 3 +++
 src/test/renderer/self/run.bat        | 7 +++++++
 src/test/renderer/testProject/run     | 2 +-
 src/test/renderer/testProject/run.bat | 2 +-
 7 files changed, 13 insertions(+), 14 deletions(-)
 delete mode 100755 examples/self/run
 delete mode 100644 examples/self/run.bat
 create mode 100644 src/test/renderer/self/run
 create mode 100644 src/test/renderer/self/run.bat

diff --git a/.gitignore b/.gitignore
index e0a1a7b7d..84ce6e1fc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,9 +7,8 @@ yarn.lock
 .nyc_output
 yarn-error.log
 
-/src/test/renderer/testProject/doc
+/src/test/renderer/*/doc
 /src/test/renderer/testProject/json.json
-/examples/*/doc
 /node_modules/
 /coverage/
 /dist/
diff --git a/examples/self/run b/examples/self/run
deleted file mode 100755
index 17e47d93d..000000000
--- a/examples/self/run
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/bin/sh
-cd ${0%/*}
-node ../../bin/typedoc --name "TypeDoc Documentation" --tsconfig ../../tsconfig.json --readme ../../README.md --out doc/ --entryPointStrategy expand ../../src/lib/
diff --git a/examples/self/run.bat b/examples/self/run.bat
deleted file mode 100644
index 5f084ae11..000000000
--- a/examples/self/run.bat
+++ /dev/null
@@ -1,7 +0,0 @@
-@echo off
-set curr_dir=%cd%
-chdir /D "%~dp0"
-
-node ..\..\bin\typedoc --name "TypeDoc Documentation" --tsconfig ../../tsconfig.json --readme ../../README.md --out doc\ --entryPointStrategy expand ..\..\src\lib\
-
-chdir /D "%curr_dir%"
diff --git a/src/test/renderer/self/run b/src/test/renderer/self/run
new file mode 100644
index 000000000..d60d0be22
--- /dev/null
+++ b/src/test/renderer/self/run
@@ -0,0 +1,3 @@
+#!/bin/sh
+cd ${0%/*}
+node ../../../../bin/typedoc --name "TypeDoc Documentation" --tsconfig ../../../../tsconfig.json --readme ../../../../README.md --out doc/ --entryPointStrategy expand ../../../../src/lib/
diff --git a/src/test/renderer/self/run.bat b/src/test/renderer/self/run.bat
new file mode 100644
index 000000000..8431b38df
--- /dev/null
+++ b/src/test/renderer/self/run.bat
@@ -0,0 +1,7 @@
+@echo off
+set curr_dir=%cd%
+chdir /D "%~dp0"
+
+node ..\..\..\..\bin\typedoc --name "TypeDoc Documentation" --tsconfig ../../../../tsconfig.json --readme ../../../../README.md --out doc\ --entryPointStrategy expand ..\..\..\..\src\lib\
+
+chdir /D "%curr_dir%"
diff --git a/src/test/renderer/testProject/run b/src/test/renderer/testProject/run
index 8db2af596..3b734c6a0 100644
--- a/src/test/renderer/testProject/run
+++ b/src/test/renderer/testProject/run
@@ -1,3 +1,3 @@
 #!/bin/sh
 cd ${0%/*}
-node ../../bin/typedoc --includes inc/ --media media/ --json json.json --out doc/ src/
+node ../../../../bin/typedoc --includes inc/ --media media/ --json json.json --out doc/ src/
diff --git a/src/test/renderer/testProject/run.bat b/src/test/renderer/testProject/run.bat
index 240569837..c7e691902 100644
--- a/src/test/renderer/testProject/run.bat
+++ b/src/test/renderer/testProject/run.bat
@@ -2,6 +2,6 @@
 set curr_dir=%cd%
 chdir /D "%~dp0"
 
-node ..\..\bin\typedoc --includes inc\ --media media\ --json json.json --out doc\ src\
+node ..\..\..\..\bin\typedoc --includes inc\ --media media\ --json json.json --out doc\ src\
 
 chdir /D "%curr_dir%"
\ No newline at end of file

From bbf157e5f17ef26d599722f8938191c14dd6e789 Mon Sep 17 00:00:00 2001
From: Sam Magura <srmagura@gmail.com>
Date: Wed, 29 Sep 2021 01:15:32 -0400
Subject: [PATCH 3/4] 1556: revert capture-screenshots entryPointStrategy
 change

---
 src/test/capture-screenshots.ts            |  2 +-
 src/test/renderer/testProject/run          |  2 +-
 src/test/renderer/testProject/run.bat      |  2 +-
 src/test/renderer/testProject/src/index.ts | 15 ---------------
 4 files changed, 3 insertions(+), 18 deletions(-)
 delete mode 100644 src/test/renderer/testProject/src/index.ts

diff --git a/src/test/capture-screenshots.ts b/src/test/capture-screenshots.ts
index 3aa822e2b..14d6e6e3d 100644
--- a/src/test/capture-screenshots.ts
+++ b/src/test/capture-screenshots.ts
@@ -67,7 +67,7 @@ export async function captureRegressionScreenshots() {
         tsconfig: join(src, "..", "tsconfig.json"),
         plugin: [],
         entryPoints: [src],
-        entryPointStrategy: EntryPointStrategy.Resolve,
+        entryPointStrategy: EntryPointStrategy.Expand,
     });
     const project = app.convert();
     if (!project) throw new Error("Failed to convert.");
diff --git a/src/test/renderer/testProject/run b/src/test/renderer/testProject/run
index 3b734c6a0..e7f9f1194 100644
--- a/src/test/renderer/testProject/run
+++ b/src/test/renderer/testProject/run
@@ -1,3 +1,3 @@
 #!/bin/sh
 cd ${0%/*}
-node ../../../../bin/typedoc --includes inc/ --media media/ --json json.json --out doc/ src/
+node ../../../../bin/typedoc --includes inc/ --media media/ --json json.json --out doc/ --entryPointStrategy expand src/
diff --git a/src/test/renderer/testProject/run.bat b/src/test/renderer/testProject/run.bat
index c7e691902..ca2b01cd7 100644
--- a/src/test/renderer/testProject/run.bat
+++ b/src/test/renderer/testProject/run.bat
@@ -2,6 +2,6 @@
 set curr_dir=%cd%
 chdir /D "%~dp0"
 
-node ..\..\..\..\bin\typedoc --includes inc\ --media media\ --json json.json --out doc\ src\
+node ..\..\..\..\bin\typedoc --includes inc\ --media media\ --json json.json --out doc\ --entryPointStrategy expand src\
 
 chdir /D "%curr_dir%"
\ No newline at end of file
diff --git a/src/test/renderer/testProject/src/index.ts b/src/test/renderer/testProject/src/index.ts
deleted file mode 100644
index 984455985..000000000
--- a/src/test/renderer/testProject/src/index.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-export * from "./access";
-export * from "./classes";
-export * from "./default-export";
-export * from "./enumerations";
-export * from "./flattened";
-export * from "./functions";
-export * from "./generics";
-export * from "./hidden";
-export * from "./markdown";
-export * from "./mixin";
-export * from "./mod";
-export * from "./mod2";
-export * from "./modules";
-export { default as SingleExportedClass } from "./single-export";
-export * from "./weird-names";

From 0dd2688954ebec5517c552f38c25dd851fa3e38b Mon Sep 17 00:00:00 2001
From: Sam Magura <srmagura@gmail.com>
Date: Wed, 29 Sep 2021 09:45:38 -0400
Subject: [PATCH 4/4] 1556: remove src/test/renderer/self per @Gerrit0

---
 src/test/renderer/self/run     | 3 ---
 src/test/renderer/self/run.bat | 7 -------
 2 files changed, 10 deletions(-)
 delete mode 100644 src/test/renderer/self/run
 delete mode 100644 src/test/renderer/self/run.bat

diff --git a/src/test/renderer/self/run b/src/test/renderer/self/run
deleted file mode 100644
index d60d0be22..000000000
--- a/src/test/renderer/self/run
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/bin/sh
-cd ${0%/*}
-node ../../../../bin/typedoc --name "TypeDoc Documentation" --tsconfig ../../../../tsconfig.json --readme ../../../../README.md --out doc/ --entryPointStrategy expand ../../../../src/lib/
diff --git a/src/test/renderer/self/run.bat b/src/test/renderer/self/run.bat
deleted file mode 100644
index 8431b38df..000000000
--- a/src/test/renderer/self/run.bat
+++ /dev/null
@@ -1,7 +0,0 @@
-@echo off
-set curr_dir=%cd%
-chdir /D "%~dp0"
-
-node ..\..\..\..\bin\typedoc --name "TypeDoc Documentation" --tsconfig ../../../../tsconfig.json --readme ../../../../README.md --out doc\ --entryPointStrategy expand ..\..\..\..\src\lib\
-
-chdir /D "%curr_dir%"