From ffeca79e0b88c6a88367f31338ad0d44810d7841 Mon Sep 17 00:00:00 2001 From: Jason Dreyzehner Date: Tue, 17 Apr 2018 19:31:07 -0400 Subject: [PATCH] [ci skip] Updates --- enums/placeholders.html | 6 +- enums/runner.html | 4 +- enums/testdirectories.html | 12 +-- globals.html | 102 +++++++++--------- index.html | 51 +++++---- interfaces/tasks.html | 6 +- interfaces/typescriptstarterclioptions.html | 24 ++--- .../typescriptstarterinferredoptions.html | 10 +- interfaces/typescriptstarteroptions.html | 34 +++--- .../typescriptstarterrequiredconfig.html | 4 +- 10 files changed, 130 insertions(+), 123 deletions(-) diff --git a/enums/placeholders.html b/enums/placeholders.html index d90fa26..e4ad393 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 e5f1a00..7a40df8 100644 --- a/enums/runner.html +++ b/enums/runner.html @@ -88,7 +88,7 @@
Npm: = "npm"
@@ -98,7 +98,7 @@
Yarn: = "yarn"
diff --git a/enums/testdirectories.html b/enums/testdirectories.html index 4f91a9a..142611d 100644 --- a/enums/testdirectories.html +++ b/enums/testdirectories.html @@ -92,7 +92,7 @@
five: = "test-5"
@@ -102,7 +102,7 @@
four: = "test-4"
@@ -112,7 +112,7 @@
one: = "test-1"
@@ -122,7 +122,7 @@
six: = "test-6"
@@ -132,7 +132,7 @@
three: = "test-3"
@@ -142,7 +142,7 @@
two: = "test-2"
diff --git a/globals.html b/globals.html index 9e89a7b..e2b8a2d 100644 --- a/globals.html +++ b/globals.html @@ -156,7 +156,7 @@
TypescriptStarterArgsOptions: TypescriptStarterUserOptions | TypescriptStarterRequiredConfig
@@ -166,7 +166,7 @@
TypescriptStarterUserOptions: TypescriptStarterCLIOptions & TypescriptStarterRequiredConfig
@@ -179,7 +179,7 @@
branch: string = execa.sync('git', ['rev-parse','--symbolic-full-name','--abbrev-ref','HEAD']).stdout
@@ -197,7 +197,7 @@
buildDir: string = join(process.cwd(), 'build')
@@ -207,7 +207,7 @@
down: "" = ""
@@ -219,7 +219,7 @@ "
@@ -229,7 +229,7 @@
inherit: undefined | null | number | "inherit" | "pipe" | "ipc" | "ignore" | Stream = 'inherit' as StdIOOption
@@ -239,7 +239,7 @@
up: "" = ""
@@ -256,7 +256,7 @@

  • Parameters

    @@ -279,7 +279,7 @@
  • @@ -312,7 +312,7 @@ asyncABC().then(console.log);

  • Returns Promise<TypescriptStarterArgsOptions>

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

  • Parameters

    @@ -355,7 +355,7 @@ asyncABC().then(console.log);
  • @@ -402,7 +402,7 @@ asyncABC().then(console.log);

  • Parameters

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

  • Parameters

    @@ -448,7 +448,7 @@ asyncABC().then(console.log);
  • @@ -492,7 +492,7 @@ asyncABC().then(console.log);

  • Parameters

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

  • Parameters

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

  • Parameters

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

  • Parameters

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

  • Parameters

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

  • Returns Promise<TypescriptStarterCLIOptions>

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

  • Parameters

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

  • Parameters

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

  • Parameters

    @@ -702,7 +702,7 @@ asyncABC().then(console.log);
  • @@ -743,7 +743,7 @@ asyncABC().then(console.log);

  • Parameters

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

  • Parameters

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

  • Parameters

    @@ -818,7 +818,7 @@ asyncABC().then(console.log);
  • @@ -852,7 +852,7 @@ sha256('test')
  • @@ -886,7 +886,7 @@ sha256('test')

  • Parameters

    @@ -909,7 +909,7 @@ sha256('test')

  • Parameters

    @@ -938,7 +938,7 @@ sha256('test')

  • Parameters

    @@ -1025,7 +1025,7 @@ sha256('test')

  • Parameters

    @@ -1051,7 +1051,7 @@ sha256('test')

  • Parameters

    @@ -1076,7 +1076,7 @@ sha256('test')
    LiveTasks: object
    @@ -1085,7 +1085,7 @@ sha256('test')
    cloneRepo: (Anonymous function) = cloneRepo(execa)
    @@ -1095,7 +1095,7 @@ sha256('test')
    initialCommit: (Anonymous function) = initialCommit(execa)
    @@ -1105,7 +1105,7 @@ sha256('test')
    install: (Anonymous function) = install(execa)
    @@ -1116,7 +1116,7 @@ sha256('test')
    env: object
    @@ -1125,7 +1125,7 @@ sha256('test')
    TYPESCRIPT_STARTER_REPO_BRANCH: string = repoInfo.branch
    @@ -1135,7 +1135,7 @@ sha256('test')
    TYPESCRIPT_STARTER_REPO_URL: string = repoInfo.repo
    @@ -1146,7 +1146,7 @@ sha256('test')
    repoInfo: object
    @@ -1155,7 +1155,7 @@ sha256('test')
    branch: string = branch === 'HEAD' ? '.' : branch
    @@ -1165,7 +1165,7 @@ sha256('test')
    repo: string = process.cwd()
    @@ -1176,7 +1176,7 @@ sha256('test')
    sandboxOptions: object
    @@ -1185,7 +1185,7 @@ sha256('test')
    description: string = "this is an example description"
    @@ -1195,7 +1195,7 @@ sha256('test')
    githubUsername: string = "SOME_GITHUB_USERNAME"
    @@ -1205,7 +1205,7 @@ sha256('test')
    repoInfo: object
    @@ -1226,7 +1226,7 @@ sha256('test')
    workingDirectory: string = buildDir
    diff --git a/index.html b/index.html index e529eab..90e76cd 100644 --- a/index.html +++ b/index.html @@ -132,21 +132,21 @@

    Generate your API docs

    The src folder is analyzed and documentation is automatically generated using TypeDoc.

    - 
    npm run docs
