WIP | Refactor existing parser using typescript #164
Conversation
|
@Midnighter this is work in progress(needs a lot of work and I am working on it). |
| @@ -8,6 +8,7 @@ services: | |||
| - "127.0.0.1:${UI_PORT:-8000}:8000" | |||
| volumes: | |||
| - "./:/app" | |||
| - "/app/node_modules" | |||
There was a problem hiding this comment.
I have my doubts about this change. Could it be that you didn't rebuild the image after changing dependencies?
src/__tests__/constants.ts
Outdated
There was a problem hiding this comment.
Instead of using a long array and define everything in script, could we create pairs of files (markdown, JSON) perhaps, that we load in the tests? Seems easier to read and maintain to me.
| @@ -16,6 +16,7 @@ | |||
| "format": "prettier --write src/" | |||
| }, | |||
| "dependencies": { | |||
| "antlr4": "^4.13.1-patch-1", | |||
There was a problem hiding this comment.
Did you have a look at the TypeScript enabled antlr4 packages, are they any good?
src/__tests__/parser.spec.ts
Outdated
There was a problem hiding this comment.
Would change this then depending on what we do with the constants.ts.
src/infrastructure/service/parser.ts
Outdated
| @@ -0,0 +1,347 @@ | |||
| import { cloneDeep } from "lodash"; | |||
There was a problem hiding this comment.
Typically, there is no more need for lodash when targetting ES6. We should try to get rid of this dependency.
| return printer.adr; | ||
| } | ||
|
|
||
| export function adr2md(adrToParse) { |
There was a problem hiding this comment.
I'm not a huge fan of constructing the strings this way. Perhaps we can use template strings and some kind of fluid interface to construct markdown.
There was a problem hiding this comment.
Or a markdown builder service where we add sections...
There was a problem hiding this comment.
I would consider ADR a domain model, but perhaps the parser rather works with a data transfer object, not sure yet.
| this.title = title || ""; | ||
| this.status = status || ""; | ||
| this.deciders = deciders || ""; | ||
| this.date = date || ""; | ||
| this.technicalStory = technicalStory || ""; | ||
| this.contextAndProblemStatement = contextAndProblemStatement || ""; | ||
| this.decisionDrivers = decisionDrivers || []; | ||
| this.highestOptionId = 0; | ||
| this.consideredOptions = []; | ||
| if (consideredOptions && consideredOptions.length > 0) { | ||
| for (let i = 0; i < consideredOptions.length; i++) { | ||
| this.addOption(consideredOptions[i]); | ||
| } | ||
| } | ||
| this.decisionOutcome = decisionOutcome || { | ||
| chosenOption: "", | ||
| explanation: "", | ||
| positiveConsequences: [], | ||
| negativeConsequences: [] | ||
| }; | ||
| this.links = links || []; | ||
|
|
||
| // Assure invariants for decisionOutcome attribute | ||
| if (!Object.prototype.hasOwnProperty.call(this.decisionOutcome, "chosenOption")) { | ||
| this.decisionOutcome.decisionOutcome = ""; | ||
| } | ||
| if (!Object.prototype.hasOwnProperty.call(this.decisionOutcome, "explanation")) { | ||
| this.decisionOutcome.explanation = ""; | ||
| } | ||
| if (!Object.prototype.hasOwnProperty.call(this.decisionOutcome, "positiveConsequences")) { | ||
| this.decisionOutcome.positiveConsequences = []; | ||
| } | ||
| if (!Object.prototype.hasOwnProperty.call(this.decisionOutcome, "negativeConsequences")) { | ||
| this.decisionOutcome.negativeConsequences = []; | ||
| } | ||
|
|
||
| this.cleanUp(); |
There was a problem hiding this comment.
Constructors should be extremely simple. Rather have a separate factory method with more logic.
Yeah, would love to pair up. |
|
We finally managed to get MADR 4.0.0-beta released: https://adr.github.io/madr/ - in case there are no show stoppers, we will release that as 4.0.0. |
No description provided.