feat: replace projectName with serviceName for consistency

dkundel · dkundel · commit c4f955abae49 · 2019-07-09T20:20:07.000-07:00
The term "project" is being used a lot in the Twilio CLI and causes a lot of confusion BREAKING CHANGE: projectName is no longer valid and serviceName has to be used instead fix twilio-labs/serverless-toolkit#17
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 ## ⚠️ **IMPORTANT**
 
-This is a module for an experimental API that is still in preview mode. 
+This is a module for an experimental API that is still in preview mode.
 
 You won't be able to use this library unless you have been granted prior access to the underlying API.
 
@@ -40,7 +40,7 @@ const TwilioServerlessApiClient = require('@twilio-labs/serverless-api');
 
 const client = new TwilioServerlessApiClient({
   accountSid: '...',
-  authToken: '...'
+  authToken: '...',
 });
 
 client.on('status-update', evt => {
@@ -52,12 +52,12 @@ const result = await client.deployLocalProject({
   envPath: '...',
   accountSid: '...',
   authToken: '...',
-  env: {  },
+  env: {},
   pkgJson: {},
-  projectName: 'serverless-example',
+  serviceName: 'serverless-example',
   functionsEnv: 'dev',
   assetsFolderName: 'static',
-  functionsFolderName: 'src'
+  functionsFolderName: 'src',
 });
 ```
 
@@ -87,9 +87,9 @@ Nested folder structures will result in nested routes.
 
 Deploys a set of functions, assets, variables and dependencies specified in deployConfig. Functions & assets can either be paths to the local filesystem or Buffer instances allowing you to dynamically upload even without a file system.
 
-Unless a deployConfig. serviceSid is specified, it will try to create one. If a service with the name deployConfig.projectName already exists, it will throw an error. You can make it use the existing service by setting overrideExistingService to true.
+Unless a deployConfig. serviceSid is specified, it will try to create one. If a service with the name deployConfig.serviceName already exists, it will throw an error. You can make it use the existing service by setting overrideExistingService to true.
 
-Updates to the deployment will be emitted as events to status-update. 
+Updates to the deployment will be emitted as events to status-update.
 
 [More in the Docs](https://serverless-api.twilio-labs.com/classes/_twilio_labs_serverless_api.twilioserverlessapiclient.html#deployproject)
 
@@ -119,7 +119,7 @@ const api = require('@twilio-labs/serverless-api/dist/api');
 const utils = require('@twilio-labs/serverless-api/dist/utils');
 ```
 
-##  Contributing
+## Contributing
 
 This project welcomes contributions from the community. Please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more details.
 
@@ -145,4 +145,4 @@ This project follows the [all-contributors](https://github.com/all-contributors/
 
 ## License
 
-MIT
+MIT
diff --git a/src/api/services.ts b/src/api/services.ts
@@ -6,23 +6,23 @@ import { GotClient, ServiceList, ServiceResource } from '../types';
 const log = debug('twilio-serverless-api:services');
 
 /**
- * Creates a new service given a project name
+ * Creates a new service given a service name
  *
  * @export
- * @param {string} projectName the unique name for the service
+ * @param {string} serviceName the unique name for the service
  * @param {GotClient} client API client
  * @returns {Promise<string>}
  */
 export async function createService(
-  projectName: string,
+  serviceName: string,
   client: GotClient
 ): Promise<string> {
   try {
     const resp = await client.post('/Services', {
       form: true,
       body: {
-        UniqueName: projectName,
-        FriendlyName: projectName,
+        UniqueName: serviceName,
+        FriendlyName: serviceName,
         IncludeCrendentials: true,
       },
     });
@@ -51,7 +51,7 @@ export async function listServices(
 }
 
 /**
- * Tries to find the service SID associated to a project name
+ * Tries to find the service SID associated to a service name
  *
  * @export
  * @param {string} uniqueName the unique name of the service
diff --git a/src/client.ts b/src/client.ts
@@ -99,7 +99,7 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
     let {
       types,
       serviceSid,
-      projectName,
+      serviceName: serviceName,
       environment: environmentSid,
     } = listConfig;
 
@@ -113,9 +113,9 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
 
     if (
       typeof serviceSid === 'undefined' &&
-      typeof projectName !== 'undefined'
+      typeof serviceName !== 'undefined'
     ) {
-      serviceSid = await findServiceSid(projectName, this.client);
+      serviceSid = await findServiceSid(serviceName, this.client);
     }
 
     if (typeof serviceSid === 'undefined') {
@@ -278,7 +278,7 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
    * even without a file system.
    *
    * Unless a `deployConfig. serviceSid` is specified, it will try to create one. If a service
-   * with the name `deployConfig.projectName` already exists, it will throw
+   * with the name `deployConfig.serviceName` already exists, it will throw
    * an error. You can make it use the existing service by setting `overrideExistingService` to
    * true.
    *
@@ -309,10 +309,10 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
         message: 'Creating Service',
       });
       try {
-        serviceSid = await createService(config.projectName, this.client);
+        serviceSid = await createService(config.serviceName, this.client);
       } catch (err) {
         const alternativeServiceSid = await findServiceSid(
-          config.projectName,
+          config.serviceName,
           this.client
         );
         if (!alternativeServiceSid) {
@@ -322,16 +322,14 @@ export class TwilioServerlessApiClient extends events.EventEmitter {
           serviceSid = alternativeServiceSid;
         } else {
           const error = new Error(
-            `Project with name "${
-              config.projectName
-            }" already exists with SID "${alternativeServiceSid}".`
+            `Service with name "${config.serviceName}" already exists with SID "${alternativeServiceSid}".`
           );
           error.name = 'conflicting-servicename';
           Object.defineProperty(err, 'serviceSid', {
             value: alternativeServiceSid,
           });
-          Object.defineProperty(err, 'projectName', {
-            value: config.projectName,
+          Object.defineProperty(err, 'serviceName', {
+            value: config.serviceName,
           });
           throw error;
         }
diff --git a/src/types/deploy.ts b/src/types/deploy.ts
@@ -28,9 +28,9 @@ type DeployProjectConfigBase = {
    */
   pkgJson: PackageJson;
   /**
-   * Project name, used as `UniqueName` for Serverless Service.
+   * Name, used as `UniqueName` for Serverless Service.
    */
-  projectName: string;
+  serviceName: string;
   /**
    * Name of Functions environment to deploy to. Will be used as domain suffix and `${value}-environment` for `UniqueName`
    */
@@ -40,7 +40,7 @@ type DeployProjectConfigBase = {
    */
   force?: boolean;
   /**
-   * If no `serviceSid` is specified but a service with `projectName` is found, it will deploy to that one.
+   * If no `serviceSid` is specified but a service with `serviceName` is found, it will deploy to that one.
    */
   overrideExistingService?: boolean;
 };
diff --git a/src/types/list.ts b/src/types/list.ts
@@ -35,9 +35,9 @@ export type ListConfig = ClientConfig & {
    */
   serviceSid?: string;
   /**
-   * Project namee as alternative to `serviceSid`
+   * Service name as alternative to `serviceSid`
    */
-  projectName?: string;
+  serviceName?: string;
   /**
    * Environment SID or domain suffix. Required to list variables, functions and assets
    */
