lint errors preventing melpa packaging

[rocky]

The following is from melpa/melpa#6169 (comment) and is preventing MELPA packaging. You can still get this as an ELPA package.

checkdoc

• node-inspect-query-cmdline could have a documentation string

• realgud:node-inspect-track-mode-hook could have a documentation string

• realgud:node-inspect-suggest-invocation's docstring should mention DEBUGGER-NAME (as a bonus, Emacs' online help will detect these and fontify them which can be useful)

  • But if we look at the function we can see it isn't used. Perhaps it isn't necessary, or otherwise you can call the variable _debugger-name to indicate to Emacs and your users that it isn't used

• realgud:node-inspect-reset's docstring could make its first line into a complete sentence; otherwise in Help-apropos we just see an incomplete line: Node-Inspect cleanup - remove debugger’s internal buffers (frame,

  • Same with realgud:node-inspect-remove-ansi-schmutz, realgud:node-inspect-reset, realgud:node-inspect-command-hash

One benefit of using a standard package layout is that you would also have seen these from package-lint:

• node-inspect-query-cmdline might collide with the "namespace" of another hypothetical package called node-inspect

  • Same with node-inspect-track-mode, node-inspect-parse-cmd-args

Misc

• In node-inspect.el: strictly speaking, declare-function's second argument should be a string (check-declare-file calls these "malformed declarations"), but I can see the intent. I think you want to write realgud:node-inspect-track-mode instead of realgud-node-inspect-track-mode given your current choice of "namespace"

  • I'd be worried about having these declarations collide with another package's namespace -- are they necessary?

• In node-inspect-parse-cmd-args: node-opt-two-args, node-two-args are bound but never used

• In realgud:node-inspect, cmd-buf is bound but unused except in a commented-out block of code