Improved the API Remote connection, UI and refactored the source code #16

airvzxf · 2022-10-12T20:20:02Z

Can I ask a favor? Could you add to the labels hacktoberfest, hacktoberfest-accepted in the pull request?

Added new features; Updated a lot of source code.
Suggested upgrading to version 0.0.5

It could be addressed in the issue #9. Could you add the labels hacktoberfest, hacktoberfest-accepted in the issue?

The notification changed from a simple message to integrate message with relevant information for example path/file, memory, if it is deleted, created or override. Furthermore, added emojis for better eye hit.

It is working and reflecting in the Bitburner game.

Suggested upgrading to version 0.0.5

airvzxf · 2022-10-12T20:22:44Z

gradle.properties

 # SemVer format -> https://semver.org
-pluginVersion=0.0.4
-
+pluginVersion=0.0.5


It is an important change.

airvzxf · 2022-10-12T20:23:18Z

.github/workflows/codacy-analysis.yml

@@ -44,7 +44,7 @@ jobs:
          # Adjust severity of non-security issues
          gh-code-scanning-compat: true
          # Force 0 exit code to allow SARIF file generation
-          # This will handover control about PR rejection to the GitHub side
+          # This will hand over control about PR rejection to the GitHub side


airvzxf · 2022-10-12T20:24:00Z

CHANGELOG.md

+## [0.0.5]
+
+### Added
+
+- Added listeners when a file or folder is created, modified, copied, renamed, deleted or moved
+- Added ToDo's list.
+
+### Changed
+
+- Updated README with specific instructions about how to use the plugin
+- Updated Plugin org.jetbrains.intellij to 1.9.0
+- Updated the notifications using emojis and given more information in the message
+- Refactored the source code
+
+### Fixed
+
+- Fixed typos in SECURITY markdown.
+


Added new changes for the suggested version 0.0.5

airvzxf · 2022-10-12T20:24:44Z

build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
    // Kotlin support
    id("org.jetbrains.kotlin.jvm") version "1.7.10"
    // Gradle IntelliJ Plugin
-    id("org.jetbrains.intellij") version "1.7.0"
+    id("org.jetbrains.intellij") version "1.9.0"


Upgraded to version 1.9.0; otherwise, it is not building the project.

airvzxf · 2022-10-12T20:25:52Z

gradlew


-APP_NAME="Gradle"


This constant wasn't used in the whole project.

Yhea because its a Autogenerated File if you use gradle init

Ok, I restore this line of code in the commit: bd3d1f4.

airvzxf · 2022-10-12T20:39:07Z

src/main/kotlin/com/github/serverfrog/bitburnerplugin/bitburner/Bitburner.kt

+
+class Bitburner {
+    companion object {
+        val extensions = arrayListOf("js", "script")


val extensions = arrayListOf("js", "script", "ns", "txt")

Add justification about why we only can use js and script extension file.

The api-server.js use the function document.saveFile()

https://github.com/danielyxie/bitburner/blob/48f80f25d6fb90edc292481905814c0d5593b5a9/electron/api-server.js#L78

The function saveFile is declared in Electron.tsx. It is using home.writeToScriptFile()

https://github.com/danielyxie/bitburner/blob/f8d977f7f84ef7e5722186a5ec243323ec20abb7/src/Electron.tsx#L98

The function home.writeToScriptFile() is declared in BaseServer.ts which make two validations one of this is the function isScriptFilename().

https://github.com/danielyxie/bitburner/blob/f6f023eeb4f9c53452fcb8971f5c4151f369aab6/src/Server/BaseServer.ts#L256

The function isScriptFilename() is declared in isScriptFilename.ts. It only accept two types of files: [.js, .script]

https://github.com/danielyxie/bitburner/blob/f6f023eeb4f9c53452fcb8971f5c4151f369aab6/src/Script/isScriptFilename.ts#L1

export const validScriptExtensions: Array<string> = ['.js', '.script'];

As this, i think somewhere written down, just a kinda copy of the VS Code Plugin, i took the list out there and put it in here. This Plugin was develop not much after the Steam Publish so many things were unknown or changed over the time

Interesting, it makes sense. You did an impressive job 9 months ago.

Serverfrog · 2022-10-26T20:04:42Z

so i got back to view a bit. Thanks for filling my inbox. As i had written, I'm not playing that game anymore and i don't work actively on it.

Multiple things i saw that i kinda dislike:

Autoformat everything. Like even the Autogenerated Gradle scripts like gradlew or the IDEA Project Files
the depth of the if cases are way to heavy like in the Filewatcher. Why Multiple If cases, if one is enough.

Also im a bit annoyed of the multiple messages on every channel. If im not fast enough, or not adding any labels, everyone is free to fork and Publish that Plugin ;) as i said: I'm not actively working on this or play the Game.

As often as you Mentioned i should add the Labels, you never said why i should do this. What does it add to the Project?

airvzxf · 2022-10-27T03:52:26Z

so i got back to view a bit. Thanks for filling my inbox. As i had written, I'm not playing that game anymore and i don't work actively on it.

I have a solution for it, that I will suggest below.

Multiple things i saw that i kinda dislike:
Autoformat everything. Like even the Autogenerated Gradle scripts like gradlew or the IDEA Project Files

I got too excited and it was my mistake. Furthermore, I would have made the changes first and then another pull request to improve the quality of the code.

the depth of the if cases are way to heavy like in the Filewatcher. Why Multiple If cases, if one is enough.

Well, looks like you didn't read the changes, the magic is happening in these conditions.

Also im a bit annoyed of the multiple messages on every channel. If im not fast enough, or not adding any labels, everyone is free to fork and Publish that Plugin ;) as i said: I'm not actively working on this or play the Game.

