Initial Configuration for the Extension

[aharbii]

• Configuring Extension package, and structure

• Configuring required environment

• Configuring vscode workspace, settings, tasks, and debugger.

• Configuring extension icon

  • extracted from "https://uchenml.tech/" SVG logo

• Configuring GTS [Google TypeScript] style guide, formatter, and linter.

• Configuring ESLint to enforce style guide, and provide automated fixes

• Configuring Prettier to re-format code

• Configuring GitHub Actions:

  • On Pull Requests:
    • Adding labels
    • Added fake main.cpp file with CMake configuration to build on different OS, to be used later for testing, and GitHub Actions
    • Build the extension on linux
      • without calling vscode extension test as it requires display which is not provided on the server
    • Build the extension on macOS with pre-configuration for running tests
    • Build on windows is consuming much time than other processes - To be discussed if how required is it
    • On main branch update:
    • All actions from Pull Request
    • Generating a new release for the extension

• Implementing:

  • ReadOnly viewer to be opened, once the user opens an executable file showing placeholder 'Lorem Ipsum'
  • Logic for checking if the opened file is executable
    • as objdump can also be run for object files, and system libraries, to be discussed if it's sufficient to only generate reports for executables, or other files can be considered

  • Noticed UI/UX uncomfortable drawback - when the user opens an executable on vscode there's a warning page mentioning 'The file is not displayed in the text editor because it is either binary or uses an unsupported text encoding.'

    vscode APIs cannot detect that the user opens a binary before the user selects 'Open Anyway' option, then the extension logic get fired.

• Tested on:

  • Linux - Ubuntu 20.04
  • macOS Sequoia Developer's Beta - Apple Silicon
  • Windows 11

[aharbii]

Something like closing the actual binary editor, and open the CodeArt editor only? or you mean to not split the view?

[eugeneo]

On second thought, lets keep the current behavior. Please address the code comments and I will approve this PR and the first milestone.

[eugeneo]

That’s fine. Windows support is not a priority at this time. I expect supporting Windows will be a significant effort and most users use Visual Studio anyways.

On Sat, Aug 17, 2024 at 11:55 AM Ahmed Harbi @.***> wrote:

@.**** commented on this pull request.

In src/extension.ts https://github.com/uchen-ml/codeart-binexplore/pull/2#discussion_r1720818467 :

• • @param filePath The path to the file.
• • @returns True if the file is a binary executable, false otherwise.
• */ +function isExecutable(filePath: string): boolean {
• if (!fs.existsSync(filePath)) {
• return false;
• }
• try {
• const stats = fs.statSync(filePath);
• const isExecutable = (stats.mode & 0o111) !== 0;
• const isWinExecutable =
• filePath.endsWith('.exe') && os.platform() === 'win32';
• return isExecutable || isWinExecutable;

ok, I will remove isWinExecutable logic, but the extension will not be usable at all for any windows application

— Reply to this email directly, view it on GitHub https://github.com/uchen-ml/codeart-binexplore/pull/2#discussion_r1720818467, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACGJLOEPRAIG33BJVWEEF3ZR6MAXAVCNFSM6AAAAABMTVHRO6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDENBUGEZTMNRSGI . You are receiving this because you commented.Message ID: @.***>

[aharbii]

Resolved review findings.

To be resolved:

• Using CMake to generate the executables, and binaries
  • to be discussed more when we get to that part of the project
• Updating README.md
  • to be updated as per milestones, as the planned changes will includes vscode settings for objdump path and args
  • when we hit the second milestone, the preview results will include actual objdump results which can be used as images in README.md

New features:

• added output channel to include all of the extensions logs, information, and to be used later for debugging, and issues reporting.