diff --git a/packages/sfp-cli/package.json b/packages/sfp-cli/package.json index 66a1c40d8..cd0a2d4c4 100644 --- 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/packages/sfp-cli/src/commands/validateAgainstOrg.ts b/packages/sfp-cli/src/commands/validate/org.ts similarity index 94% rename from packages/sfp-cli/src/commands/validateAgainstOrg.ts rename to packages/sfp-cli/src/commands/validate/org.ts index f957aba01..476a8a2f7 100644 --- a/packages/sfp-cli/src/commands/validateAgainstOrg.ts +++ b/packages/sfp-cli/src/commands/validate/org.ts @@ -1,12 +1,12 @@ 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'; @@ -14,7 +14,7 @@ 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 `]; diff --git a/packages/sfp-cli/src/commands/validate.ts b/packages/sfp-cli/src/commands/validate/pool.ts similarity index 95% rename from packages/sfp-cli/src/commands/validate.ts rename to packages/sfp-cli/src/commands/validate/pool.ts index f044f59e5..416170514 100644 --- a/packages/sfp-cli/src/commands/validate.ts +++ b/packages/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');