CHANGE @W-17397505@ Added core version to certain outputs #172
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfeingold35
force-pushed
the
d/W-17397505
branch
from
ad2d244 to
2a799d1
Compare
jfeingold35
force-pushed
the
d/W-17397505
branch
from
2a799d1 to
c6649f6
Compare
jfeingold35
commented
Dec 13, 2024
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "name": "@salesforce/code-analyzer-core", | |||
| "description": "Core Package for the Salesforce Code Analyzer", | |||
| "version": "0.19.1", | |||
| "version": "0.20.0-SNAPSHOT", | |||
There was a problem hiding this comment.
I wasn't sure whether we wanted to do an 0.20.0 for this or an 0.19.2. I'm fine with either.
| @@ -14,6 +14,8 @@ export enum OutputFormat { | |||
| SARIF = "SARIF" | |||
| } | |||
|
|
|||
| export const CODE_ANALYZER_CORE_NAME: string = 'code-analyzer'; | |||
There was a problem hiding this comment.
If memory serves, this was the name we agreed on, and it means all our conventions for engine names (lowercase, skewer-case, etc).
| getCoreVersion(): string { | ||
| if (!this.coreVersion) { | ||
| const pathToPackageJson: string = path.join(__dirname, '..', 'package.json'); | ||
| const packageJson: { version: string } = JSON.parse(fs.readFileSync(pathToPackageJson, 'utf-8')); |
There was a problem hiding this comment.
I'm using fs.readFileSync() here instead of a Promise because I wanted to keep the results formatting a synchronous process instead of introducing awaits everywhere.
We cache the result to make sure we only do the read once, so there shouldn't be a noticeable impact on performance.
jfeingold35
force-pushed
the
d/W-17397505
branch
from
47015a7 to
a9cfd7d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the
code-analyzer-coreversion to certain output formats, with the name"code-analyzer"and the value being pulled from Core'spackage.jsonversion property.The outputs affected are:
I chose not to include it in SARIF because I couldn't figure out a good place to slot it into the schema, since It's not technically a tool that has violations or rules associated with it.