+				
    npm run doc
 
    
 				
    This command generates API documentation for your library in HTML format and opens it in a browser.
    
 				
    Since types are tracked by Typescript, there's no need to indicate types in JSDoc format. For more information, see the TypeDoc documentation.
    
 				
    To generate and publish your documentation to GitHub Pages use the following command:
    
-				
    npm run docs:publish
+				
    npm run doc:publish
 
    
 				
    Once published, your documentation should be available at the proper GitHub Pages URL for your repo. See typescript-starter's GitHub Pages for an example.
    
 				
    
 					TypeDoc documentation example
 				
    
 				
    For more advanced documentation generation, you can provide your own TypeDoc theme, or build your own documentation using the JSON TypeDoc export:
    
-				
    npm run docs:json
+				
    npm run doc:json
 
    
-				
    Update the changelog, commit, & tag release
    
+				
    Bump version, update changelog, commit, & tag release
    
 				
    It's recommended that you install commitizen to make commits to your project.
    
 				
    npm install -g commitizen
 
@@ -155,27 +155,13 @@ git cz
 
    
 				
    This project is tooled for conventional changelog to make managing releases easier. See the standard-version documentation for more information on the workflow, or CHANGELOG.md for an example.
    
 				
    # bump package.json version, update CHANGELOG.md, git tag the release
-npm run changelog
+npm run version
 
    
 				
    You may find a tool like wip helpful for managing work in progress before you're ready to create a meaningful commit.
    
 				
    One-step publish preparation script
    
 				
    Bringing together many of the steps above, this repo includes a one-step release preparation command.
    
 				
    # Prepare a standard release:
 npm run prepare-release
-
    
-				
    You can also prepare a non-standard release:
    
-				
    # Or a non-standard release:
-
-# Build everything
-npm run all
-
-# Then version it
-npm run version -- --first-release # don't bump package.json version
-npm run version -- --sign # PGP sign it
-npm run version -- --prerelease alpha # alpha release
-
-# And don't forget to push the docs to GitHub pages:
-npm run docs:publish
 
    
 				
    This command runs the following tasks:
    
 				
      
@@ -183,12 +169,33 @@ npm run docs:publish
 					
    • test: build and fully test the project
      • 
 					
    • docs:html: generate the latest version of the documentation
      • 
 					
    • docs:publish: publish the documentation to GitHub Pages
      • 
-					
    • changelog: bump package.json version, update CHANGELOG.md, and git tag the release
      • 
+					
    • version: bump package.json version, update CHANGELOG.md, and git tag the release
      • 
 				
    
 				
    When the script finishes, it will log the final command needed to push the release commit to the repo and publish the package on the npm registry:
    
 				
    git push --follow-tags origin master; npm publish
 
    
 				
    Look over the release if you'd like, then execute the command to publish everything.
    
+				
    You can also prepare a non-standard release:
    
+				
    # Or a non-standard release:
+
+# Build everything
+npm run all
+
+# Then version it with standard-version options. e.g.:
+# don't bump package.json version
+npm run version -- --first-release
+
+# Other popular options include:
+
+# PGP sign it:
+# $ npm run version -- --sign
+
+# alpha release:
+# $ npm run version -- --prerelease alpha
+
+# And don't forget to push the docs to GitHub pages:
+npm run doc:publish
+
    
 				
    Get scripts info
    
 				
    You can run the info script for information on each script intended to be individually run.
    
 				
    npm run info
