Skip to content

Restructure the ClojureScript code along Om best practices #18

@ryugi

Description

@ryugi

Right now there's a bit of inconsistency with how Tímı is structured and coded with how Om apps should really be created. In particular, some components the original author had no intention of communicating now need to do so. The original naming and code organization was unsuited for what the application became, yet the old structure and names were held on to. Some of this has been changed, but more work needs to be done in this area. In essence, the code layout and structure needs to model the overall conceptual intent and functional organization of the application, without the applications internals and intercommunication entering into that (which, instead, will be done through the use of async channels in the components themselves).

Tasks:

  • Identify the primary elements of the UI app
  • Establish naming conventions
    • IRenderers -> -view
    • Callbacks -> handle-
    • om.core/root -> "roots"
    • Document these
    • Link to Om Concepts wiki page
  • Unify these in a top-level namespace
    • Update the documentation with the name organization
  • Create a "mini app" for each of the primary parts of the UI app
    • Move and re-use (or create, as needed) components for each of these
    • Fully differentiate components, component state, application state, and app views
    • Move each of these into their own namespaces
    • Document these
    • Anything that does not fall into these categories, move into supporting namespaces

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions