Add new commands for deobfuscating and much more

Author: NickJAllen

README.md

@@ -2,19 +2,39 @@
 
 A lightweight Neovim plugin written in Lua for quickly navigating printed Java stack traces and creating new Java files (Classes, Interfaces, Enums, Records, etc.) with the correct package declaration automatically determined from the current buffer or file explorer context.
 
-## **✨ Features**
+<!-- toc -->
+
+- [Features](#features)
+  * [Java Stack Trace Navigation](#java-stack-trace-navigation)
+  * [New File Creation](#new-file-creation)
+- [Demos](#demos)
+  * [Selecting a line from a stack trace using Snacks picker](#selecting-a-line-from-a-stack-trace-using-snacks-picker)
+  * [Deobfuscate a stack trace in place in a log file](#deobfuscate-a-stack-trace-in-place-in-a-log-file)
+  * [Create a new Java class in same package as current Java file](#create-a-new-java-class-in-same-package-as-current-java-file)
+  * [Create a new type in the same package as current Java file](#create-a-new-type-in-the-same-package-as-current-java-file)
+- [Installation and Configuration](#installation-and-configuration)
+  * [lazy.nvim](#lazynvim)
+- [Usage](#usage)
+  * [**1\. Interactive File Creation**](#1-interactive-file-creation)
+  * [**2\. Direct File Creation (Using Arguments)**](#2-direct-file-creation-using-arguments)
+- [**🔧 Configuration**](#%F0%9F%94%A7-configuration)
+  * [**Template Placeholders**](#template-placeholders)
+
+<!-- tocstop -->
+
+## Features
 
 ### Java Stack Trace Navigation
 
 * Ability to jump to any line in a stack trace
-* Supports nested Java exceptions
+* Supports nested Java exceptions so that navigation works in actual call order (not printed order)
 * Use Snacks picker to select a line from stack trace 
 * All commands can get stack trace from current buffer (default) or a vim register (e.g '+' for system clipboard) if provided as extra argument to command
 * Commands to quickly navigate up and down or to the top or bottom of the stack trace
+* Commands to go to next and previous stack trace (e.g when viewing a log file)
 * Send stack trace to quickfix list
 * Supports jdtls or java_language_server LSP in order to look up file path from class name
-
-![Java Stack Picker](https://github.com/NickJAllen/resources/blob/main/java-helpers/java-stack-picker.gif)
+* Quickly and easily deobfuscate stack traces (in place, on the clipboard, or just directly use the obfuscated one and it's deobfuscated automatically for you)
 
 ### New File Creation
 
@@ -24,18 +44,43 @@ A lightweight Neovim plugin written in Lua for quickly navigating printed Java s
 * **Customizable:** Easily override built-in templates or define your own custom templates.  
 * **LSP Formatting:** Automatically formats the newly created file using the attached Language Server (via vim.lsp.buf.format()) if configured.
 
-## **⚙️ Installation**
+## Demos
+
+### Selecting a line from a stack trace using Snacks picker
+
+Demonstation of the ":JavaHelpersPickStackTraceLine" command:
+
+![Java Stack Picker](https://github.com/NickJAllen/resources/blob/main/java-helpers/java-stack-picker.gif)
+
+### Deobfuscate a stack trace in place in a log file
+
+Demonstation of the ":JavaHelpersDeobfuscate" command:
+
+![Inplace Stack Deobfuscation](https://github.com/NickJAllen/resources/blob/main/java-helpers/inplace-stack-deobfuscation.gif)
+
+### Create a new Java class in same package as current Java file
+
+Demonstation of the ":JavaHelpersNewFile Class"
+
+![New Class Creation](https://github.com/NickJAllen/resources/blob/main/java-helpers/new-class-creation.gif)
+
+### Create a new type in the same package as current Java file
+
+Demonstation of the ":JavaHelpersNewFile"
+
+![Java Stack Picker](https://github.com/NickJAllen/resources/blob/main/java-helpers/new-type-creation.gif)
+
+## Installation and Configuration
 
 Use your favorite package manager.
 
-### **lazy.nvim**
+### lazy.nvim
 
 An example for lazy.nvim with some quick key bindings to navigate Java stack traces and to create Java files:
 
 ```
-{
+  {
     'NickJAllen/java-helpers.nvim',
-
     cmd = {
       'JavaHelpersNewFile',
       'JavaHelpersPickStackTraceLine',
@@ -44,58 +89,74 @@ An example for lazy.nvim with some quick key bindings to navigate Java stack tra
       'JavaHelpersGoDownStackTrace',
       'JavaHelpersGoToBottomOfStackTrace',
       'JavaHelpersGoToTopOfStackTrace',
+      'JavaHelpersGoToNextStackTrace',
+      'JavaHelpersGoToPrevStackTrace',
       'JavaHelpersSendStackTraceToQuickfix',
+      'JavaHelpersDeobfuscate',
+      'JavaHelpersSelectObfuscationFile',
+      'JavaHelpersForgetObfuscationFile',
     },
 
-    -- Default options are shown here. If opts is missing or left empty then these defaults will be used.
+    ---@type JavaHelpers.Config
     opts = {
-
+      new_file = {
         ---Each template has a name and some template source code.
         ---${package_decl} and ${name} will be replaced with the package declaration and name for the Java type being created.
         ---If ${pos} is provided then the cursor will be positioned there ready to type.
-        ---@type TemplateDefinition[]
         templates = {},
 
         ---Defines patters to recognize Java source directories in order to determine the package name.
-        ---@type string[]
-        java_source_dirs = { "src/main/java", "src/test/java", "src" },
+        java_source_dirs = { 'src/main/java', 'src/test/java', 'src' },
 
         ---If true then newly created Java files will be formatted
-        ---@type boolean
         should_format = true,
-    },
+      },
 
-    -- Example keys - change these as you like
+      stack_trace = {
+        --Command that is used to deobfuscate stack traces
+        deobfuscate_command = 'retrace',
+
+        --Directory that will be used to select an obfuscation mapping file, if nil or empty the current directory will be used
+        obfuscation_mappings_dir = vim.uv.os_homedir() .. '/.obfuscation',
+      },
+    },
     keys = {
+      -- New file creation
       { '<leader>jn', ':JavaHelpersNewFile<cr>', desc = 'New Java Type' },
       { '<leader>jc', ':JavaHelpersNewFile Class<cr>', desc = 'New Java Class' },
       { '<leader>ji', ':JavaHelpersNewFile Interface<cr>', desc = 'New Java Interface' },
       { '<leader>ja', ':JavaHelpersNewFile Abstract Class<cr>', desc = 'New Abstract Java Class' },
       { '<leader>jr', ':JavaHelpersNewFile Record<cr>', desc = 'New Java Record' },
       { '<leader>je', ':JavaHelpersNewFile Enum<cr>', desc = 'New Java Enum' },
-      { '<leader>jp', ':JavaHelpersPickStackTraceLine<cr>', desc = 'Pick Java stack trace line' },
-      { '<leader>jP', ':JavaHelpersPickStackTraceLine +<cr>', desc = 'Pick Java stack trace line from clipboard' },
+
+      -- Stack trace navigation
       { '<leader>jg', ':JavaHelpersGoToStackTraceLine<cr>', desc = 'Go to Java stack trace line' },
-      { '<leader>jG', ':JavaHelpersGoToStackTraceLine +<cr>', desc = 'Go to Java stack trace line on clipboard' },
+      { '<leader>jG', ':JavaHelpersGoToStackTraceLine +<cr>', desc = 'Go to Java stack trace line on Clipboard' },
+      { '<leader>jp', ':JavaHelpersPickStackTraceLine<cr>', desc = 'Pick Java stack trace line' },
+      { '<leader>jP', ':JavaHelpersPickStackTraceLine +<cr>', desc = 'Pick Java stack trace line from Clipboard' },
       { '[j', ':JavaHelpersGoUpStackTrace<cr>', desc = 'Go up Java stack trace' },
       { ']j', ':JavaHelpersGoDownStackTrace<cr>', desc = 'Go down Java stack trace' },
+      { '[J', ':JavaHelpersGoToPrevStackTrace<cr>', desc = 'Go to previous Java stack trace' },
+      { ']J', ':JavaHelpersGoToNextStackTrace<cr>', desc = 'Go to next Java stack trace' },
       { '<leader>jt', ':JavaHelpersGoToTopOfStackTrace<cr>', desc = 'Go to top of Java stack trace' },
       { '<leader>jb', ':JavaHelpersGoToBottomOfStackTrace<cr>', desc = 'Go to bottom of Java stack trace' },
       { '<leader>jq', ':JavaHelpersSendStackTraceToQuickfix<cr>', desc = 'Send Java stack trace to quickfix list' },
-      { '<leader>jQ', ':JavaHelpersSendStackTraceToQuickfix +<cr>', desc = 'Send Java stack trace on clipboard to quickfix list' },
+      { '<leader>jd', ':JavaHelpersDeobfuscate<cr>', desc = 'Deofuscate Java stack trace' },
+      { '<leader>jD', ':JavaHelpersDeobfuscate +<cr>', desc = 'Deofuscate Java stack trace on Clipboard' },
+      { '<leader>jo', ':JavaHelpersSelectObfuscationFile<cr>', desc = 'Select obfuscation file' },
     },
-
     dependencies = {
       'nvim-lua/plenary.nvim',
 
-      -- This is only needed if you want to use the JavaHelpersPickStackTraceLine command (but highly recommended)
+      -- This is only needed if you want to use the JavaHelpersPickStackTraceLine or JavaHelpersSelectObfuscationFile commands (but highly recommended)
       'folke/snacks.nvim',
     },
-},
+  }
+
 
 ```
 
-## **🚀 Usage**
+## Usage
 
 The plugin exposes the following user commands: 
 

lua/java-helpers/init.lua

@@ -1,13 +1,17 @@
 local M = {}
 
+---@class JavaHelpers.Config
+---@field new_file JavaHelpers.NewFileConfig?
+---@field stack_trace JavaHelpers.StackTraceConfig?
+
 local new_file = require("java-helpers.new-file")
 local stack_trace = require("java-helpers.stack-trace")
 
 ---Should be called to initialize this plug-in
----@param opts table|nil User-provided configuration to override defaults.
+---@param opts JavaHelpers.Config? User-provided configuration to override defaults.
 function M.setup(opts)
-	new_file.setup(opts)
-	stack_trace.setup(opts)
+	new_file.setup(opts and opts.new_file or {})
+	stack_trace.setup(opts and opts.stack_trace or {})
 end
 
 M.create_java_file = new_file.create_java_file

lua/java-helpers/new-file.lua

@@ -3,12 +3,12 @@ local M = {}
 local utils = require("java-helpers.utils")
 local log = utils.log
 
----@class TemplateDefinition
+---@class JavaHelpers.TemplateDefinition
 ---@field name string The name of the template
 ---@field template string The source of the template
 
 ---Bult-in templates - these can't be deleted but they can be overridden
----@type TemplateDefinition[]
+---@type JavaHelpers.TemplateDefinition[]
 local builtin_templates = {
 	{
 		name = "Class",
@@ -48,27 +48,31 @@ local builtin_templates = {
 	},
 }
 
+---@class JavaHelpers.NewFileConfig
+---@field templates JavaHelpers.TemplateDefinition[]
+---@field java_source_dirs string[]
+---@field should_format boolean
+---
 -- Default configuration
+---@type JavaHelpers.NewFileConfig
 local default_config = {
 	---Each template has a name and some template source code.
 	---${package_decl} and ${name} will be replaced with the package declaration and name for the Java type being created.
 	---If ${pos} is provided then the cursor will be positioned there ready to type.
-	---@type TemplateDefinition[]
 	templates = {},
 
 	---Defines patters to recognize Java source directories in order to determine the package name.
-	---@type string[]
 	java_source_dirs = { "src/main/java", "src/test/java", "src" },
 
 	---If true then newly created Java files will be formatted
-	---@type boolean
 	should_format = true,
 }
 
+---@type JavaHelpers.NewFileConfig
 local config = {}
 
 ---All defined templates with name as the key and the template source as the value
----@type table<string, TemplateDefinition>
+---@type table<string, JavaHelpers.TemplateDefinition>
 local all_templates = {}
 
 ---All template names defined in order
@@ -192,7 +196,7 @@ end
 
 ---Given the name of a template, looks up the template source or nil if not found
 ---@param template_name string
----@return TemplateDefinition|nil template_definition The template source or nil if not found
+---@return JavaHelpers.TemplateDefinition|nil template_definition The template source or nil if not found
 local function get_template(template_name)
 	local name_lower = string.lower(template_name)
 
@@ -264,7 +268,7 @@ local function create_java_file(template, name, source_dir, package_name)
 end
 
 ---Adds a new template with the supplied definition
----@param template_definition TemplateDefinition
+---@param template_definition JavaHelpers.TemplateDefinition
 local function add_template(template_definition)
 	local name_lower = string.lower(template_definition.name)
 	local is_new_template = all_templates[name_lower] == nil
@@ -277,7 +281,7 @@ local function add_template(template_definition)
 end
 
 ---Adds a template from a template definition (a lua table with name and template keys)
----@param template_definition TemplateDefinition
+---@param template_definition JavaHelpers.TemplateDefinition
 function M.add_template(template_definition)
 	local name = template_definition.name
 
@@ -297,7 +301,7 @@ function M.add_template(template_definition)
 end
 
 ---Adds some new templates.
----@param templates TemplateDefinition[] Template definitions to add
+---@param templates JavaHelpers.TemplateDefinition[] Template definitions to add
 function M.add_templates(templates)
 	for _, template_definition in ipairs(templates) do
 		M.add_template(template_definition)
@@ -414,7 +418,7 @@ function M.create_java_file(template_name, type_name)
 end
 
 ---Should be called to initialize this plug-in
----@param opts table|nil User-provided configuration to override defaults.
+---@param opts JavaHelpers.NewFileConfig? User-provided configuration to override defaults.
 function M.setup(opts)
 	config = vim.tbl_deep_extend("force", default_config, opts or {})