Skip to content

Code cleanup #176

@asacolips

Description

@asacolips

In GitLab by @asacolips on Mar 11, 2024, 10:57

Summary

We've got a lot of baggage in the codebase that's built up over the years. !395 is a starting point to improve that by adding eslint, but we should also try to reorganize the repo to be more intentional about where code is placed.

Technical Notes

  • My Boilerplate System has a structure based on Atropos' recommendations. The module directory for scripts is broken up into documents, helpers, and sheets. Additionally, JS files use .mjs for their extension if they're ES modules, and Handlebars uses .hbs.
  • The dnd5e system goes a step further and is probably a better long term solution, using more generic names like applications instead of sheets. It's also a fair bit more advanced than we need IMO, so we would likely only want to use it for loose inspiration.
  • If possible, legacy code should be removed. For example, src/scss/global/ has the original scss used for the V1 version of the sheets, and we should remove as much of that as we can and reimplement what's necessary in the src/scss/v2/ directory.
  • Some non-relevant IDE stuff has crept in, like the .idea folder.
  • Gulp is abandoned. We should replace it with some other build system, whether that's rollup (like in our Vite build) or raw JS executed directly with node.

Acceptance Criteria

  • Directories rearranged
  • Legacy code removed where possible
  • Remove irrelevant files
  • Replace gulp

Labels (do-not-change)

/cc @asacolips @cswendrowski @LegoFed3

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions