Skip to content
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.

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

[FEAT] Define the options that will be used to configure the Parser #2679

Closed
tbouffard opened this issue May 11, 2023 · 2 comments
Closed

[FEAT] Define the options that will be used to configure the Parser #2679

tbouffard opened this issue May 11, 2023 · 2 comments
Assignees
Labels
decision record Track project and architectural decisions lib integration Something about how an app can integrate the library
Milestone

Comments

@tbouffard
Copy link
Member

tbouffard commented May 11, 2023

As in #2659, we have several issues that requires to pass new options to the renderer.
To have something consistent, I suggest we review all requirements to propose a consistent Options definition.

Topics involved:

Way of working

  • starting from the initial proposal, let's discuss and comment this issue to amend the proposal
  • keep track of the initial proposal to be able to see at a glance the diff between the current/final solution and the initial proposition
  • during the design phase, the proposal will be updated until we converge

Final proposal

Already Implemented

// in GlobalOptions
  parser: {
    disableConsoleLog?: boolean; // default: false
    additionalXmlAttributeProcessor?: (value: string) => string; // default: undefined
  }

Initial proposal

// new property in GlobalOptions
  parser: {
    disableConsoleLog: boolean; // default: false
    additionalXmlAttributeProcessor: (value: string) => string;
  }

Other proposals for the function that performs extra XML entities decoding:

  • xmlEntitiesTransformer
@tbouffard tbouffard added the enhancement New feature or request label May 11, 2023
@tbouffard tbouffard added this to the 0.34.1 milestone May 11, 2023
@tbouffard tbouffard self-assigned this May 11, 2023
@tbouffard tbouffard modified the milestones: 0.34.1, 0.35.0 May 15, 2023
@tbouffard tbouffard assigned csouchet and unassigned tbouffard May 16, 2023
@tbouffard tbouffard added decision record Track project and architectural decisions lib integration Something about how an app can integrate the library and removed enhancement New feature or request labels May 26, 2023
@tbouffard tbouffard modified the milestones: 0.35.0, 0.36.0 May 30, 2023
@csouchet csouchet modified the milestones: 0.36.0, 0.37.0 Jun 12, 2023
@csouchet
Copy link
Member

Ok for disableConsoleLog

@tbouffard
Copy link
Member Author

Final proposal shared.
So closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision record Track project and architectural decisions lib integration Something about how an app can integrate the library
Projects
None yet
Development

No branches or pull requests

2 participants