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

[JS] Cleanup after refactoring #22

Open
1 of 33 tasks
GuillaumeDua opened this issue Dec 22, 2022 · 0 comments
Open
1 of 33 tasks

[JS] Cleanup after refactoring #22

GuillaumeDua opened this issue Dec 22, 2022 · 0 comments
Assignees
Milestone

Comments

@GuillaumeDua
Copy link
Owner

GuillaumeDua commented Dec 22, 2022

Makes everything looks cleaner, from a design (architecture) perspective

Library layout

  • name
  • version
  • description

Module

See #20

  • deploy using the CI so it's available
  • deplay min-size/obfuscated

Custom HTML elements

  • name consistency

Functions

  • cleaner prototype (pseudo-typed parameters)

Others

Promote consistency

  • hide warnings for undefined/fallback hljs language
  • soft errors (replace HTMLElement content with red error message, rather than stopping the process)
  • make Initialize_DivHTML_elements generic
  • Global option: force fallback language to ... [smthg]
  • per-codeSection CE configuration (local override global)
  • toggle technical info/warning logs
  • use ?? vs ||
  • execution -> pre.code rather than a new CS (+copy-to-cpliboard button)
  • buttons: bound to CS left-panel, not the element itself ?
  • check encapsulation/visibility
  • type = AwesomeCodeElement.details.${name} ?
  • update error messages -> ${classname}.name ?
  • named parameters
  • static vs. const ?
  • element name consistency ?
  • use arrow function: automatically captures the this value of the enclosing scope (rather than _this)
  • alias awesome-code-element -> ace ?
  • HTML_elements_name -> ace_${name}
  • check shadowroot-callbacks
  • dark_or_light -> color_scheme
  • console.xxxx -> replace '\n\t' by ','-seperated arguments ?
  • remove useless funcs, class (if any)
  • awesome-code-element.js: sub-modules aggregator
  • style : px vs. em
  • default policies : language, toggle_execution, toggle_parsing, presentation, etc.

👉 (see the existing TODO tags in sources for more)

Decouple CSS and JS

@GuillaumeDua GuillaumeDua added this to the MVP milestone Dec 22, 2022
@GuillaumeDua GuillaumeDua self-assigned this Dec 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant