From 5d635b4647bd54ce44c942a82079358193b73685 Mon Sep 17 00:00:00 2001 From: Jason Dreyzehner Date: Tue, 8 Sep 2020 19:20:10 -0400 Subject: [PATCH] [ci skip] Updates --- enums/placeholders.html | 6 ++-- enums/runner.html | 4 +-- globals.html | 64 ++++++++++++++++++++--------------------- index.html | 14 +++++++++ 4 files changed, 51 insertions(+), 37 deletions(-) diff --git a/enums/placeholders.html b/enums/placeholders.html index 7fb2525..65584a5 100644 --- a/enums/placeholders.html +++ b/enums/placeholders.html @@ -89,7 +89,7 @@
email: = "YOUR_EMAIL"
@@ -99,7 +99,7 @@
name: = "YOUR_NAME"
@@ -109,7 +109,7 @@
username: = "YOUR_GITHUB_USER_NAME"
diff --git a/enums/runner.html b/enums/runner.html index 41dbea0..172ba07 100644 --- a/enums/runner.html +++ b/enums/runner.html @@ -88,7 +88,7 @@
Npm: = "npm"
@@ -98,7 +98,7 @@
Yarn: = "yarn"
diff --git a/globals.html b/globals.html index e9050ff..c620d5a 100644 --- a/globals.html +++ b/globals.html @@ -129,7 +129,7 @@
Tasks: { cloneRepo: (repoInfo: { branch: string; repo: string }, workingDirectory: string, dir: string) => Promise<{ commitHash: string; gitHistoryDir: string }>; initialCommit: (hash: string, projectDir: string, name: string) => Promise<void>; install: (runner: Runner, projectDir: string) => Promise<void> }
@@ -230,7 +230,7 @@
TypescriptStarterArgsOptions: TypescriptStarterUserOptions | TypescriptStarterRequiredConfig
@@ -240,7 +240,7 @@
TypescriptStarterCLIOptions: { appveyor: boolean; circleci: boolean; cspell: boolean; description: string; domDefinitions: boolean; editorconfig: boolean; functional: boolean; install: boolean; nodeDefinitions: boolean; projectName: string; runner: Runner; strict: boolean; travis: boolean; vscode: boolean }
@@ -297,7 +297,7 @@
TypescriptStarterInferredOptions: { email: string; fullName: string; githubUsername: string; repoInfo: { branch: string; repo: string }; workingDirectory: string }
@@ -335,7 +335,7 @@
TypescriptStarterOptions: TypescriptStarterCLIOptions & TypescriptStarterInferredOptions & {}
@@ -345,7 +345,7 @@
TypescriptStarterRequiredConfig: { install: boolean; starterVersion: string }
@@ -366,7 +366,7 @@
TypescriptStarterUserOptions: TypescriptStarterCLIOptions & TypescriptStarterRequiredConfig
@@ -383,7 +383,7 @@

  • Parameters

    @@ -406,7 +406,7 @@
  • @@ -441,7 +441,7 @@ asyncABC().then(console.log);

  • Returns Promise<TypescriptStarterArgsOptions>

    @@ -458,7 +458,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -484,7 +484,7 @@ asyncABC().then(console.log);
  • @@ -535,7 +535,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -558,7 +558,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -581,7 +581,7 @@ asyncABC().then(console.log);
  • @@ -625,7 +625,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -648,7 +648,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -671,7 +671,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -694,7 +694,7 @@ asyncABC().then(console.log);

  • Returns Promise<TypescriptStarterCLIOptions>

    @@ -711,7 +711,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -734,7 +734,7 @@ asyncABC().then(console.log);
  • @@ -763,7 +763,7 @@ asyncABC().then(console.log);
  • @@ -817,7 +817,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -840,7 +840,7 @@ asyncABC().then(console.log);
  • @@ -883,7 +883,7 @@ asyncABC().then(console.log);
  • @@ -924,7 +924,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -1017,7 +1017,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -1040,7 +1040,7 @@ asyncABC().then(console.log);

  • Parameters

    @@ -1065,7 +1065,7 @@ asyncABC().then(console.log);
    LiveTasks: object
    @@ -1074,7 +1074,7 @@ asyncABC().then(console.log);
    cloneRepo: (Anonymous function) = cloneRepo(execa)
    @@ -1084,7 +1084,7 @@ asyncABC().then(console.log);
    initialCommit: (Anonymous function) = initialCommit(execa)
    @@ -1094,7 +1094,7 @@ asyncABC().then(console.log);
    install: (Anonymous function) = install(execa)
    diff --git a/index.html b/index.html index 64740d7..af98312 100644 --- a/index.html +++ b/index.html @@ -287,6 +287,9 @@ npm run doc:publish npm install npm test npm link + +

    Manual testing

    +

    To manually test the CLI, you can use the TYPESCRIPT_STARTER_REPO_URL environment variable to test a clone from your local repo. Run npm run build:main -- -w as you're developing, then in a different testing directory:

    mkdir typescript-starter-testing
 cd typescript-starter-testing
@@ -294,7 +297,18 @@ TYPESCRIPT_STARTER_REPO_URL='/local/path
 					
    You can also set TYPESCRIPT_STARTER_REPO_URL to any valid Git URL, such as your fork of this repo:
    
 					
    TYPESCRIPT_STARTER_REPO_URL='https://github.com/YOUR_USERNAME/typescript-starter.git' typescript-starter
    
 					
    If TYPESCRIPT_STARTER_REPO_BRANCH is not provided, it will default to master.
    
+					
+						
    Debug in VS Code
    
+					    
 					
    If you're using VS Code, the Debug CLI launch configuration also allows you to immediately build and step through execution of the CLI.
    
+					
+						
    Integration Test Result Diffs
    
+					    
+					
    You can compare the integration test results before and after a change by running check-cli before and after applying your changes:
    
+					
    npm run check-cli
    
+					
    Each time you run check-cli, the test results will be committed to the diff directory, allowing you to easily review the differences with git diff HEAD or an interactive Git client like GitHub for Desktop or SourceTree.
    
+					
    If you already have changes in the working directory, try:
    
+					
    git stash && npm run check-cli && git stash pop && npm run check-cli