From d4a98b9992d1253e1971de19f3c8569fb8ea6095 Mon Sep 17 00:00:00 2001 From: Jason Dreyzehner Date: Tue, 1 Sep 2020 23:02:54 -0400 Subject: [PATCH] [ci skip] Updates --- enums/placeholders.html | 6 ++-- enums/runner.html | 4 +-- globals.html | 64 ++++++++++++++++++++--------------------- index.html | 32 +++++++++++---------- 4 files changed, 54 insertions(+), 52 deletions(-) diff --git a/enums/placeholders.html b/enums/placeholders.html index b80c908..a5db415 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 6489bd4..c85f8b2 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 e3595b9..999c4a2 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 e1bcf17..64740d7 100644 --- a/index.html +++ b/index.html @@ -78,7 +78,7 @@

    Start Now

    Run one simple command to install and use the interactive project generator. You'll need Node v10 or later.

    - 
    npx typescript-starter
    + 
    npx typescript-starter

    The interactive CLI will help you create and configure your project automatically.

    Since this repo includes the CLI and it's tests, you'll only need to fork or clone this project if you want to contribute. If you find this project useful, please consider leaving a star so others can find it. Thanks!

    @@ -117,10 +117,12 @@

    Development zen

     -

    To start working, run the watch task using npm or yarn.

    - 
    npm run watch
    -

    This starter includes a watch task which makes development faster and more interactive. It's particularly helpful for TDD/BDD workflows.

    -

    The watch task will build and watch the entire project for changes (to both the library source files and test source files). As you develop, you can add tests for new functionality – which will initially fail – before developing the new functionality. Each time you save, any changes will be rebuilt and retested.

    +

    To start working, run the watch:build task using npm or yarn.

    + 
    npm run watch:build
    +

    In another terminal tab/window, run the watch:test task:

    + 
    npm run watch:test
    +

    These watch tasks make development much faster and more interactive. They're particularly helpful for TDD/BDD workflows.

    +

    These watch tasks will build and watch the entire project for changes (to both the library source files and test source files). As you develop, you can add tests for new functionality – which will initially fail – before developing the new functionality. Each time you save, any changes will be rebuilt and retested.

    typescript-starter's watch task @@ -135,12 +137,12 @@

    Auto-fix and format project

    To automatically fix eslint and prettier formatting issues, run:

    - 
    npm run fix
    + 
    npm run fix

    View test coverage

    To generate and view test coverage, run:

    - 
    npm run cov
    + 
    npm run cov

    This will create an HTML report of test coverage – source-mapped back to Typescript – and open it in your default browser.

    source-mapped typescript test coverage example @@ -149,34 +151,34 @@

    Generate your API docs

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

    - 
    npm run doc
    + 
    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 doc: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 doc:json
    + 
    npm run doc:json

    Bump version, update changelog, commit, & tag release

    It's recommended that you install commitizen to make commits to your project.

    - 
    npm install -g commitizen
+				
    npm install -g commitizen
 
 # commit your changes:
 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
+				
    # bump package.json version, update CHANGELOG.md, git tag the release
 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:
+				
    # Prepare a standard release:
 npm run prepare-release
    
 				
    This command runs the following tasks:
    
 				
      
@@ -187,10 +189,10 @@ npm run prepare-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
    
+				
    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:
+				
    # Or a non-standard release:
 
 # Reset the repo to the latest commit and build everything
 npm run hard-reset && npm run test && npm run cov:check && npm run doc:html