feat(validate): change terminology of validate commands to validate o…

…rg and validate pool Change the command usage of validate commands to validate org and validate pool
flxbl-io · Mar 6, 2024 · 24db5a3 · 24db5a3
1 parent b1090ca
commit 24db5a3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 15 deletions.
diff --git a/packages/sfp-cli/package.json b/packages/sfp-cli/package.json
@@ -112,6 +112,9 @@
             "pool": {
                 "description": "Build and manage scratch org or sandbox pools"
             },
+            "validate": {
+                "description": " Validate a change in your project repository"
+            },
             "changelog": {
                 "description": "Track your artifacts & user stories as they progress through different environments, with release changelogs"
             },
@@ -166,6 +169,7 @@
     },
     "scripts": {
         "build": "pnpm run clean && pnpm run compile",
+        "docs" : "oclif readme --no-aliases --multi --dir=docs --repository-prefix https://github.com/flxbl-io/sfp",
         "manifest": "oclif manifest",
         "clean": "rimraf ./lib && rimraf tsconfig.tsbuildinfo",
         "compile": "tsc -b tsconfig.json",

diff --git a/...fp-cli/src/commands/validateAgainstOrg.ts → ...ages/sfp-cli/src/commands/validate/org.ts b/...fp-cli/src/commands/validateAgainstOrg.ts → ...ages/sfp-cli/src/commands/validate/org.ts
@@ -1,20 +1,20 @@
 import { LoggerLevel, Messages, Org } from '@salesforce/core';
-import SfpCommand from '../SfpCommand';
-import ValidateImpl, { ValidateAgainst, ValidateProps, ValidationMode } from '../impl/validate/ValidateImpl';
-import SFPStatsSender from '../core/stats/SFPStatsSender';
+import SfpCommand from '../../SfpCommand';
+import ValidateImpl, { ValidateAgainst, ValidateProps, ValidationMode } from '../../impl/validate/ValidateImpl';
+import SFPStatsSender from '../../core/stats/SFPStatsSender';
 import SFPLogger, { COLOR_HEADER, COLOR_KEY_MESSAGE } from '@flxblio/sfp-logger';
 import * as fs from 'fs-extra';
-import ValidateError from '../errors/ValidateError';
-import ValidateResult from '../impl/validate/ValidateResult';
-import { arrayFlagSfdxStyle, loglevel, logsgroupsymbol, requiredUserNameFlag, targetdevhubusername } from '../flags/sfdxflags';
+import ValidateError from '../../errors/ValidateError';
+import ValidateResult from '../../impl/validate/ValidateResult';
+import { arrayFlagSfdxStyle, loglevel, logsgroupsymbol, requiredUserNameFlag, targetdevhubusername } from '../../flags/sfdxflags';
 import { Flags } from '@oclif/core';
 
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@flxblio/sfp', 'validateAgainstOrg');
 
 export default class ValidateAgainstOrg extends SfpCommand {
-    static aliases = ['orchestrator:validateagainstorg']
+    static aliases = ['orchestrator:validateagainstorg', 'validateagainstorg']
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [`$ sfp validateAgainstOrg -u <targetorg>`];

diff --git a/packages/sfp-cli/src/commands/validate.ts → ...ges/sfp-cli/src/commands/validate/pool.ts b/packages/sfp-cli/src/commands/validate.ts → ...ges/sfp-cli/src/commands/validate/pool.ts
@@ -1,20 +1,20 @@
 import { Messages } from '@salesforce/core';
-import SfpCommand from '../SfpCommand';
-import ValidateImpl, { ValidateAgainst, ValidateProps, ValidationMode } from '../impl/validate/ValidateImpl';
-import SFPStatsSender from '../core/stats/SFPStatsSender';
+import SfpCommand from '../../SfpCommand';
+import ValidateImpl, { ValidateAgainst, ValidateProps, ValidationMode } from '../../impl/validate/ValidateImpl';
+import SFPStatsSender from '../../core/stats/SFPStatsSender';
 import SFPLogger, { COLOR_HEADER, COLOR_KEY_MESSAGE } from '@flxblio/sfp-logger';
-import ValidateError from '../errors/ValidateError';
-import ValidateResult from '../impl/validate/ValidateResult';
+import ValidateError from '../../errors/ValidateError';
+import ValidateResult from '../../impl/validate/ValidateResult';
 import * as fs from 'fs-extra';
-import { arrayFlagSfdxStyle, loglevel, logsgroupsymbol, targetdevhubusername } from '../flags/sfdxflags';
+import { arrayFlagSfdxStyle, loglevel, logsgroupsymbol, targetdevhubusername } from '../../flags/sfdxflags';
 import { Flags } from '@oclif/core';
 import { LoggerLevel } from '@flxblio/sfp-logger';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@flxblio/sfp', 'validate');
 
-export default class Validate extends SfpCommand {
-    static aliases = ['orchestrator:validate']
+export default class ValidateAgainstPool extends SfpCommand {
+    static aliases = ['orchestrator:validate', 'validate']
     protected static requiresProject = true;
 
     public static description = messages.getMessage('commandDescription');