generator-team/generators/app/args.js

Generates an app with CI/CD in Team Foundation Server or Team Services

// Many of the generators use the same arguments in their constructors so 
// these functions make it easy to reuse in other generators.
// This removed a lot of duplicate code and makes sure argument names match
// in each generator.

const util = require(`./utility`);

function profileCmd(obj) {
   obj.argument(`profileCmd`, {
      required: false,
      desc: `Add, Delete or List`
   });
}

function profileName(obj) {
   obj.argument(`profileName`, {
      required: false,
      desc: `Name of the profile to store or load`
   });
}

function tfsVersion(obj) {
   obj.argument(`tfsVersion`, {
      required: false,
      desc: `API version to store in profile`
   });
}

function applicationType(obj) {
   obj.argument(`type`, {
      required: false,
      desc: `Project type to create (asp, node, java or aspFull)`
   });
}

function applicationName(obj) {
   obj.argument(`applicationName`, {
      required: false,
      desc: `Name of the application`
   });
}

function functionName(obj) {
   obj.argument(`functionName`, {
      required: false,
      desc: `Name of the function`
   });
}

function customFolder(obj) {
   obj.argument(`customFolder`, {
      required: false,
      desc: `Path to folder of build & release templates`
   });
}

function tfs(obj) {
   obj.argument(`tfs`, {
      required: false,
      desc: `Full TFS URL with collection, VSTS account or Profile`
   });
}

function azureSub(obj) {
   obj.argument(`azureSub`, {
      required: false,
      desc: `Azure Subscription name`
   });
}

function azureSubId(obj) {
   obj.argument(`azureSubId`, {
      required: false,
      desc: `Azure Subscription ID`
   });
}

function tenantId(obj) {
   obj.argument(`tenantId`, {
      required: false,
      desc: `Azure Tenant ID`
   });
}

function servicePrincipalId(obj) {
   obj.argument(`servicePrincipalId`, {
      required: false,
      desc: `Azure Service Principal Id`
   });
}

function queue(obj) {
   obj.argument(`queue`, {
      required: false,
      desc: `Agent queue to use`
   });
}

function target(obj) {
   obj.argument(`target`, {
      required: false,
      desc: `Docker or Azure app service`
   });
}

function installDep(obj) {
   obj.argument(`installDep`, {
      required: false,
      desc: `If true dependencies are installed`
   });
}

function groupId(obj) {
   obj.argument(`groupId`, {
      required: false,
      desc: `Group ID of Java project`
   });
}

function apiKey(obj) {
   obj.argument(`apiKey`, {
      required: false,
      desc: `apiKey for your NuGet feed`
   })
}

function dockerHost(obj) {
   obj.argument(`dockerHost`, {
      required: false,
      desc: `Docker host url including port`
   });
}

function dockerCertPath(obj) {
   obj.argument(`dockerCertPath`, {
      required: false,
      desc: `Path to Docker certs folder`
   });
}

function dockerRegistry(obj) {
   obj.argument(`dockerRegistry`, {
      required: false,
      desc: `Server of your Docker registry`
   });
}

function dockerRegistryId(obj) {
   obj.argument(`dockerRegistryId`, {
      required: false,
      desc: `Username for Docker registry`
   });
}

function dockerPorts(obj) {
   obj.argument(`dockerPorts`, {
      required: false,
      desc: `Port mapping for container and host`
   });
}

function dockerRegistryPassword(obj) {
   obj.argument(`dockerRegistryPassword`, {
      required: false,
      desc: `Password for your Docker registry`
   });
}

function servicePrincipalKey(obj) {
   obj.argument(`servicePrincipalKey`, {
      required: false,
      desc: `Azure Service Principal Key`
   });
}

function pat(obj) {
   obj.argument(`pat`, {
      required: false,
      desc: `Personal Access Token to TFS/VSTS`
   });
}

function gitAction(obj) {
   obj.argument(`action`, {
      required: false,
      desc: `Git action to take`
   });
}

function imagePullSecret(obj) {
   obj.argument(`imagePullSecret`, {
      required: false,
      desc: `Kubernetes Secret name to pull from`
   });
}

function clusterName(obj) {
   obj.argument(`clusterName`, {
      required: false,
      desc: `Kubernetes cluster name`
   });
}

function clusterResourceGroup(obj) {
   obj.argument(`clusterResourceGroup`, {
      required: false,
      desc: `Kubernetes cluster resource group name`
   });
}

module.exports = {
   tfs: tfs,
   pat: pat,
   queue: queue,
   apiKey: apiKey,
   target: target,
   groupId: groupId,
   azureSub: azureSub,
   tenantId: tenantId,
   gitAction: gitAction,
   profileCmd: profileCmd,
   profileName: profileName,
   tfsVersion: tfsVersion,
   azureSubId: azureSubId,
   installDep: installDep,
   dockerHost: dockerHost,
   dockerPorts: dockerPorts,
   clusterName: clusterName,
   customFolder: customFolder,
   functionName: functionName,
   dockerCertPath: dockerCertPath,
   dockerRegistry: dockerRegistry,
   applicationType: applicationType,
   applicationName: applicationName,
   imagePullSecret: imagePullSecret,
   dockerRegistryId: dockerRegistryId,
   servicePrincipalId: servicePrincipalId,
   servicePrincipalKey: servicePrincipalKey,
   clusterResourceGroup: clusterResourceGroup,
   dockerRegistryPassword: dockerRegistryPassword,
};