Merge pull request #21 from contentstack/fix/DX-4900

fix: Typos and message fixes

Author: cs-raj

packages/contentstack-audit/src/audit-base-command.ts

@@ -672,7 +672,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       | 'Summary',
     listOfMissingRefs: Record<string, any>,
   ): Promise<void> {
-    if (Object.keys(config.moduleConfig).includes(moduleName) || config.feild_level_modules.includes(moduleName)) {
+    if (Object.keys(config.moduleConfig).includes(moduleName) || config.field_level_modules.includes(moduleName)) {
       const csvPath = join(sanitizePath(this.sharedConfig.reportPath), `${sanitizePath(moduleName)}.csv`);
       return new Promise<void>((resolve, reject) => {
         // file deepcode ignore MissingClose: Will auto close once csv stream end

packages/contentstack-audit/src/config/index.ts

@@ -130,7 +130,7 @@ const config = {
     Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details',
     Entry_Multiple_Fields: 'Entry_Multiple_Fields',
   },
-  feild_level_modules: [
+  field_level_modules: [
     'Entries_Title_field',
     'Entries_Mandatory_field',
     'Entries_Select_field',

packages/contentstack-audit/src/messages/index.ts

@@ -18,8 +18,8 @@ const commonMsg = {
   WORKFLOW_FIX_CONFIRMATION: 'Would you like to overwrite existing file?',
   EXTENSION_FIX_WARN: `The extension associated with UID {uid} and title '{title}' will be removed.`,
   EXTENSION_FIX_CONFIRMATION: `Would you like to overwrite existing file?`,
-  WF_BRANCH_REMOVAL: `Removing the branch '{branch} from workflow with UID {uid} and name {name} will be removed.'`,
-  CR_BRANCH_REMOVAL: `Removing the branch '{branch} from custom role with UID {uid} and name {name} will be removed.'`,
+  WF_BRANCH_REMOVAL: `Removing the branch '{branch}' from workflow with UID {uid} and name {name}.`,
+  CR_BRANCH_REMOVAL: `Removing the branch '{branch}' from custom role with UID {uid} and name {name}.`,
   SHOW_CONSOLE_OUTPUT: `Display the audit and audit fix result for individual modules`,
 };
 
@@ -41,7 +41,7 @@ const auditMsg = {
   SCAN_CS_SUCCESS_MSG: 'Successfully completed the scanning of studio project with UID {uid} and name {name}.',
   SCAN_ASSET_SUCCESS_MSG: `Successfully completed the scanning of Asset with UID '{uid}'.`,
   SCAN_ASSET_WARN_MSG: `The locale '{locale}' or environment '{environment}' are not present for asset with uid '{uid}'`,
-  ENTRY_PUBLISH_DETAILS: `Removing the publish detials for entry '{uid}' of ct '{ctuid}' in locale '{locale}' as locale '{publocale}' or environment '{environment}' does not exist`,
+  ENTRY_PUBLISH_DETAILS: `Removing the publish details for entry '{uid}' of ct '{ctuid}' in locale '{locale}' as locale '{publocale}' or environment '{environment}' does not exist`,
   CT_REFERENCE_FIELD: `The mentioned Reference field is not Array field reference is '{reference_to}' having display name '{display_name}''`,
   ASSET_NOT_EXIST: `The publish_details either does not exist or is not an array for asset uid '{uid}'`,
   ENTRY_PUBLISH_DETAILS_NOT_EXIST: `The publish_details either does not exist or is not an array for entry uid '{uid}'`,
@@ -61,8 +61,8 @@ const auditFixMsg = {
   WF_FIX_MSG: 'Successfully removed the workflow {uid} named {name}.',
   ENTRY_MANDATORY_FIELD_FIX: `Removing the publish details from the entry with UID '{uid}' in Locale '{locale}'...`,
   ENTRY_SELECT_FIELD_FIX: `Adding the value '{value}' in the select field of entry UID '{uid}'...`,
-  ASSET_FIX: `Fixed publish detials for Asset with UID '{uid}'`,
-  FIELD_RULE_FIX_MESSAGE: `Fixed Field Rule '{num}' target of Content-type '{ctUid}`,
+  ASSET_FIX: `Fixed publish details for Asset with UID '{uid}'`,
+  FIELD_RULE_FIX_MESSAGE: `Fixed Field Rule '{num}' target of Content-type '{ctUid}'`,
 };
 
 const messages: typeof errors &

packages/contentstack-audit/src/modules/assets.ts

@@ -181,7 +181,7 @@ export default class Assets extends BaseClass {
   }
 
   /**
-   * This function traverse over the publish detials of the assets and remove the publish details where the locale or environment does not exist
+   * This function traverses over the publish details of the assets and removes the publish details where the locale or environment does not exist
    */
   async lookForReference(): Promise<void> {
     log.debug('Starting asset reference validation', this.config.auditContext);

packages/contentstack-audit/test/unit/messages/index.test.ts

@@ -1,7 +1,7 @@
 import { fancy } from 'fancy-test';
 import { expect } from 'chai';
 
-import { $t, auditMsg } from '../../../src/messages';
+import { $t, auditMsg, auditFixMsg } from '../../../src/messages';
 
 describe('messages utility', () => {
   describe('$t method', () => {
@@ -21,4 +21,13 @@ describe('messages utility', () => {
         expect($t('', {})).to.be.empty.string;
       });
   });
+
+  describe('typo regression: details not detials', () => {
+    it('ASSET_FIX and ENTRY_PUBLISH_DETAILS should contain "details"', () => {
+      expect(auditMsg.ENTRY_PUBLISH_DETAILS).to.include('details');
+      expect(auditMsg.ENTRY_PUBLISH_DETAILS).to.not.include('detials');
+      expect(auditFixMsg.ASSET_FIX).to.include('details');
+      expect(auditFixMsg.ASSET_FIX).to.not.include('detials');
+    });
+  });
 });