diff --git a/assets/js/search.js b/assets/js/search.js index 9d603f7..f748911 100644 --- a/assets/js/search.js +++ b/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","256":"Interface","1024":"Property","65536":"Type literal","2097152":"Object literal"},"rows":[{"id":0,"kind":4,"name":"Runner","url":"enums/runner.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"Npm","url":"enums/runner.html#npm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Runner"},{"id":2,"kind":16,"name":"Yarn","url":"enums/runner.html#yarn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Runner"},{"id":3,"kind":256,"name":"TypescriptStarterUserOptions","url":"interfaces/typescriptstarteruseroptions.html","classes":"tsd-kind-interface"},{"id":4,"kind":1024,"name":"description","url":"interfaces/typescriptstarteruseroptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":5,"kind":1024,"name":"domDefinitions","url":"interfaces/typescriptstarteruseroptions.html#domdefinitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":6,"kind":1024,"name":"immutable","url":"interfaces/typescriptstarteruseroptions.html#immutable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":7,"kind":1024,"name":"install","url":"interfaces/typescriptstarteruseroptions.html#install","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":8,"kind":1024,"name":"nodeDefinitions","url":"interfaces/typescriptstarteruseroptions.html#nodedefinitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":9,"kind":1024,"name":"projectName","url":"interfaces/typescriptstarteruseroptions.html#projectname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":10,"kind":1024,"name":"runner","url":"interfaces/typescriptstarteruseroptions.html#runner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":11,"kind":1024,"name":"strict","url":"interfaces/typescriptstarteruseroptions.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":12,"kind":1024,"name":"vscode","url":"interfaces/typescriptstarteruseroptions.html#vscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterUserOptions"},{"id":13,"kind":256,"name":"TypescriptStarterInferredOptions","url":"interfaces/typescriptstarterinferredoptions.html","classes":"tsd-kind-interface"},{"id":14,"kind":1024,"name":"githubUsername","url":"interfaces/typescriptstarterinferredoptions.html#githubusername","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":15,"kind":1024,"name":"fullName","url":"interfaces/typescriptstarterinferredoptions.html#fullname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":16,"kind":1024,"name":"email","url":"interfaces/typescriptstarterinferredoptions.html#email","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":17,"kind":1024,"name":"repoURL","url":"interfaces/typescriptstarterinferredoptions.html#repourl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":18,"kind":1024,"name":"workingDirectory","url":"interfaces/typescriptstarterinferredoptions.html#workingdirectory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":19,"kind":256,"name":"TypescriptStarterOptions","url":"interfaces/typescriptstarteroptions.html","classes":"tsd-kind-interface"},{"id":20,"kind":1024,"name":"description","url":"interfaces/typescriptstarteroptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":21,"kind":1024,"name":"domDefinitions","url":"interfaces/typescriptstarteroptions.html#domdefinitions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":22,"kind":1024,"name":"immutable","url":"interfaces/typescriptstarteroptions.html#immutable","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":23,"kind":1024,"name":"install","url":"interfaces/typescriptstarteroptions.html#install","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":24,"kind":1024,"name":"nodeDefinitions","url":"interfaces/typescriptstarteroptions.html#nodedefinitions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":25,"kind":1024,"name":"projectName","url":"interfaces/typescriptstarteroptions.html#projectname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":26,"kind":1024,"name":"runner","url":"interfaces/typescriptstarteroptions.html#runner","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":27,"kind":1024,"name":"strict","url":"interfaces/typescriptstarteroptions.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":28,"kind":1024,"name":"vscode","url":"interfaces/typescriptstarteroptions.html#vscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":29,"kind":1024,"name":"githubUsername","url":"interfaces/typescriptstarteroptions.html#githubusername","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":30,"kind":1024,"name":"fullName","url":"interfaces/typescriptstarteroptions.html#fullname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":31,"kind":1024,"name":"email","url":"interfaces/typescriptstarteroptions.html#email","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":32,"kind":1024,"name":"repoURL","url":"interfaces/typescriptstarteroptions.html#repourl","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":33,"kind":1024,"name":"workingDirectory","url":"interfaces/typescriptstarteroptions.html#workingdirectory","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":34,"kind":64,"name":"validateName","url":"globals.html#validatename","classes":"tsd-kind-function"},{"id":35,"kind":64,"name":"getIntro","url":"globals.html#getintro","classes":"tsd-kind-function"},{"id":36,"kind":64,"name":"checkArgs","url":"globals.html#checkargs","classes":"tsd-kind-function"},{"id":37,"kind":64,"name":"inquire","url":"globals.html#inquire","classes":"tsd-kind-function"},{"id":38,"kind":4,"name":"Placeholders","url":"enums/placeholders.html","classes":"tsd-kind-enum"},{"id":39,"kind":16,"name":"email","url":"enums/placeholders.html#email","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":40,"kind":16,"name":"name","url":"enums/placeholders.html#name","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":41,"kind":16,"name":"username","url":"enums/placeholders.html#username","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":42,"kind":256,"name":"Tasks","url":"interfaces/tasks.html","classes":"tsd-kind-interface"},{"id":43,"kind":1024,"name":"cloneRepo","url":"interfaces/tasks.html#clonerepo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":44,"kind":65536,"name":"__type","url":"interfaces/tasks.html#clonerepo.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.cloneRepo"},{"id":45,"kind":1024,"name":"initialCommit","url":"interfaces/tasks.html#initialcommit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":46,"kind":65536,"name":"__type","url":"interfaces/tasks.html#initialcommit.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.initialCommit"},{"id":47,"kind":1024,"name":"install","url":"interfaces/tasks.html#install","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":48,"kind":65536,"name":"__type","url":"interfaces/tasks.html#install.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.install"},{"id":49,"kind":32,"name":"inherit","url":"globals.html#inherit","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":50,"kind":64,"name":"cloneRepo","url":"globals.html#clonerepo","classes":"tsd-kind-function"},{"id":51,"kind":64,"name":"getGithubUsername","url":"globals.html#getgithubusername","classes":"tsd-kind-function"},{"id":52,"kind":64,"name":"getUserInfo","url":"globals.html#getuserinfo","classes":"tsd-kind-function"},{"id":53,"kind":64,"name":"initialCommit","url":"globals.html#initialcommit","classes":"tsd-kind-function"},{"id":54,"kind":64,"name":"install","url":"globals.html#install","classes":"tsd-kind-function"},{"id":55,"kind":64,"name":"getRepoUrl","url":"globals.html#getrepourl","classes":"tsd-kind-function"},{"id":56,"kind":2097152,"name":"LiveTasks","url":"globals.html#livetasks","classes":"tsd-kind-object-literal"},{"id":57,"kind":32,"name":"cloneRepo","url":"globals.html#livetasks.clonerepo","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":58,"kind":32,"name":"initialCommit","url":"globals.html#livetasks.initialcommit","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":59,"kind":32,"name":"install","url":"globals.html#livetasks.install","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":60,"kind":64,"name":"getInferredOptions","url":"globals.html#getinferredoptions","classes":"tsd-kind-function"},{"id":61,"kind":64,"name":"typescriptStarter","url":"globals.html#typescriptstarter","classes":"tsd-kind-function"},{"id":62,"kind":64,"name":"readPackageJson","url":"globals.html#readpackagejson","classes":"tsd-kind-function tsd-is-not-exported"},{"id":63,"kind":64,"name":"writePackageJson","url":"globals.html#writepackagejson","classes":"tsd-kind-function tsd-is-not-exported"},{"id":64,"kind":4,"name":"TestDirectories","url":"enums/testdirectories.html","classes":"tsd-kind-enum tsd-is-not-exported"},{"id":65,"kind":16,"name":"one","url":"enums/testdirectories.html#one","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":66,"kind":16,"name":"two","url":"enums/testdirectories.html#two","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":67,"kind":16,"name":"three","url":"enums/testdirectories.html#three","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":68,"kind":16,"name":"four","url":"enums/testdirectories.html#four","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":69,"kind":16,"name":"five","url":"enums/testdirectories.html#five","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":70,"kind":16,"name":"six","url":"enums/testdirectories.html#six","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":71,"kind":32,"name":"repoURL","url":"globals.html#repourl","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":72,"kind":32,"name":"buildDir","url":"globals.html#builddir","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":73,"kind":64,"name":"hashAllTheThings","url":"globals.html#hashallthethings","classes":"tsd-kind-function tsd-is-not-exported"},{"id":74,"kind":32,"name":"down","url":"globals.html#down","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":75,"kind":32,"name":"up","url":"globals.html#up","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":76,"kind":32,"name":"enter","url":"globals.html#enter","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":77,"kind":64,"name":"ms","url":"globals.html#ms","classes":"tsd-kind-function tsd-is-not-exported"},{"id":78,"kind":64,"name":"testInteractive","url":"globals.html#testinteractive","classes":"tsd-kind-function tsd-is-not-exported"},{"id":79,"kind":64,"name":"sandboxTasks","url":"globals.html#sandboxtasks","classes":"tsd-kind-function tsd-is-not-exported"},{"id":80,"kind":2097152,"name":"sandboxOptions","url":"globals.html#sandboxoptions","classes":"tsd-kind-object-literal tsd-is-not-exported"},{"id":81,"kind":32,"name":"description","url":"globals.html#sandboxoptions.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":82,"kind":32,"name":"githubUsername","url":"globals.html#sandboxoptions.githubusername","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":83,"kind":32,"name":"repoURL","url":"globals.html#sandboxoptions.repourl","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":84,"kind":32,"name":"workingDirectory","url":"globals.html#sandboxoptions.workingdirectory","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":85,"kind":64,"name":"silenceConsole","url":"globals.html#silenceconsole","classes":"tsd-kind-function tsd-is-not-exported"},{"id":86,"kind":64,"name":"passUpdateNotifier","url":"globals.html#passupdatenotifier","classes":"tsd-kind-function tsd-is-not-exported"},{"id":87,"kind":64,"name":"mockErr","url":"globals.html#mockerr","classes":"tsd-kind-function tsd-is-not-exported"},{"id":88,"kind":64,"name":"asyncABC","url":"globals.html#asyncabc","classes":"tsd-kind-function"},{"id":89,"kind":64,"name":"sha256","url":"globals.html#sha256","classes":"tsd-kind-function"},{"id":90,"kind":64,"name":"sha256Native","url":"globals.html#sha256native","classes":"tsd-kind-function"},{"id":91,"kind":64,"name":"double","url":"globals.html#double","classes":"tsd-kind-function"},{"id":92,"kind":64,"name":"power","url":"globals.html#power","classes":"tsd-kind-function"},{"id":93,"kind":64,"name":"hash","url":"globals.html#hash","classes":"tsd-kind-function tsd-is-not-exported"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","256":"Interface","1024":"Property","65536":"Type literal","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":4,"name":"Runner","url":"enums/runner.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"Npm","url":"enums/runner.html#npm","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Runner"},{"id":2,"kind":16,"name":"Yarn","url":"enums/runner.html#yarn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Runner"},{"id":3,"kind":256,"name":"TypescriptStarterCLIOptions","url":"interfaces/typescriptstarterclioptions.html","classes":"tsd-kind-interface"},{"id":4,"kind":1024,"name":"description","url":"interfaces/typescriptstarterclioptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":5,"kind":1024,"name":"domDefinitions","url":"interfaces/typescriptstarterclioptions.html#domdefinitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":6,"kind":1024,"name":"immutable","url":"interfaces/typescriptstarterclioptions.html#immutable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":7,"kind":1024,"name":"install","url":"interfaces/typescriptstarterclioptions.html#install","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":8,"kind":1024,"name":"nodeDefinitions","url":"interfaces/typescriptstarterclioptions.html#nodedefinitions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":9,"kind":1024,"name":"projectName","url":"interfaces/typescriptstarterclioptions.html#projectname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":10,"kind":1024,"name":"runner","url":"interfaces/typescriptstarterclioptions.html#runner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":11,"kind":1024,"name":"strict","url":"interfaces/typescriptstarterclioptions.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":12,"kind":1024,"name":"vscode","url":"interfaces/typescriptstarterclioptions.html#vscode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterCLIOptions"},{"id":13,"kind":256,"name":"TypescriptStarterRequiredConfig","url":"interfaces/typescriptstarterrequiredconfig.html","classes":"tsd-kind-interface"},{"id":14,"kind":1024,"name":"starterVersion","url":"interfaces/typescriptstarterrequiredconfig.html#starterversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterRequiredConfig"},{"id":15,"kind":1024,"name":"install","url":"interfaces/typescriptstarterrequiredconfig.html#install","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterRequiredConfig"},{"id":16,"kind":256,"name":"TypescriptStarterInferredOptions","url":"interfaces/typescriptstarterinferredoptions.html","classes":"tsd-kind-interface"},{"id":17,"kind":1024,"name":"githubUsername","url":"interfaces/typescriptstarterinferredoptions.html#githubusername","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":18,"kind":1024,"name":"fullName","url":"interfaces/typescriptstarterinferredoptions.html#fullname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":19,"kind":1024,"name":"email","url":"interfaces/typescriptstarterinferredoptions.html#email","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":20,"kind":1024,"name":"repoInfo","url":"interfaces/typescriptstarterinferredoptions.html#repoinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":21,"kind":65536,"name":"__type","url":"interfaces/typescriptstarterinferredoptions.html#repoinfo.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"TypescriptStarterInferredOptions.repoInfo"},{"id":22,"kind":32,"name":"repo","url":"interfaces/typescriptstarterinferredoptions.html#repoinfo.__type.repo","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"TypescriptStarterInferredOptions.repoInfo.__type"},{"id":23,"kind":32,"name":"branch","url":"interfaces/typescriptstarterinferredoptions.html#repoinfo.__type.branch","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"TypescriptStarterInferredOptions.repoInfo.__type"},{"id":24,"kind":1024,"name":"workingDirectory","url":"interfaces/typescriptstarterinferredoptions.html#workingdirectory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TypescriptStarterInferredOptions"},{"id":25,"kind":256,"name":"TypescriptStarterOptions","url":"interfaces/typescriptstarteroptions.html","classes":"tsd-kind-interface"},{"id":26,"kind":1024,"name":"description","url":"interfaces/typescriptstarteroptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":27,"kind":1024,"name":"domDefinitions","url":"interfaces/typescriptstarteroptions.html#domdefinitions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":28,"kind":1024,"name":"immutable","url":"interfaces/typescriptstarteroptions.html#immutable","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":29,"kind":1024,"name":"install","url":"interfaces/typescriptstarteroptions.html#install","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":30,"kind":1024,"name":"nodeDefinitions","url":"interfaces/typescriptstarteroptions.html#nodedefinitions","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":31,"kind":1024,"name":"projectName","url":"interfaces/typescriptstarteroptions.html#projectname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":32,"kind":1024,"name":"runner","url":"interfaces/typescriptstarteroptions.html#runner","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":33,"kind":1024,"name":"strict","url":"interfaces/typescriptstarteroptions.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":34,"kind":1024,"name":"vscode","url":"interfaces/typescriptstarteroptions.html#vscode","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":35,"kind":1024,"name":"githubUsername","url":"interfaces/typescriptstarteroptions.html#githubusername","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":36,"kind":1024,"name":"fullName","url":"interfaces/typescriptstarteroptions.html#fullname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":37,"kind":1024,"name":"email","url":"interfaces/typescriptstarteroptions.html#email","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":38,"kind":1024,"name":"repoInfo","url":"interfaces/typescriptstarteroptions.html#repoinfo","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":39,"kind":65536,"name":"__type","url":"interfaces/typescriptstarteroptions.html#repoinfo.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"TypescriptStarterOptions.repoInfo"},{"id":40,"kind":32,"name":"repo","url":"interfaces/typescriptstarteroptions.html#repoinfo.__type.repo","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"TypescriptStarterOptions.repoInfo.__type"},{"id":41,"kind":32,"name":"branch","url":"interfaces/typescriptstarteroptions.html#repoinfo.__type.branch","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"TypescriptStarterOptions.repoInfo.__type"},{"id":42,"kind":1024,"name":"workingDirectory","url":"interfaces/typescriptstarteroptions.html#workingdirectory","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TypescriptStarterOptions"},{"id":43,"kind":4194304,"name":"TypescriptStarterUserOptions","url":"globals.html#typescriptstarteruseroptions","classes":"tsd-kind-type-alias"},{"id":44,"kind":4194304,"name":"TypescriptStarterArgsOptions","url":"globals.html#typescriptstarterargsoptions","classes":"tsd-kind-type-alias"},{"id":45,"kind":64,"name":"hasCLIOptions","url":"globals.html#hasclioptions","classes":"tsd-kind-function"},{"id":46,"kind":64,"name":"validateName","url":"globals.html#validatename","classes":"tsd-kind-function"},{"id":47,"kind":64,"name":"getIntro","url":"globals.html#getintro","classes":"tsd-kind-function"},{"id":48,"kind":64,"name":"checkArgs","url":"globals.html#checkargs","classes":"tsd-kind-function"},{"id":49,"kind":64,"name":"inquire","url":"globals.html#inquire","classes":"tsd-kind-function"},{"id":50,"kind":4,"name":"Placeholders","url":"enums/placeholders.html","classes":"tsd-kind-enum"},{"id":51,"kind":16,"name":"email","url":"enums/placeholders.html#email","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":52,"kind":16,"name":"name","url":"enums/placeholders.html#name","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":53,"kind":16,"name":"username","url":"enums/placeholders.html#username","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Placeholders"},{"id":54,"kind":256,"name":"Tasks","url":"interfaces/tasks.html","classes":"tsd-kind-interface"},{"id":55,"kind":1024,"name":"cloneRepo","url":"interfaces/tasks.html#clonerepo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":56,"kind":65536,"name":"__type","url":"interfaces/tasks.html#clonerepo.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.cloneRepo"},{"id":57,"kind":1024,"name":"initialCommit","url":"interfaces/tasks.html#initialcommit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":58,"kind":65536,"name":"__type","url":"interfaces/tasks.html#initialcommit.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.initialCommit"},{"id":59,"kind":1024,"name":"install","url":"interfaces/tasks.html#install","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Tasks"},{"id":60,"kind":65536,"name":"__type","url":"interfaces/tasks.html#install.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"Tasks.install"},{"id":61,"kind":32,"name":"inherit","url":"globals.html#inherit","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":62,"kind":64,"name":"cloneRepo","url":"globals.html#clonerepo","classes":"tsd-kind-function"},{"id":63,"kind":64,"name":"getGithubUsername","url":"globals.html#getgithubusername","classes":"tsd-kind-function"},{"id":64,"kind":64,"name":"getUserInfo","url":"globals.html#getuserinfo","classes":"tsd-kind-function"},{"id":65,"kind":64,"name":"initialCommit","url":"globals.html#initialcommit","classes":"tsd-kind-function"},{"id":66,"kind":64,"name":"install","url":"globals.html#install","classes":"tsd-kind-function"},{"id":67,"kind":64,"name":"getRepoInfo","url":"globals.html#getrepoinfo","classes":"tsd-kind-function"},{"id":68,"kind":2097152,"name":"LiveTasks","url":"globals.html#livetasks","classes":"tsd-kind-object-literal"},{"id":69,"kind":32,"name":"cloneRepo","url":"globals.html#livetasks.clonerepo","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":70,"kind":32,"name":"initialCommit","url":"globals.html#livetasks.initialcommit","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":71,"kind":32,"name":"install","url":"globals.html#livetasks.install","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"LiveTasks"},{"id":72,"kind":64,"name":"addInferredOptions","url":"globals.html#addinferredoptions","classes":"tsd-kind-function"},{"id":73,"kind":64,"name":"typescriptStarter","url":"globals.html#typescriptstarter","classes":"tsd-kind-function"},{"id":74,"kind":64,"name":"readPackageJson","url":"globals.html#readpackagejson","classes":"tsd-kind-function tsd-is-not-exported"},{"id":75,"kind":64,"name":"writePackageJson","url":"globals.html#writepackagejson","classes":"tsd-kind-function tsd-is-not-exported"},{"id":76,"kind":4,"name":"TestDirectories","url":"enums/testdirectories.html","classes":"tsd-kind-enum tsd-is-not-exported"},{"id":77,"kind":16,"name":"one","url":"enums/testdirectories.html#one","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":78,"kind":16,"name":"two","url":"enums/testdirectories.html#two","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":79,"kind":16,"name":"three","url":"enums/testdirectories.html#three","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":80,"kind":16,"name":"four","url":"enums/testdirectories.html#four","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":81,"kind":16,"name":"five","url":"enums/testdirectories.html#five","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":82,"kind":16,"name":"six","url":"enums/testdirectories.html#six","classes":"tsd-kind-enum-member tsd-parent-kind-enum tsd-is-not-exported","parent":"TestDirectories"},{"id":83,"kind":32,"name":"branch","url":"globals.html#branch","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":84,"kind":2097152,"name":"repoInfo","url":"globals.html#repoinfo","classes":"tsd-kind-object-literal tsd-is-not-exported"},{"id":85,"kind":32,"name":"repo","url":"globals.html#repoinfo.repo","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"repoInfo"},{"id":86,"kind":32,"name":"branch","url":"globals.html#repoinfo.branch","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"repoInfo"},{"id":87,"kind":32,"name":"buildDir","url":"globals.html#builddir","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":88,"kind":2097152,"name":"env","url":"globals.html#env","classes":"tsd-kind-object-literal tsd-is-not-exported"},{"id":89,"kind":32,"name":"TYPESCRIPT_STARTER_REPO_BRANCH","url":"globals.html#env.typescript_starter_repo_branch","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"env"},{"id":90,"kind":32,"name":"TYPESCRIPT_STARTER_REPO_URL","url":"globals.html#env.typescript_starter_repo_url","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"env"},{"id":91,"kind":64,"name":"hashAllTheThings","url":"globals.html#hashallthethings","classes":"tsd-kind-function tsd-is-not-exported"},{"id":92,"kind":32,"name":"down","url":"globals.html#down","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":93,"kind":32,"name":"up","url":"globals.html#up","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":94,"kind":32,"name":"enter","url":"globals.html#enter","classes":"tsd-kind-variable tsd-is-not-exported"},{"id":95,"kind":64,"name":"ms","url":"globals.html#ms","classes":"tsd-kind-function tsd-is-not-exported"},{"id":96,"kind":64,"name":"testInteractive","url":"globals.html#testinteractive","classes":"tsd-kind-function tsd-is-not-exported"},{"id":97,"kind":64,"name":"sandboxTasks","url":"globals.html#sandboxtasks","classes":"tsd-kind-function tsd-is-not-exported"},{"id":98,"kind":2097152,"name":"sandboxOptions","url":"globals.html#sandboxoptions","classes":"tsd-kind-object-literal tsd-is-not-exported"},{"id":99,"kind":32,"name":"description","url":"globals.html#sandboxoptions.description","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":100,"kind":32,"name":"githubUsername","url":"globals.html#sandboxoptions.githubusername","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":101,"kind":32,"name":"repoInfo","url":"globals.html#sandboxoptions.repoinfo","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":102,"kind":65536,"name":"__type","url":"globals.html#sandboxoptions.repoinfo.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"sandboxOptions.repoInfo"},{"id":103,"kind":32,"name":"repo","url":"globals.html#sandboxoptions.repoinfo.__type.repo","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"sandboxOptions.repoInfo.__type"},{"id":104,"kind":32,"name":"branch","url":"globals.html#sandboxoptions.repoinfo.__type.branch","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"sandboxOptions.repoInfo.__type"},{"id":105,"kind":32,"name":"workingDirectory","url":"globals.html#sandboxoptions.workingdirectory","classes":"tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported","parent":"sandboxOptions"},{"id":106,"kind":64,"name":"silenceConsole","url":"globals.html#silenceconsole","classes":"tsd-kind-function tsd-is-not-exported"},{"id":107,"kind":64,"name":"pretendLatestVersionIs","url":"globals.html#pretendlatestversionis","classes":"tsd-kind-function tsd-is-not-exported"},{"id":108,"kind":64,"name":"mockErr","url":"globals.html#mockerr","classes":"tsd-kind-function tsd-is-not-exported"},{"id":109,"kind":64,"name":"asyncABC","url":"globals.html#asyncabc","classes":"tsd-kind-function"},{"id":110,"kind":64,"name":"sha256","url":"globals.html#sha256","classes":"tsd-kind-function"},{"id":111,"kind":64,"name":"sha256Native","url":"globals.html#sha256native","classes":"tsd-kind-function"},{"id":112,"kind":64,"name":"double","url":"globals.html#double","classes":"tsd-kind-function"},{"id":113,"kind":64,"name":"power","url":"globals.html#power","classes":"tsd-kind-function"},{"id":114,"kind":64,"name":"hash","url":"globals.html#hash","classes":"tsd-kind-function tsd-is-not-exported"}]}; \ No newline at end of file diff --git a/enums/placeholders.html b/enums/placeholders.html index d8c931e..f32d939 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 3612406..b8ec496 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 4c33ea5..eed03c1 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 efbb833..53cd948 100644 --- a/globals.html +++ b/globals.html @@ -79,34 +79,43 @@

Interfaces

+ +
+

Type aliases

+

Variables

Functions

+
+

Type aliases

+
+ +

TypescriptStarterArgsOptions

+
TypescriptStarterArgsOptions: TypescriptStarterUserOptions | TypescriptStarterRequiredConfig
+ +
+
+ +

TypescriptStarterUserOptions

+
TypescriptStarterUserOptions: TypescriptStarterCLIOptions & TypescriptStarterRequiredConfig
+ +
+

Variables

- -

Const buildDir

-
buildDir: string = join(process.cwd(), 'build')
+ +

Const branch

+
branch: string = execa.sync('git', ['rev-parse','--symbolic-full-name','--abbrev-ref','HEAD']).stdout
-
-
- -

Const down

-
down: "" = ""
- -
-
- -

Const enter

-
enter: " - " = " - "
- -
-
- -

Const inherit

-
inherit: undefined | null | number | "pipe" | "ipc" | "ignore" | Stream = 'inherit' as StdIOOption
- -
-
- -

Const repoURL

-
repoURL: string = process.cwd()
-
@@ -199,19 +191,84 @@ directory for easier clean up.

+
+ +

Const buildDir

+
buildDir: string = join(process.cwd(), 'build')
+ +
+
+ +

Const down

+
down: "" = ""
+ +
+
+ +

Const enter

+
enter: " + " = " + "
+ +
+
+ +

Const inherit

+
inherit: undefined | null | number | "pipe" | "ipc" | "ignore" | Stream = 'inherit' as StdIOOption
+ +

Const up

up: "" = ""

Functions

+
+ +

Const addInferredOptions

+ + +

asyncABC

@@ -222,7 +279,7 @@
  • @@ -249,16 +306,16 @@ asyncABC().then(console.log);

    checkArgs

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

  • Parameters

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

  • Parameters

    @@ -358,23 +415,6 @@ asyncABC().then(console.log);
    • -
    - -

    Const getInferredOptions

    - - -

    getIntro

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

  • Parameters

    @@ -399,19 +439,46 @@ asyncABC().then(console.log);
    • - -

    Const getRepoUrl

    + +

    Const getRepoInfo

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

  • Parameters

    @@ -438,6 +505,29 @@ asyncABC().then(console.log);
    • +
    + +

    hasCLIOptions

    + + +

    Const hash

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

  • Parameters

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

  • Parameters

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

  • Parameters

    @@ -520,16 +610,16 @@ asyncABC().then(console.log);

    inquire

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

  • Parameters

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

  • Parameters

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

  • Parameters

    @@ -602,29 +692,6 @@ asyncABC().then(console.log);
    • -
    - -

    Const passUpdateNotifier

    - - -

    power

    @@ -635,7 +702,7 @@ asyncABC().then(console.log);
  • @@ -666,6 +733,29 @@ asyncABC().then(console.log);
    • +
    + +

    Const pretendLatestVersionIs

    + + +

    Const readPackageJson

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

  • Parameters

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

  • Parameters

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

  • Parameters

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

  • Parameters

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

  • Parameters

    @@ -884,7 +974,15 @@ sha256('test')
    projectName: string
  • -
    repoURL: string
    +
    repoInfo: object
    +
  • runner: Runner
    @@ -918,7 +1016,7 @@ sha256('test')

  • Parameters

    @@ -944,7 +1042,7 @@ sha256('test')

  • Parameters

    @@ -969,7 +1067,7 @@ sha256('test')
    LiveTasks: object
    @@ -978,7 +1076,7 @@ sha256('test')
    cloneRepo: (Anonymous function) = cloneRepo(execa)
    @@ -988,7 +1086,7 @@ sha256('test')
    initialCommit: (Anonymous function) = initialCommit(execa)
    • @@ -998,7 +1096,67 @@ sha256('test')
    install: (Anonymous function) = install(execa)
    + + +
    + +

    Const env

    +
    env: object
    + +
    + +

    TYPESCRIPT_STARTER_REPO_BRANCH

    +
    TYPESCRIPT_STARTER_REPO_BRANCH: string = repoInfo.branch
    + +
    +
    + +

    TYPESCRIPT_STARTER_REPO_URL

    +
    TYPESCRIPT_STARTER_REPO_URL: string = repoInfo.repo
    + +
    +
    +
    + +

    Const repoInfo

    +
    repoInfo: object
    + +
    + +

    branch

    +
    branch: string
    + +
    +
    + +

    repo

    +
    repo: string = process.cwd()
    +
    @@ -1009,7 +1167,7 @@ sha256('test')
    sandboxOptions: object
    @@ -1018,7 +1176,7 @@ sha256('test')
    description: string = "this is an example description"
    @@ -1028,19 +1186,30 @@ sha256('test')
    githubUsername: string = "SOME_GITHUB_USERNAME"
    - -

    repoURL

    -
    repoURL: string
    + +

    repoInfo

    +
    repoInfo: object
    +
    +

    Type declaration

    + +
    @@ -1048,7 +1217,7 @@ sha256('test')
    workingDirectory: string = buildDir
    @@ -1077,6 +1246,9 @@ sha256('test')
  • Tasks
    • +
  • + TypescriptStarterCLIOptions +
  • TypescriptStarterInferredOptions
    • @@ -1084,7 +1256,16 @@ sha256('test') TypescriptStarterOptions
  • - TypescriptStarterUserOptions + TypescriptStarterRequiredConfig +
    • +
  • + TypescriptStarterArgsOptions +
    • +
  • + TypescriptStarterUserOptions +
    • +
  • + branch
  • buildDir @@ -1098,12 +1279,12 @@ sha256('test')
  • inherit
    • -
  • - repoURL -
  • up
    • +
  • + addInferredOptions +
  • asyncABC
    • @@ -1119,18 +1300,18 @@ sha256('test')
  • getGithubUsername
    • -
  • - getInferredOptions -
  • getIntro
  • - getRepoUrl + getRepoInfo
  • getUserInfo
    • +
  • + hasCLIOptions +
  • hash
    • @@ -1152,12 +1333,12 @@ sha256('test')
  • ms
    • -
  • - passUpdateNotifier -
  • power
    • +
  • + pretendLatestVersionIs +
  • readPackageJson
    • @@ -1188,6 +1369,12 @@ sha256('test')
  • LiveTasks
    • +
  • + env +
    • +
  • + repoInfo +
  • sandboxOptions
    • diff --git a/index.html b/index.html index 5a160fd..4473c8c 100644 --- a/index.html +++ b/index.html @@ -158,6 +158,7 @@ git cz 
    # bump package.json version, update CHANGELOG.md, git tag the release
 npm run changelog
    +

    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:
@@ -281,9 +282,10 @@ npm link
 				
    mkdir typescript-starter-testing
 cd typescript-starter-testing
 TYPESCRIPT_STARTER_REPO_URL='/local/path/to/typescript-starter' typescript-starter
-
    You can also TYPESCRIPT_STARTER_REPO_URL to any valid Git URL, such as your fork of this repo:
    
+

    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 you're using VS Code, the Debug CLI launch configuration also allows you to immediately build and step through execution of the CLI.

    +

    If TYPESCRIPT_STARTER_REPO_BRANCH is not provided, it will default to master.

    +

    If you're using VS Code, the Debug CLI launch configuration also allows you to immediately build and step through execution of the CLI.

    In the wild

    You can find more advanced configurations, usage examples, and inspiration from other projects using typescript-starter: