Skip to content

Technical Debt Reduction: Fix Code Formatting and Lint Errors - #71

Merged
jdanish merged 8 commits into
devfrom
dev-prettify
Aug 29, 2023
Merged

Technical Debt Reduction: Fix Code Formatting and Lint Errors#71
jdanish merged 8 commits into
devfrom
dev-prettify

Conversation

@daveseah

@daveseah daveseah commented Aug 23, 2023

Copy link
Copy Markdown
Collaborator

One major problem has been code format consistency due to Prettier being disabled in NetCreate 1.0 due to issues with the configuration files. This was corrected a couple months ago, so now it is time to clean everything up.

  • apply Prettier to system source files
  • fix linting errors in system source files
  • apply Prettier to app/view/netcreate source files
  • fix linting errors in app/view/netcreate source files
  • add missing module structural conventions
  • convert /*/ doc comments to jsdoc-compatible /** */
  • punt remove all console errors and lingering debug statements
  • punt remove obsolete code modules
  • punt remove deprecated code from source

TESTING

There should be no functional changes. To test:

  • checkout the branch
  • do your normal stuff and see if it appears to be working correctly
  • if something has broken, please take a screenshot and post it here. Explain what you expected to happen, and what happened instead.
  • if you can, test the regular dev branch and see if the problem goes away

SCOPE OF CHANGES

The vast bulk of this work was comment style and section order so they adhere to our code style. Additionally, a few code blocks were rewritten to remove the lint warnings and errors that litter the source code.

NEXT STEPS

It is likely that we will need to replace key parts of our build system with a completely different package, as the current one (brunch) is no longer supported. This is a chance to also migrate parts of the system to typescript, which will help with stricter data modeling discipline.

Before we start adding new systems with the updated module structure, we need to update the build tools and complicated packages like react to work on the modern servers. This is a tricky upgrade that will require all developers to confer, so punting it for now.

Lastly we want to remove obsolete code because it wastes our time by cluttering up the source and obscures the actual function of the application. Like the react package update, this will require all developers to confer and confirm what is in use.

@daveseah daveseah changed the title WIP: Technical Debt Reduction: Eliminate Code Formatting and Lint Errors Technical Debt Reduction: Fix Code Formatting and Lint Errors Aug 24, 2023
@daveseah daveseah assigned daveseah and benloh and unassigned daveseah Aug 25, 2023
@benloh

benloh commented Aug 29, 2023

Copy link
Copy Markdown
Collaborator

Ahhh...so clean. Confirmed works for me: was able to open existing project, modify it, edit template, create project.

@benloh

benloh commented Aug 29, 2023

Copy link
Copy Markdown
Collaborator

@jdanish Please give this PR a quick whirl on existing projects to make sure the code updates work. Sri power-washed our code. If it works, please merge.

@jdanish
jdanish merged commit 9dba145 into dev Aug 29, 2023
@daveseah
daveseah deleted the dev-prettify branch August 29, 2023 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants