Gathering detailed insights and metrics for @salesforce/sf-plugins-core
Gathering detailed insights and metrics for @salesforce/sf-plugins-core
Installations
npm install @salesforce/sf-plugins-coreDeveloper
salesforcecli
Developer Guide
BETA
Module System
ESM
Min. Node Version
>=18.0.0
Typescript Support
Yes
Node Version
22.11.0
NPM Version
10.9.0
Statistics
19 Stars
1,275 Commits
4 Forks
8 Watching
29 Branches
17 Contributors
Updated on 26 Nov 2024
Languages
TypeScript (98.32%)
JavaScript (1.54%)
Shell (0.14%)
Total Downloads
Cumulative downloads
Total Downloads
99,281,703
Last day
-40.2%
156,272
Compared to previous day
Last week
-39.1%
905,858
Compared to previous week
Last month
64.8%
7,047,434
Compared to previous month
Last year
79.2%
62,884,445
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
Description
The @salesforce/sf-plugins-core provides utilities for writing sf plugins.
Docs: https://salesforcecli.github.io/sf-plugins-core
SfCommand Abstract Class
The SfCommand abstract class extends @oclif/core's Command class for examples of how to build a definition. ) class and adds useful extensions to ease the development of commands for use in the Salesforce Unified CLI.
- SfCommand takes a generic type that defines the success JSON result
- Enable the json flag support by default
- Provides functions that help place success messages, warnings and errors into the correct location in JSON results
- Enables additional help sections to the standard oclif command help output
- Provides access to the cli-ux cli actions. This avoids having to import that interface from cli-ux and manually handling the
--jsonflag. - Provides simple, stubbable prompts for confirmation and secrets
Flags
Flags is a convenience reference to @oclif/core#Flags
Specialty Flags
These flags can be imported into a command and used like any other flag. See code examples in the links
- orgApiVersionFlag
- specifies a Salesforce API version.
- reads from Config (if available)
- validates version is still active
- warns if version if deprecated
- requiredOrgFlag
- accepts a username or alias
- aware of configuration defaults
- throws if org or default doesn't exist or can't be found
- optionalOrgFlag
- accepts a username or alias
- aware of configuration defaults
- might be undefined if an org isn't found
- requiredHubFlag
- accepts a username or alias
- aware of configuration defaults
- throws if org or default doesn't exist or can't be found
- throws if an org is found but is not a dev hub
- durationFlag
- specify a unit
- optionally specify a min, max, and defaultValue
- returns a Duration
- can be undefined if you don't set the default
- salesforceIdFlag
- validates that IDs are valid salesforce ID
- optionally restrict to 15/18 char
- optionally require it to be begin with a certain prefix
Unit Test Helpers
Want to verify SfCommand Ux behavior (warnings, tables, spinners, prompts)? Check out the functions in `stubUx``.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE.txt:0
Reason
0 existing vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: SECURITY.md:1
Reason
Found 1/24 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/automerge.yml:1
- Warn: no topLevel permission defined: .github/workflows/create-github-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/devScripts.yml:1
- Warn: no topLevel permission defined: .github/workflows/failureNotifications.yml:1
- Warn: no topLevel permission defined: .github/workflows/notify-slack-on-pr-open.yml:1
- Warn: no topLevel permission defined: .github/workflows/onRelease.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Warn: no topLevel permission defined: .github/workflows/validate-pr.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/failureNotifications.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/salesforcecli/sf-plugins-core/failureNotifications.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/notify-slack-on-pr-open.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/salesforcecli/sf-plugins-core/notify-slack-on-pr-open.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/onRelease.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/salesforcecli/sf-plugins-core/onRelease.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/onRelease.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/salesforcecli/sf-plugins-core/onRelease.yml/main?enable=pin
- Info: 0 out of 1 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 8 are checked with a SAST tool
Score
5.4
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More