bitburner-official / bitburner-filesync Goto Github PK

Only convert to the project being compileable with TS,
no need to convert ALL the code to TS for this issue.

Currently the message handler (https://github.com/bitburner-official/bitburner-filesync/blob/main/src/networking/messageHandler.js) isn't the most robust.
Improve the handling of incoming messages, make sure things don't blow up, make it easier to extend.

Add a testing framework, make it run via npm run test.
Either Mocha or Jest is fine by me.
Make an example test to prove it works, no need to think about what to test, only test addLeadingSlash() for example.

Add the contributing file is useful for new contributors, so they know what to do in this project

Here's a reference link: Contributing.md

It would be great to get the the estimated ram usage in the terminal on file uploads.

I saw this project is open to contributions, and it doesn't have Pull request and issue templates, it makes it easier for you to maintain your projects.

Here are links for reference:
Pull Request Template
Pull Request and Issue Template

In the code uploaded to npm for bitburner-filesync, tsc has been added in dependencies, but in the repo here, it never was. This causes above error. Unless really needed, please remove the ´tscdependency from the npm package.tsccommand is already provided bytypescript`

When a new tag is created, run an action to npm publish a built version of filesync, using the repository secret PUBLISHTONPM

I cloned bitburner-official/typescript-template and ran this tool and this was the output:

Should probably catch this error and handle it.

Adding a formatter would be good for code quality.
Please only commit the changes for adding the formatter if you make a PR for this issue. I'll run the formatter myself.
But you do have to add it to the package.json as a npm run formatter option besides adding it as a dependency.

A lofty goal, convert the whole codebase to proper TS.

File watching has always seemed less than ideal to me; as there are times when I want to retrieve files, times when I want to push files, and times when I don't want to do either. I find one-use commands like what the bitburner-sync package has far nicer and am currently using it for those.

To give recent examples:

• I can retrieve files from save A and the push them to save B.
• I can make updates to "hot" scripts that get executed by other scripts like my weaken/grow/hack scripts without worrying about my executor scripts failing unexpectedly due to them having been run with older code.

Once one of or multiple of tests/linting/formatting are in the codebase,
make it so these are validated when PRs are made.

A linter for the code would be very nice to have.
You don't necessarily have to fix all linting issues within the PR adding the linter.
But you do have to add it to the package.json as a npm run lint option.