GitHub implemented a long time ago a solution for cases as yours. You can achieve the project, it prevents all the stuff that you don't like. Currently, if you achieve the project, all of us (the open-source community) will understand that this project is dead, and we can create new projects based on yours.

Steps:

Go to the settings properties.
On the bottom of these settings, go to the “Danger zone”.
Click on “Achieve this repository”.
Wuolah.

As often as you Mentioned i should add the Labels, you never said why i should do this. What does it add to the Project?

It is something for GitHub community who like the open-source, but never mind, nothing happened if you don't like it.

Serverfrog · 2022-10-27T08:31:44Z

First: no need to quickly close this MR.

I got too excited and it was my mistake. Furthermore, I would have made the changes first and then another pull request to improve the quality of the code.

Normally i know that code that is checked in is already at the improved Quality, there should not be needed to add another pull Request to cleanup things that came in with a previous one, specially if know that it needs fixing

Well, looks like you didn't read the changes, the magic is happening in these conditions.

There is no Magic if there is no else branch or further functionality beside that one in the innermost. Example is line 23 for there: you have two if cases which does nothing more than check two different things without any logic between them or if one of them is not true and this is often the case. I consider it bad practices to increase the branching depth because it also reduces readability.

GitHub implemented a long time ago a solution for cases as yours. You can achieve the project, it prevents all the stuff that you don't like. Currently, if you achieve the project, all of us (the open-source community) will understand that this project is dead, and we can create new projects based on yours.

First: not actively Working on it != Dead
Additionally that wont fix the thing that i got a Manuel created and send Mail, Notification about comments in other tickets and all of it mostly had the content to add a Label to my GitHub Project. As i don't care that much about this kind of event and that it felt very much pushed down my throat to add it, it feels wrong

Added new features; Updated a lot of source code.

2b13761

Suggested upgrading to version 0.0.5

airvzxf commented Oct 12, 2022

View reviewed changes

gradle.properties

# SemVer format -> https://semver.org

pluginVersion=0.0.4

pluginVersion=0.0.5

Copy link

Author

airvzxf Oct 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is an important change.

airvzxf commented Oct 12, 2022

View reviewed changes

airvzxf marked this pull request as draft October 13, 2022 11:51

airvzxf marked this pull request as ready for review October 13, 2022 11:52

Restored the gradle APP_NAME.

bd3d1f4

airvzxf closed this Oct 27, 2022

Serverfrog reopened this Oct 27, 2022

Serverfrog changed the base branch from main to task/#16_merge_with_fixes_and_cleanup October 27, 2022 10:09

Serverfrog merged commit 903ec91 into Serverfrog:task/#16_merge_with_fixes_and_cleanup Oct 27, 2022

Serverfrog mentioned this pull request Oct 27, 2022

Task/#16 merge with fixes and cleanup #17

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved the API Remote connection, UI and refactored the source code #16

Improved the API Remote connection, UI and refactored the source code #16

airvzxf commented Oct 12, 2022 •

edited

Loading

airvzxf Oct 12, 2022

airvzxf Oct 12, 2022

airvzxf Oct 12, 2022

airvzxf Oct 12, 2022 •

edited

Loading

airvzxf Oct 12, 2022

Serverfrog Oct 26, 2022

airvzxf Oct 27, 2022

airvzxf Oct 12, 2022 •

edited

Loading

Serverfrog Oct 26, 2022

airvzxf Oct 27, 2022

Serverfrog commented Oct 26, 2022

airvzxf commented Oct 27, 2022

Serverfrog commented Oct 27, 2022


		APP_NAME="Gradle"

Improved the API Remote connection, UI and refactored the source code #16

Improved the API Remote connection, UI and refactored the source code #16

Conversation

airvzxf commented Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

airvzxf Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

airvzxf Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Serverfrog commented Oct 26, 2022

airvzxf commented Oct 27, 2022

Serverfrog commented Oct 27, 2022

airvzxf commented Oct 12, 2022 •

edited

Loading

airvzxf Oct 12, 2022 •

edited

Loading

airvzxf Oct 12, 2022 •

edited

Loading