@@ -211,11 +218,11 @@ doc:
   Generate HTML API documentation and open it in a browser
 doc:json:
   Generate API documentation in typedoc JSON format
-changelog:
+version:
   Bump package.json version, update CHANGELOG.md, tag release
 reset:
   Delete all untracked files and reset the repo to the last commit
-release:
+prepare-release:
   One-step: clean, build, test, publish docs, and prep a release
 
    FAQs
    
 				
    Why are there two builds? (main and module)
    
diff --git a/interfaces/tasks.html b/interfaces/tasks.html
index 225b943..9a96b95 100644
--- a/interfaces/tasks.html
+++ b/interfaces/tasks.html
@@ -97,7 +97,7 @@
 					
    cloneRepo: function
    
 					
 					
    
@@ -142,7 +142,7 @@
 					
    initialCommit: function
    
 					
 					
    
@@ -179,7 +179,7 @@
 					
    install: function
    
 					
 					
    
diff --git a/interfaces/typescriptstarterclioptions.html b/interfaces/typescriptstarterclioptions.html
index 3317eac..0cd1f12 100644
--- a/interfaces/typescriptstarterclioptions.html
+++ b/interfaces/typescriptstarterclioptions.html
@@ -111,7 +111,7 @@
 					
    appveyor: boolean
    
 					
 				
@@ -121,7 +121,7 @@
 					
    circleci: boolean
    
 					
 				
@@ -131,7 +131,7 @@
 					
    description: string
    
 					
 				
@@ -141,7 +141,7 @@
 					
    domDefinitions: boolean
    
 					
 				
@@ -151,7 +151,7 @@
 					
    immutable: boolean
    
 					
 				
@@ -161,7 +161,7 @@
 					
    install: boolean
    
 					
 				
@@ -171,7 +171,7 @@
 					
    nodeDefinitions: boolean
    
 					
 				
@@ -181,7 +181,7 @@
 					
    projectName: string
    
 					
 				
@@ -191,7 +191,7 @@
 					
    runner: Runner
    
 					
 				
@@ -201,7 +201,7 @@
 					
    strict: boolean
    
 					
 				
@@ -211,7 +211,7 @@
 					
    travis: boolean
    
 					
 				
@@ -221,7 +221,7 @@
 					
    vscode: boolean
    
 					
 				
diff --git a/interfaces/typescriptstarterinferredoptions.html b/interfaces/typescriptstarterinferredoptions.html
index 5c9011f..03e53bf 100644
--- a/interfaces/typescriptstarterinferredoptions.html
+++ b/interfaces/typescriptstarterinferredoptions.html
@@ -104,7 +104,7 @@
 					
    email: string
    
 					
 				
@@ -114,7 +114,7 @@
 					
    fullName: string
    
 					
 				
@@ -124,7 +124,7 @@
 					
    githubUsername: string
    
 					
 				
@@ -134,7 +134,7 @@
 					
    repoInfo: object
    
 					
 					
    
@@ -155,7 +155,7 @@
 					
    workingDirectory: string
    
 					
 				
diff --git a/interfaces/typescriptstarteroptions.html b/interfaces/typescriptstarteroptions.html
index 9b82ef0..49c4e45 100644
--- a/interfaces/typescriptstarteroptions.html
+++ b/interfaces/typescriptstarteroptions.html
@@ -120,7 +120,7 @@
 					
 				
@@ -131,7 +131,7 @@
 					
 				
@@ -142,7 +142,7 @@
 					
 				
@@ -153,7 +153,7 @@
 					
 				
@@ -164,7 +164,7 @@
 					
 				
@@ -175,7 +175,7 @@
 					
 				
@@ -186,7 +186,7 @@
 					
 				
@@ -197,7 +197,7 @@
 					
 				
@@ -208,7 +208,7 @@
 					
 				
@@ -219,7 +219,7 @@
 					
 				
@@ -230,7 +230,7 @@
 					
 				
@@ -241,7 +241,7 @@
 					
 					
    
@@ -263,7 +263,7 @@
 					
 				
@@ -274,7 +274,7 @@
 					
 				
@@ -285,7 +285,7 @@
 					
 				
@@ -296,7 +296,7 @@
 					
 				
@@ -307,7 +307,7 @@
 					
 				
diff --git a/interfaces/typescriptstarterrequiredconfig.html b/interfaces/typescriptstarterrequiredconfig.html
index 89bccc8..969821e 100644
--- a/interfaces/typescriptstarterrequiredconfig.html
+++ b/interfaces/typescriptstarterrequiredconfig.html
@@ -96,7 +96,7 @@
 					
    install: boolean
    
 					
 				
@@ -106,7 +106,7 @@
 					
    starterVersion: string