NEW: @W-15652656@: Add public interfaces before adding any business logic #10
Conversation
stephen-carter-at-sf
changed the title
| "branches": 80, | ||
| "functions": 80, | ||
| "lines": 80, | ||
| "statements": 80 |
There was a problem hiding this comment.
Lowering per the suggestion of Jag and Josh. But we are still at 100% coverage and I hope to keep it up there as much as possible.
|
|
||
| // Temporarily making this an interface | ||
| export interface CodeAnalyzer { | ||
| addEnginePlugin(enginePlugin: EnginePlugin): void |
There was a problem hiding this comment.
I'm purposely choosing not to add in any documentation comments since this is all subject to change. Only after things get stable does it make sense for us to add in all the comments for us to manage.
| export enum LogLevel { | ||
| Error = 1, | ||
| Warn = 2, | ||
| Info = 3, | ||
| Debug = 4, | ||
| Fine = 5 | ||
| } | ||
|
|
||
| export type LogEvent = { | ||
| type: EventType.LogEvent, | ||
| timestamp: Date, | ||
| logLevel: LogLevel, | ||
| message: string | ||
| } |
There was a problem hiding this comment.
We might be able to reuse some of the Log4JS code that we use in the current scanner repo. Might not have to reinvent the wheel.
| getStartColumn(): number | ||
| getEndLine(): number | ||
| getEndColumn(): number |
There was a problem hiding this comment.
Should these three be number|null?
There was a problem hiding this comment.
Will do in my next PR. Sorry I missed your comments.
| @@ -0,0 +1,27 @@ | |||
| export enum SeverityLevel { | |||
| High = 1, | |||
There was a problem hiding this comment.
Did we decide against having a Critical = 0 for engine failures?
There was a problem hiding this comment.
Oh that's a good idea. Will update in my next PR.
As a first step, I'm simply adding in all the public interfaces so that we are ready at any time to publish a 0.1.0-alpha package of the core module so that client development may begin in parallel. I went ahead and added in interfaces for both the core package and the engine-api packages.