diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f990c6b..48eeb63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing Guide For data-code-extension +# Contributing Guide For plugin-data-code-extension -This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to data-code-extension. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes. +This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to plugin-data-code-extension. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes. # Governance Model diff --git a/README.md b/README.md index 1807225..0b15fd1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# data-code-extension +# plugin-data-code-extension -[![NPM](https://img.shields.io/npm/v/data-code-extension.svg?label=data-code-extension)](https://www.npmjs.com/package/data-code-extension) [![Downloads/week](https://img.shields.io/npm/dw/data-code-extension.svg)](https://npmjs.org/package/data-code-extension) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/data-code-extension/main/LICENSE.txt) +[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-data-code-extension.svg?label=@salesforce/plugin-data-code-extension)](https://www.npmjs.com/package/@salesforce/plugin-data-code-extension) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-data-code-extension.svg)](https://npmjs.org/package/@salesforce/plugin-data-code-extension) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/@salesforce/plugin-data-code-extension/main/LICENSE.txt) # Description @@ -11,7 +11,7 @@ We always recommend using the latest version of these commands bundled with the ## Install ```bash -sf plugins install data-code-extension@x.y.z +sf plugins install @salesforce/plugin-data-code-extension@x.y.z ``` ## Issues diff --git a/package.json b/package.json index 8e0e015..4b4a181 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "data-code-extension", + "name": "@salesforce/plugin-data-code-extension", "description": "Data Cloud Code Extension", "version": "1.0.0", "dependencies": { @@ -43,9 +43,6 @@ "@oclif/plugin-help" ], "topics": { - "hello": { - "description": "Commands to say hello." - }, "data-code-extension": { "description": "Commands for Data Cloud Code Extension." }, diff --git a/src/base/deployBase.ts b/src/base/deployBase.ts index 6e5f0c9..7e00416 100644 --- a/src/base/deployBase.ts +++ b/src/base/deployBase.ts @@ -5,7 +5,7 @@ import { checkEnvironment } from '../utils/environmentChecker.js'; import { sharedBaseFlags, type SharedResultProps } from './types.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'deploy'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'deploy'); export type BaseDeployFlags = { name: string; diff --git a/src/commands/data-code-extension/function/deploy.ts b/src/commands/data-code-extension/function/deploy.ts index 40e46b9..d5ebcb7 100644 --- a/src/commands/data-code-extension/function/deploy.ts +++ b/src/commands/data-code-extension/function/deploy.ts @@ -3,7 +3,7 @@ import { Messages } from '@salesforce/core'; import { DeployBase, type BaseDeployFlags } from '../../../base/deployBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'deploy'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'deploy'); export type FunctionDeployFlags = BaseDeployFlags & { 'function-invoke-opt': string; diff --git a/src/commands/data-code-extension/function/init.ts b/src/commands/data-code-extension/function/init.ts index 1bfd483..897f992 100644 --- a/src/commands/data-code-extension/function/init.ts +++ b/src/commands/data-code-extension/function/init.ts @@ -3,23 +3,29 @@ import { Messages } from '@salesforce/core'; import { InitBase } from '../../../base/initBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'init'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'init'); +// eslint-disable-next-line sf-plugin/only-extend-SfCommand export default class Init extends InitBase { public static readonly summary = messages.getMessage('summary', ['function']); public static readonly description = messages.getMessage('description'); - // eslint-disable-next-line sf-plugin/no-missing-messages - public static readonly examples = messages.getMessages('examples').map(example => - example.replace(/%s/g, 'function') - ); + public static readonly examples = ((): string[] => { + try { + // eslint-disable-next-line sf-plugin/no-missing-messages + return messages.getMessages('examples').map((example) => example.replace(/%s/g, 'function')); + } catch { + return []; + } + })(); public static readonly flags = { + ...InitBase.flags, 'package-dir': Flags.directory({ char: 'p', summary: messages.getMessage('flags.packageDir.summary'), description: messages.getMessage('flags.packageDir.description'), required: true, - exists: false, // Allow non-existing directories (will be created) + exists: false, // Allow non-existing directories (will be created) }), }; diff --git a/src/commands/data-code-extension/function/run.ts b/src/commands/data-code-extension/function/run.ts index 7be1968..ae64a01 100644 --- a/src/commands/data-code-extension/function/run.ts +++ b/src/commands/data-code-extension/function/run.ts @@ -3,7 +3,7 @@ import { Messages } from '@salesforce/core'; import { RunBase } from '../../../base/runBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'run'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'run'); export default class Run extends RunBase { public static readonly summary = messages.getMessage('summary', ['function']); diff --git a/src/commands/data-code-extension/function/scan.ts b/src/commands/data-code-extension/function/scan.ts index 97a386b..3237f80 100644 --- a/src/commands/data-code-extension/function/scan.ts +++ b/src/commands/data-code-extension/function/scan.ts @@ -3,18 +3,18 @@ import { Messages } from '@salesforce/core'; import { ScanBase } from '../../../base/scanBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'scan'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'scan'); export default class Scan extends ScanBase { public static readonly summary = messages.getMessage('summary', ['function']); public static readonly description = messages.getMessage('description'); - // eslint-disable-next-line sf-plugin/no-missing-messages - public static readonly examples = messages.getMessages('examples').map(example => - example.replace(/%s/g, 'function') - ); + public static readonly examples = messages + // eslint-disable-next-line sf-plugin/no-missing-messages + .getMessages('examples') + .map((example) => example.replace(/%s/g, 'function')); public static readonly flags = { - 'entrypoint': Flags.string({ + entrypoint: Flags.string({ char: 'e', summary: messages.getMessage('flags.entrypoint.summary'), description: messages.getMessage('flags.entrypoint.description'), diff --git a/src/commands/data-code-extension/function/zip.ts b/src/commands/data-code-extension/function/zip.ts index 347fa8c..c34c069 100644 --- a/src/commands/data-code-extension/function/zip.ts +++ b/src/commands/data-code-extension/function/zip.ts @@ -3,7 +3,7 @@ import { Messages } from '@salesforce/core'; import { ZipBase } from '../../../base/zipBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'zip'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'zip'); export default class Zip extends ZipBase { public static readonly summary = messages.getMessage('summary', ['function']); diff --git a/src/commands/data-code-extension/script/deploy.ts b/src/commands/data-code-extension/script/deploy.ts index 5285c3f..955b3eb 100644 --- a/src/commands/data-code-extension/script/deploy.ts +++ b/src/commands/data-code-extension/script/deploy.ts @@ -2,7 +2,7 @@ import { Messages } from '@salesforce/core'; import { DeployBase } from '../../../base/deployBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'deploy'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'deploy'); // eslint-disable-next-line sf-plugin/only-extend-SfCommand export default class Deploy extends DeployBase { diff --git a/src/commands/data-code-extension/script/init.ts b/src/commands/data-code-extension/script/init.ts index b76d9d1..d7a624b 100644 --- a/src/commands/data-code-extension/script/init.ts +++ b/src/commands/data-code-extension/script/init.ts @@ -3,23 +3,29 @@ import { Messages } from '@salesforce/core'; import { InitBase } from '../../../base/initBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'init'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'init'); +// eslint-disable-next-line sf-plugin/only-extend-SfCommand export default class Init extends InitBase { public static readonly summary = messages.getMessage('summary', ['script']); public static readonly description = messages.getMessage('description'); - // eslint-disable-next-line sf-plugin/no-missing-messages - public static readonly examples = messages.getMessages('examples').map(example => - example.replace(/%s/g, 'script') - ); + public static readonly examples = ((): string[] => { + try { + // eslint-disable-next-line sf-plugin/no-missing-messages + return messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script')); + } catch { + return []; + } + })(); public static readonly flags = { + ...InitBase.flags, 'package-dir': Flags.directory({ char: 'p', summary: messages.getMessage('flags.packageDir.summary'), description: messages.getMessage('flags.packageDir.description'), required: true, - exists: false, // Allow non-existing directories (will be created) + exists: false, // Allow non-existing directories (will be created) }), }; diff --git a/src/commands/data-code-extension/script/run.ts b/src/commands/data-code-extension/script/run.ts index 2845fef..91cffa4 100644 --- a/src/commands/data-code-extension/script/run.ts +++ b/src/commands/data-code-extension/script/run.ts @@ -3,7 +3,7 @@ import { Messages } from '@salesforce/core'; import { RunBase } from '../../../base/runBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'run'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'run'); export default class Run extends RunBase { public static readonly summary = messages.getMessage('summary', ['script']); diff --git a/src/commands/data-code-extension/script/scan.ts b/src/commands/data-code-extension/script/scan.ts index d037a48..d3c05a3 100644 --- a/src/commands/data-code-extension/script/scan.ts +++ b/src/commands/data-code-extension/script/scan.ts @@ -3,18 +3,16 @@ import { Messages } from '@salesforce/core'; import { ScanBase } from '../../../base/scanBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'scan'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'scan'); export default class Scan extends ScanBase { public static readonly summary = messages.getMessage('summary', ['script']); public static readonly description = messages.getMessage('description'); // eslint-disable-next-line sf-plugin/no-missing-messages - public static readonly examples = messages.getMessages('examples').map(example => - example.replace(/%s/g, 'script') - ); + public static readonly examples = messages.getMessages('examples').map((example) => example.replace(/%s/g, 'script')); public static readonly flags = { - 'entrypoint': Flags.string({ + entrypoint: Flags.string({ char: 'e', summary: messages.getMessage('flags.entrypoint.summary'), description: messages.getMessage('flags.entrypoint.description'), diff --git a/src/commands/data-code-extension/script/zip.ts b/src/commands/data-code-extension/script/zip.ts index ffcb217..3d4343a 100644 --- a/src/commands/data-code-extension/script/zip.ts +++ b/src/commands/data-code-extension/script/zip.ts @@ -3,7 +3,7 @@ import { Messages } from '@salesforce/core'; import { ZipBase } from '../../../base/zipBase.js'; Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'zip'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'zip'); export default class Zip extends ZipBase { public static readonly summary = messages.getMessage('summary', ['script']); diff --git a/src/utils/datacodeBinaryChecker.ts b/src/utils/datacodeBinaryChecker.ts index cd450f4..76876e1 100644 --- a/src/utils/datacodeBinaryChecker.ts +++ b/src/utils/datacodeBinaryChecker.ts @@ -6,7 +6,7 @@ import { Messages } from '@salesforce/core'; const execAsync = promisify(exec); Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'datacodeBinaryChecker'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'datacodeBinaryChecker'); export type DatacodeBinaryInfo = { command: string; diff --git a/src/utils/datacodeBinaryExecutor.ts b/src/utils/datacodeBinaryExecutor.ts index 00f1485..1a4f98c 100644 --- a/src/utils/datacodeBinaryExecutor.ts +++ b/src/utils/datacodeBinaryExecutor.ts @@ -9,7 +9,7 @@ import { type DatacodeBinaryInfo } from './datacodeBinaryChecker.js'; const execAsync = promisify(exec); Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'datacodeBinaryExecutor'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'datacodeBinaryExecutor'); export type DatacodeInitExecutionResult = { stdout: string; diff --git a/src/utils/pipChecker.ts b/src/utils/pipChecker.ts index a71a106..0a436fa 100644 --- a/src/utils/pipChecker.ts +++ b/src/utils/pipChecker.ts @@ -6,7 +6,7 @@ import { Messages } from '@salesforce/core'; const execAsync = promisify(exec); Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'pipChecker'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'pipChecker'); export type PipPackageInfo = { name: string; @@ -111,4 +111,4 @@ export class PipChecker { } return false; } -} \ No newline at end of file +} diff --git a/src/utils/pythonChecker.ts b/src/utils/pythonChecker.ts index 8050b65..e962120 100644 --- a/src/utils/pythonChecker.ts +++ b/src/utils/pythonChecker.ts @@ -6,7 +6,7 @@ import { Messages } from '@salesforce/core'; const execAsync = promisify(exec); Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); -const messages = Messages.loadMessages('data-code-extension', 'pythonChecker'); +const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'pythonChecker'); export type PythonVersionInfo = { command: string;