Skip to content

Commit

Permalink
feat: update JSON for alias commands
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdonnalley
mdonnalley committed Feb 10, 2023
1 parent 1ecddf5 commit d7f1e3b
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 229 deletions.
77 changes: 4 additions & 73 deletions schemas/alias-list.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,90 +24,21 @@
"type": "string"
},
"error": {
"$ref": "#/definitions/SfError"
}
},
"required": ["alias"],
"additionalProperties": false
},
"SfError": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
},
"cause": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1501530572-0-211-1501530572-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action messages. Hints to the users regarding what can be done to fix related issues."
},
"exitCode": {
"type": "number",
"description": "SfdxCommand can return this process exit code."
},
"context": {
"type": "string",
"description": "The related context for this error."
},
"data": {}
},
"required": ["exitCode", "message", "name"],
"additionalProperties": false,
"description": "A generalized sfdx error which also contains an action. The action is used in the CLI to help guide users past the error.\n\nTo throw an error in a synchronous function you must either pass the error message and actions directly to the constructor, e.g.\n\n``` // To load a message bundle (Note that __dirname should contain a messages folder) Messages.importMessagesDirectory(__dirname); const messages = Messages.load('myPackageName', 'myBundleName');\n\n// To throw a non-bundle based error: throw new SfError(message.getMessage('myError'), 'MyErrorName'); ```"
},
"alias-1501530572-0-211-1501530572-0-1533943985149": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1501530572-0-211-1501530572-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
"required": ["name", "message"],
"additionalProperties": false
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
"required": ["alias"],
"additionalProperties": false
}
}
}
77 changes: 4 additions & 73 deletions schemas/alias-set.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,90 +24,21 @@
"type": "string"
},
"error": {
"$ref": "#/definitions/SfError"
}
},
"required": ["alias"],
"additionalProperties": false
},
"SfError": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
},
"cause": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1283098157-0-211-1283098157-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action messages. Hints to the users regarding what can be done to fix related issues."
},
"exitCode": {
"type": "number",
"description": "SfdxCommand can return this process exit code."
},
"context": {
"type": "string",
"description": "The related context for this error."
},
"data": {}
},
"required": ["exitCode", "message", "name"],
"additionalProperties": false,
"description": "A generalized sfdx error which also contains an action. The action is used in the CLI to help guide users past the error.\n\nTo throw an error in a synchronous function you must either pass the error message and actions directly to the constructor, e.g.\n\n``` // To load a message bundle (Note that __dirname should contain a messages folder) Messages.importMessagesDirectory(__dirname); const messages = Messages.load('myPackageName', 'myBundleName');\n\n// To throw a non-bundle based error: throw new SfError(message.getMessage('myError'), 'MyErrorName'); ```"
},
"alias-1283098157-0-211-1283098157-0-1533943985149": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1283098157-0-211-1283098157-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
"required": ["name", "message"],
"additionalProperties": false
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
"required": ["alias"],
"additionalProperties": false
}
}
}
77 changes: 4 additions & 73 deletions schemas/alias-unset.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,90 +24,21 @@
"type": "string"
},
"error": {
"$ref": "#/definitions/SfError"
}
},
"required": ["alias"],
"additionalProperties": false
},
"SfError": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
},
"cause": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1283098157-0-211-1283098157-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action messages. Hints to the users regarding what can be done to fix related issues."
},
"exitCode": {
"type": "number",
"description": "SfdxCommand can return this process exit code."
},
"context": {
"type": "string",
"description": "The related context for this error."
},
"data": {}
},
"required": ["exitCode", "message", "name"],
"additionalProperties": false,
"description": "A generalized sfdx error which also contains an action. The action is used in the CLI to help guide users past the error.\n\nTo throw an error in a synchronous function you must either pass the error message and actions directly to the constructor, e.g.\n\n``` // To load a message bundle (Note that __dirname should contain a messages folder) Messages.importMessagesDirectory(__dirname); const messages = Messages.load('myPackageName', 'myBundleName');\n\n// To throw a non-bundle based error: throw new SfError(message.getMessage('myError'), 'MyErrorName'); ```"
},
"alias-1283098157-0-211-1283098157-0-1533943985149": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"cause": {
"$ref": "#/definitions/alias-1283098157-0-211-1283098157-0-1533943985149"
},
"fullStack": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
"required": ["name", "message"],
"additionalProperties": false
}
},
"required": ["message", "name"],
"description": "Any `Error` compatible with the `NamedError` type signature."
"required": ["alias"],
"additionalProperties": false
}
}
}
6 changes: 4 additions & 2 deletions src/alias.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/

import { SfError } from '@salesforce/core';
import { ux } from '@oclif/core';
import { SfCommand } from '@salesforce/sf-plugins-core';

Expand All @@ -14,7 +13,10 @@ export type AliasResult = {
value?: string;
success?: boolean;
message?: string;
error?: SfError;
error?: {
name: string;
message: string;
};
};

export type AliasResults = AliasResult[];
Expand Down
4 changes: 2 additions & 2 deletions src/commands/alias/set.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export default class AliasSet extends AliasCommand<AliasResults> {
return { alias, success: true, value };
}
} catch (err) {
const error = err as SfError;
return { alias, success: false, error, value };
const { name, message } = err as SfError;
return { alias, success: false, error: { name, message }, value };
}
});

Expand Down
4 changes: 2 additions & 2 deletions src/commands/alias/unset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ export default class AliasUnset extends AliasCommand<AliasResults> {
stateAggregator.aliases.unset(alias);
return { alias, value, success: true };
} catch (err) {
const error = err as SfError;
return { alias, value, success: false, error };
const { name, message } = err as SfError;
return { alias, value, success: false, error: { name, message } };
}
});

Expand Down
5 changes: 1 addition & 4 deletions test/commands/alias/set.nut.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,7 @@ describe('alias set NUTs', () => {
{
alias: 'DevHub',
success: false,
error: {
name: 'ValueRequiredError',
exitCode: 1,
},
error: { name: 'ValueRequiredError' },
message:
'You must provide a value when setting an alias. Use `sf alias unset my-alias-name` to remove existing aliases.',
},
Expand Down

0 comments on commit d7f1e3b

Please sign in to comment.