Noir for VSCode Extension

[ksg97031]

No description provided.

[ksg97031]

vscode command for file navigation (https://code.visualstudio.com/api/references/commands)

vscode.commands.executeCommand(
  "editor.action.goToLocations",
  vscode.Uri.file(filepath),
  new vscode.Position(linenumber, 0),
  [],
  "goto"
);

[ksg97031]

Hello @hahwul !

I've added a new option to include file paths in the result output. I did this by adding a details field (a struct type) to the Endpoint to store the path and line number information. You can check out the changes in this commit:

https://github.com/noir-cr/noir/tree/include-path-option 745652b

I'd appreciate your feedback on this approach. Do you think it's suitable, or are there better ways to achieve this functionality?

Here are examples of how the output looks with the new option now:

• with --include-file-path option
  

• with -json option
  

Please give me feedback whenever you have time. No rush.

[hahwul]

Hiya @ksg97031
Wow! It''s awesome.

Regarding feedback, how about allowing the provision of multiple file paths instead of just one? Sometimes, an application's endpoint can be declared from multiple files, so it would be great to consider accommodating such cases by providing an array format for file paths. I think it could contribute to greater flexibility and adaptability, in my opinion. What are your thoughts on this idea?

And I think the name 'Details' could potentially hold more than just 'File' and 'Line' information. So, I've made some improvements below, and I'm curious to hear your thoughts on this.

e.g

struct Details
  include JSON::Serializable
  include YAML::Serializable
  @paths : Array(Path) = [] of Path
  # + New details types to be added in the future..

  def add_path(path : Path)
    @paths << path
  end
end

struct Path
  include JSON::Serializable
  include YAML::Serializable
  property path, line

  def initialize(@path : String, @line : Int32 | Nil)
  end
end

[
  {
    "headers": [],
    "method": "POST",
    "params": [],
    "protocol": "http",
    "url": "https://testapp.internal.domains/comments",
    "details": {
       "paths": [
          {"path":"/source/123.java", "line": 35},
          {"path":"/source/123.java", "line": 124},
          {"path":"/route/route.java", "line": 12},
        ] 
     }
  }
]

[hahwul]

@ksg97031
I really like the flag name you chose, --include-file-path! I had also been considering a list similar to the one below for flag names in my mind, so it seems like our thoughts align.

• --include-path
• --with-path

I also think it might be a good idea to consolidate plain and JSON outputs into a single flag. For instance, when using the --include-file-path flag, if the format is default, we could output it under the 'Endpoint' as shown in the image. In the case of JSON(-f json), we could include it in the details for json output.

[hahwul]

@ksg97031
Anyway, looking forward to your great ideas and opinions! Have a wonderful Christmas bro 🎄