Skip to content

NEW: @W-19204059@: Convert our CLI Plugin to ESM #1912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephen-carter-at-sf merged 1 commit into from
Oct 21, 2025
Merged

NEW: @W-19204059@: Convert our CLI Plugin to ESM #1912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions bin/dev.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/usr/bin/env node_modules/.bin/ts-node
// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
(async () => {
const oclif = await import('@oclif/core')
await oclif.execute({development: true, dir: __dirname})
})()
#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning

import { execute } from '@oclif/core';

await execute({ development: true, dir: import.meta.url });
8 changes: 3 additions & 5 deletions bin/run.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
#!/usr/bin/env node

// eslint-disable-next-line unicorn/prefer-top-level-await
(async () => {
const oclif = await import('@oclif/core')
await oclif.execute({dir: __dirname})
})()
import {execute} from '@oclif/core'

await execute({dir: import.meta.url})
24 changes: 12 additions & 12 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"version": "5.5.0",
"author": "Salesforce Code Analyzer Team",
"bugs": "https://github.com/forcedotcom/code-analyzer/issues",
"type": "module",
"dependencies": {
"@oclif/core": "3.27.0",
"@salesforce/code-analyzer-core": "0.38.1",
Expand Down
20 changes: 10 additions & 10 deletions src/commands/code-analyzer/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import {Flags, SfCommand} from '@salesforce/sf-plugins-core';
import {ConfigAction, ConfigDependencies, ConfigInput} from '../../lib/actions/ConfigAction';
import {ConfigFileWriter} from '../../lib/writers/ConfigWriter';
import {ConfigStyledYamlViewer} from '../../lib/viewers/ConfigViewer';
import {ConfigActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory';
import {BundleName, getMessage, getMessages} from '../../lib/messages';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener';
import {RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener';
import {Displayable, UxDisplay} from '../../lib/Display';
import {ConfigAction, ConfigDependencies, ConfigInput} from '../../lib/actions/ConfigAction.js';
import {ConfigFileWriter} from '../../lib/writers/ConfigWriter.js';
import {ConfigStyledYamlViewer} from '../../lib/viewers/ConfigViewer.js';
import {ConfigActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer.js';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory.js';
import {BundleName, getMessage, getMessages} from '../../lib/messages.js';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener.js';
import {RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener.js';
import {Displayable, UxDisplay} from '../../lib/Display.js';

export default class ConfigCommand extends SfCommand<void> implements Displayable {
// We don't need the `--json` output for this command.
Expand Down
24 changes: 12 additions & 12 deletions src/commands/code-analyzer/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import {Flags, SfCommand} from '@salesforce/sf-plugins-core';
import {View} from '../../Constants';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory';
import {RuleDetailDisplayer, RulesNoOpDisplayer, RuleTableDisplayer} from '../../lib/viewers/RuleViewer';
import {RulesActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer';
import {RulesAction, RulesDependencies, RulesInput} from '../../lib/actions/RulesAction';
import {BundleName, getMessage, getMessages} from '../../lib/messages';
import {Displayable, UxDisplay} from '../../lib/Display';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener';
import {RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener';
import {CompositeRulesWriter} from '../../lib/writers/RulesWriter';
import { SfCliTelemetryEmitter } from '../../lib/Telemetry';
import {View} from '../../Constants.js';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory.js';
import {RuleDetailDisplayer, RulesNoOpDisplayer, RuleTableDisplayer} from '../../lib/viewers/RuleViewer.js';
import {RulesActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer.js';
import {RulesAction, RulesDependencies, RulesInput} from '../../lib/actions/RulesAction.js';
import {BundleName, getMessage, getMessages} from '../../lib/messages.js';
import {Displayable, UxDisplay} from '../../lib/Display.js';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener.js';
import {RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener.js';
import {CompositeRulesWriter} from '../../lib/writers/RulesWriter.js';
import {SfCliTelemetryEmitter} from '../../lib/Telemetry.js';

export default class RulesCommand extends SfCommand<void> implements Displayable {
// We don't need the `--json` output for this command.
Expand Down
24 changes: 12 additions & 12 deletions src/commands/code-analyzer/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
import {Flags, SfCommand} from '@salesforce/sf-plugins-core';
import {SeverityLevel} from '@salesforce/code-analyzer-core';
import {RunAction, RunDependencies, RunInput} from '../../lib/actions/RunAction';
import {View} from '../../Constants';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory';
import {CompositeResultsWriter} from '../../lib/writers/ResultsWriter';
import {ResultsDetailDisplayer, ResultsNoOpDisplayer, ResultsTableDisplayer, ResultsViewer} from '../../lib/viewers/ResultsViewer';
import {RunActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer';
import {BundleName, getMessage, getMessages} from '../../lib/messages';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener';
import {EngineRunProgressSpinner, RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener';
import {Displayable, UxDisplay} from '../../lib/Display';
import {SfCliTelemetryEmitter} from "../../lib/Telemetry";
import {RunAction, RunDependencies, RunInput} from '../../lib/actions/RunAction.js';
import {View} from '../../Constants.js';
import {CodeAnalyzerConfigFactoryImpl} from '../../lib/factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactoryImpl} from '../../lib/factories/EnginePluginsFactory.js';
import {CompositeResultsWriter} from '../../lib/writers/ResultsWriter.js';
import {ResultsDetailDisplayer, ResultsNoOpDisplayer, ResultsTableDisplayer, ResultsViewer} from '../../lib/viewers/ResultsViewer.js';
import {RunActionSummaryViewer} from '../../lib/viewers/ActionSummaryViewer.js';
import {BundleName, getMessage, getMessages} from '../../lib/messages.js';
import {LogEventDisplayer} from '../../lib/listeners/LogEventListener.js';
import {EngineRunProgressSpinner, RuleSelectionProgressSpinner} from '../../lib/listeners/ProgressEventListener.js';
import {Displayable, UxDisplay} from '../../lib/Display.js';
import {SfCliTelemetryEmitter} from '../../lib/Telemetry.js';

export default class RunCommand extends SfCommand<void> implements Displayable {
// We don't need the `--json` output for this command.
Expand Down
2 changes: 1 addition & 1 deletion src/lib/Telemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {TelemetryData} from '@salesforce/code-analyzer-core';
import {Lifecycle} from "@salesforce/core";
import {Lifecycle} from '@salesforce/core';

export interface TelemetryEmitter {
emitTelemetry(source: string, eventName: string, data: TelemetryData): void;
Expand Down
24 changes: 12 additions & 12 deletions src/lib/actions/ConfigAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import {CodeAnalyzerConfig, CodeAnalyzer} from "@salesforce/code-analyzer-core";
import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory';
import {EnginePluginsFactory} from '../factories/EnginePluginsFactory';
import {ConfigWriter} from '../writers/ConfigWriter';
import {LogFileWriter} from '../writers/LogWriter';
import {ConfigViewer} from '../viewers/ConfigViewer';
import {createWorkspace} from '../utils/WorkspaceUtil';
import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener';
import {ProgressEventListener} from '../listeners/ProgressEventListener';
import {ConfigActionSummaryViewer} from '../viewers/ActionSummaryViewer';
import {AnnotatedConfigModel, ConfigModel} from '../models/ConfigModel';
import {EnginePlugin} from "@salesforce/code-analyzer-engine-api";
import {CodeAnalyzerConfig, CodeAnalyzer} from '@salesforce/code-analyzer-core';
import {EnginePlugin} from '@salesforce/code-analyzer-engine-api';
import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactory} from '../factories/EnginePluginsFactory.js';
import {ConfigWriter} from '../writers/ConfigWriter.js';
import {LogFileWriter} from '../writers/LogWriter.js';
import {ConfigViewer} from '../viewers/ConfigViewer.js';
import {createWorkspace} from '../utils/WorkspaceUtil.js';
import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener.js';
import {ProgressEventListener} from '../listeners/ProgressEventListener.js';
import {ConfigActionSummaryViewer} from '../viewers/ActionSummaryViewer.js';
import {AnnotatedConfigModel, ConfigModel} from '../models/ConfigModel.js';

export type ConfigDependencies = {
configFactory: CodeAnalyzerConfigFactory;
Expand Down
26 changes: 13 additions & 13 deletions src/lib/actions/RulesAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import { CodeAnalyzer, CodeAnalyzerConfig, Rule, RuleSelection } from '@salesforce/code-analyzer-core';
import { CodeAnalyzerConfigFactory } from '../factories/CodeAnalyzerConfigFactory';
import { EnginePluginsFactory } from '../factories/EnginePluginsFactory';
import { LogEventListener, LogEventLogger } from '../listeners/LogEventListener';
import { ProgressEventListener } from '../listeners/ProgressEventListener';
import { createWorkspace } from '../utils/WorkspaceUtil';
import { RulesActionSummaryViewer } from '../viewers/ActionSummaryViewer';
import { RuleViewer } from '../viewers/RuleViewer';
import { LogFileWriter } from '../writers/LogWriter';
import { RulesWriter } from '../writers/RulesWriter';
import { TelemetryEmitter } from '../Telemetry';
import { TelemetryEventListener } from '../listeners/TelemetryEventListener';
import * as Constants from '../../Constants';
import {CodeAnalyzer, CodeAnalyzerConfig, Rule, RuleSelection} from '@salesforce/code-analyzer-core';
import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactory} from '../factories/EnginePluginsFactory.js';
import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener.js';
import {ProgressEventListener} from '../listeners/ProgressEventListener.js';
import {createWorkspace} from '../utils/WorkspaceUtil.js';
import {RulesActionSummaryViewer} from '../viewers/ActionSummaryViewer.js';
import {RuleViewer} from '../viewers/RuleViewer.js';
import {LogFileWriter} from '../writers/LogWriter.js';
import {RulesWriter} from '../writers/RulesWriter.js';
import {TelemetryEmitter} from '../Telemetry.js';
import {TelemetryEventListener} from '../listeners/TelemetryEventListener.js';
import * as Constants from '../../Constants.js';

export type RulesDependencies = {
configFactory: CodeAnalyzerConfigFactory;
Expand Down
26 changes: 13 additions & 13 deletions src/lib/actions/RunAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ import {
SeverityLevel,
Workspace
} from '@salesforce/code-analyzer-core';
import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory';
import {EnginePluginsFactory} from '../factories/EnginePluginsFactory';
import {createWorkspace} from '../utils/WorkspaceUtil';
import {ResultsViewer} from '../viewers/ResultsViewer';
import {RunActionSummaryViewer} from '../viewers/ActionSummaryViewer';
import {ResultsWriter} from '../writers/ResultsWriter';
import {LogFileWriter} from '../writers/LogWriter';
import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener';
import {ProgressEventListener} from '../listeners/ProgressEventListener';
import {BundleName, getMessage} from '../messages';
import {TelemetryEmitter} from "../Telemetry";
import {TelemetryEventListener} from "../listeners/TelemetryEventListener";
import * as Constants from '../../Constants';
import {CodeAnalyzerConfigFactory} from '../factories/CodeAnalyzerConfigFactory.js';
import {EnginePluginsFactory} from '../factories/EnginePluginsFactory.js';
import {createWorkspace} from '../utils/WorkspaceUtil.js';
import {ResultsViewer} from '../viewers/ResultsViewer.js';
import {RunActionSummaryViewer} from '../viewers/ActionSummaryViewer.js';
import {ResultsWriter} from '../writers/ResultsWriter.js';
import {LogFileWriter} from '../writers/LogWriter.js';
import {LogEventListener, LogEventLogger} from '../listeners/LogEventListener.js';
import {ProgressEventListener} from '../listeners/ProgressEventListener.js';
import {BundleName, getMessage} from '../messages.js';
import {TelemetryEmitter} from '../Telemetry.js';
import {TelemetryEventListener} from '../listeners/TelemetryEventListener.js';
import * as Constants from '../../Constants.js';

export type RunDependencies = {
configFactory: CodeAnalyzerConfigFactory;
Expand Down
8 changes: 4 additions & 4 deletions src/lib/listeners/LogEventListener.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {CodeAnalyzer, EngineLogEvent, EventType, LogEvent, LogLevel} from '@salesforce/code-analyzer-core';
import {Display} from '../Display';
import {LogWriter} from '../writers/LogWriter';
import {BundleName, getMessage} from "../messages";
import {indent, makeGrey} from '../utils/StylingUtil';
import {Display} from '../Display.js';
import {LogWriter} from '../writers/LogWriter.js';
import {BundleName, getMessage} from '../messages.js';
import {indent, makeGrey} from '../utils/StylingUtil.js';

export interface LogEventListener {
listen(codeAnalyzer: CodeAnalyzer): void;
Expand Down
4 changes: 2 additions & 2 deletions src/lib/listeners/ProgressEventListener.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import {
EventType,
RuleSelectionProgressEvent
} from '@salesforce/code-analyzer-core';
import {Display} from '../Display';
import {BundleName, getMessage} from '../messages';
import {Display} from '../Display.js';
import {BundleName, getMessage} from '../messages.js';

export interface ProgressEventListener {
listen(...codeAnalyzers: CodeAnalyzer[]): void;
Expand Down
6 changes: 3 additions & 3 deletions src/lib/listeners/TelemetryEventListener.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ import {
EngineTelemetryEvent,
EventType,
TelemetryEvent
} from "@salesforce/code-analyzer-core";
import {TelemetryEmitter} from '../Telemetry';
import * as constants from '../../Constants';
} from '@salesforce/code-analyzer-core';
import {TelemetryEmitter} from '../Telemetry.js';
import * as constants from '../../Constants.js';

export class TelemetryEventListener {
private telemetryEmitter: TelemetryEmitter;
Expand Down
4 changes: 2 additions & 2 deletions src/lib/messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {Messages} from '@salesforce/core';
import {Tokens} from '@salesforce/core/lib/messages';
import {Tokens} from '@salesforce/core/lib/messages.js';

// Initialize Messages with the current plugin directory
Messages.importMessagesDirectory(__dirname);
Messages.importMessagesDirectory(import.meta.dirname);

export enum BundleName {
ActionSummaryViewer = 'action-summary-viewer',
Expand Down
6 changes: 3 additions & 3 deletions src/lib/models/ConfigModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as path from 'node:path';
import {dump as yamlDump} from 'js-yaml';
import {
CodeAnalyzer,
Expand All @@ -9,9 +10,8 @@ import {
RuleSelection,
SeverityLevel
} from '@salesforce/code-analyzer-core';
import {indent, makeGrey} from '../utils/StylingUtil';
import {BundleName, getMessage} from '../messages';
import path from "node:path";
import {indent, makeGrey} from '../utils/StylingUtil.js';
import {BundleName, getMessage} from '../messages.js';

export enum OutputFormat {
RAW_YAML = "RAW_YAML",
Expand Down
2 changes: 1 addition & 1 deletion src/lib/utils/WorkspaceUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as fg from 'fast-glob';
import {CodeAnalyzer, Workspace} from '@salesforce/code-analyzer-core';
import {getMessage, BundleName} from '../messages';
import {getMessage, BundleName} from '../messages.js';

export async function createWorkspace(core: CodeAnalyzer, workspacePaths: string[], targetPaths?: string[]): Promise<Workspace> {
const processedWorkspacePaths: string[] = await processPaths(workspacePaths, 'Workspace');
Expand Down
6 changes: 3 additions & 3 deletions src/lib/viewers/ActionSummaryViewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {Display} from '../Display';
import {RuleSelection, RunResults, SeverityLevel, Violation} from '@salesforce/code-analyzer-core';
import {toStyledHeader, indent} from '../utils/StylingUtil';
import {BundleName, getMessage} from '../messages';
import {Display} from '../Display.js';
import {toStyledHeader, indent} from '../utils/StylingUtil.js';
import {BundleName, getMessage} from '../messages.js';

abstract class AbstractActionSummaryViewer {
protected readonly display: Display;
Expand Down
4 changes: 2 additions & 2 deletions src/lib/viewers/ConfigViewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {Display} from '../Display';
import {ConfigModel, OutputFormat} from '../models/ConfigModel';
import {Display} from '../Display.js';
import {ConfigModel, OutputFormat} from '../models/ConfigModel.js';


export interface ConfigViewer {
Expand Down
8 changes: 4 additions & 4 deletions src/lib/viewers/ResultsViewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import * as path from 'node:path';
import {Ux} from '@salesforce/sf-plugins-core';
import {CodeLocation, RunResults, SeverityLevel, Violation} from '@salesforce/code-analyzer-core';
import {Display} from '../Display';
import {toStyledHeaderAndBody} from '../utils/StylingUtil';
import {BundleName, getMessage} from '../messages';
import path from "node:path";
import {Display} from '../Display.js';
import {toStyledHeaderAndBody} from '../utils/StylingUtil.js';
import {BundleName, getMessage} from '../messages.js';

export interface ResultsViewer {
view(results: RunResults): void;
Expand Down
6 changes: 3 additions & 3 deletions src/lib/viewers/RuleViewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {Ux} from '@salesforce/sf-plugins-core';
import {Rule, SeverityLevel} from '@salesforce/code-analyzer-core';
import {Display} from '../Display';
import {toStyledHeaderAndBody} from '../utils/StylingUtil';
import {BundleName, getMessage} from '../messages';
import {Display} from '../Display.js';
import {toStyledHeaderAndBody} from '../utils/StylingUtil.js';
import {BundleName, getMessage} from '../messages.js';

export interface RuleViewer {
view(rules: Rule[]): void;
Expand Down
Loading