Linter configurations for linting micro plugins

[Andriamanitra]

Micro plugins are written in Lua for which there are two decent linters that I know of: Luacheck and selene. Luacheck is older and hasn't been updated in a number of years but it can still be useful. Selene is more modern (it was originally developed to support Roblox development) and it's still getting regular updates. If you're unsure which one you want to use you can check out comparison of the two in selene docs.

A small issue with both of these linters is that by default they are unaware of variables and functions that micro editor provides or uses (such as import and init). Here are the configuration files that I have been using to stop the linters from complaining about those functions. Maybe they can save someone a few minutes of reading linter docs and messing with configuration files.

Luacheck (https://github.com/mpeterv/luacheck)

.luacheckrc

read_globals = {
    "import",
}

globals = {
    "VERSION",
    "init",
    "preinit",
    "postinit",
    "onSetActive",
    "onBufferOpen",
    "onBufPaneOpen",
    "onRune",
    "preRune",

    "onCursorUp",
    "onCursorDown",
    "onCursorPageUp",
    "onCursorPageDown",
    "onCursorLeft",
    "onCursorRight",
    "onCursorStart",
    "onCursorEnd",
    "onSelectToStart",
    "onSelectToEnd",
    "onSelectUp",
    "onSelectDown",
    "onSelectLeft",
    "onSelectRight",
    "onSelectToStartOfText",
    "onSelectToStartOfTextToggle",
    "onWordRight",
    "onWordLeft",
    "onSelectWordRight",
    "onSelectWordLeft",
    "onMoveLinesUp",
    "onMoveLinesDown",
    "onDeleteWordRight",
    "onDeleteWordLeft",
    "onSelectLine",
    "onSelectToStartOfLine",
    "onSelectToEndOfLine",
    "onInsertNewline",
    "onInsertSpace",
    "onBackspace",
    "onDelete",
    "onCenter",
    "onInsertTab",
    "onSave",
    "onSaveAll",
    "onSaveAs",
    "onFind",
    "onFindLiteral",
    "onFindNext",
    "onFindPrevious",
    "onDiffPrevious",
    "onDiffNext",
    "onUndo",
    "onRedo",
    "onCopy",
    "onCopyLine",
    "onCut",
    "onCutLine",
    "onDuplicateLine",
    "onDeleteLine",
    "onIndentSelection",
    "onOutdentSelection",
    "onOutdentLine",
    "onIndentLine",
    "onPaste",
    "onSelectAll",
    "onOpenFile",
    "onStart",
    "onEnd",
    "onPageUp",
    "onPageDown",
    "onSelectPageUp",
    "onSelectPageDown",
    "onHalfPageUp",
    "onHalfPageDown",
    "onStartOfLine",
    "onEndOfLine",
    "onStartOfText",
    "onStartOfTextToggle",
    "onParagraphPrevious",
    "onParagraphNext",
    "onToggleHelp",
    "onToggleDiffGutter",
    "onToggleRuler",
    "onJumpLine",
    "onClearStatus",
    "onShellMode",
    "onCommandMode",
    "onQuit",
    "onQuitAll",
    "onAddTab",
    "onPreviousTab",
    "onNextTab",
    "onNextSplit",
    "onUnsplit",
    "onVSplit",
    "onHSplit",
    "onPreviousSplit",
    "onToggleMacro",
    "onPlayMacro",
    "onSuspend",
    "onScrollUp",
    "onScrollDown",
    "onSpawnMultiCursor",
    "onSpawnMultiCursorUp",
    "onSpawnMultiCursorDown",
    "onSpawnMultiCursorSelect",
    "onRemoveMultiCursor",
    "onRemoveAllMultiCursors",
    "onSkipMultiCursor",
    "onJumpToMatchingBrace",
    "onAutocomplete",

    "preCursorUp",
    "preCursorDown",
    "preCursorPageUp",
    "preCursorPageDown",
    "preCursorLeft",
    "preCursorRight",
    "preCursorStart",
    "preCursorEnd",
    "preSelectToStart",
    "preSelectToEnd",
    "preSelectUp",
    "preSelectDown",
    "preSelectLeft",
    "preSelectRight",
    "preSelectToStartOfText",
    "preSelectToStartOfTextToggle",
    "preWordRight",
    "preWordLeft",
    "preSelectWordRight",
    "preSelectWordLeft",
    "preMoveLinesUp",
    "preMoveLinesDown",
    "preDeleteWordRight",
    "preDeleteWordLeft",
    "preSelectLine",
    "preSelectToStartOfLine",
    "preSelectToEndOfLine",
    "preInsertNewline",
    "preInsertSpace",
    "preBackspace",
    "preDelete",
    "preCenter",
    "preInsertTab",
    "preSave",
    "preSaveAll",
    "preSaveAs",
    "preFind",
    "preFindLiteral",
    "preFindNext",
    "preFindPrevious",
    "preDiffPrevious",
    "preDiffNext",
    "preUndo",
    "preRedo",
    "preCopy",
    "preCopyLine",
    "preCut",
    "preCutLine",
    "preDuplicateLine",
    "preDeleteLine",
    "preIndentSelection",
    "preOutdentSelection",
    "preOutdentLine",
    "preIndentLine",
    "prePaste",
    "preSelectAll",
    "preOpenFile",
    "preStart",
    "preEnd",
    "prePageUp",
    "prePageDown",
    "preSelectPageUp",
    "preSelectPageDown",
    "preHalfPageUp",
    "preHalfPageDown",
    "preStartOfLine",
    "preEndOfLine",
    "preStartOfText",
    "preStartOfTextToggle",
    "preParagraphPrevious",
    "preParagraphNext",
    "preToggleHelp",
    "preToggleDiffGutter",
    "preToggleRuler",
    "preJumpLine",
    "preClearStatus",
    "preShellMode",
    "preCommandMode",
    "preQuit",
    "preQuitAll",
    "preAddTab",
    "prePreviousTab",
    "preNextTab",
    "preNextSplit",
    "preUnsplit",
    "preVSplit",
    "preHSplit",
    "prePreviousSplit",
    "preToggleMacro",
    "prePlayMacro",
    "preSuspend",
    "preScrollUp",
    "preScrollDown",
    "preSpawnMultiCursor",
    "preSpawnMultiCursorUp",
    "preSpawnMultiCursorDown",
    "preSpawnMultiCursorSelect",
    "preRemoveMultiCursor",
    "preRemoveAllMultiCursors",
    "preSkipMultiCursor",
    "preJumpToMatchingBrace",
    "preAutocomplete",
}

Selene (https://github.com/Kampfkarren/selene)

selene.toml:

std = "micro"

micro.yml:

# std definition for selene (Lua linter) for linting micro-editor plugins
#
# Usage:
# 1. Place this file adjacent to selene.toml
# 2. Add `std = micro` as the first line of your selene.toml file
#
# More information:
# selene on Github: https://github.com/Kampfkarren/selene
# using std in selene: https://kampfkarren.github.io/selene/usage/std.html
# docs for micro plugins: https://github.com/zyedidia/micro/blob/master/runtime/help/plugins.md
---
base: lua51
name: micro
globals:
  import:
    args:
      - type: string
        required: true
  VERSION:
    any: true
  init:
    any: true
  preinit:
    any: true
  postinit:
    any: true
  onRune:
    any: true
  onSetActive:
    any: true
  onBufferOpen:
    any: true
  onBufPaneOpen:
    any: true
  onCursorUp:
    any: true
  onCursorDown:
    any: true
  onCursorPageUp:
    any: true
  onCursorPageDown:
    any: true
  onCursorLeft:
    any: true
  onCursorRight:
    any: true
  onCursorStart:
    any: true
  onCursorEnd:
    any: true
  onSelectToStart:
    any: true
  onSelectToEnd:
    any: true
  onSelectUp:
    any: true
  onSelectDown:
    any: true
  onSelectLeft:
    any: true
  onSelectRight:
    any: true
  onSelectToStartOfText:
    any: true
  onSelectToStartOfTextToggle:
    any: true
  onWordRight:
    any: true
  onWordLeft:
    any: true
  onSelectWordRight:
    any: true
  onSelectWordLeft:
    any: true
  onMoveLinesUp:
    any: true
  onMoveLinesDown:
    any: true
  onDeleteWordRight:
    any: true
  onDeleteWordLeft:
    any: true
  onSelectLine:
    any: true
  onSelectToStartOfLine:
    any: true
  onSelectToEndOfLine:
    any: true
  onInsertNewline:
    any: true
  onInsertSpace:
    any: true
  onBackspace:
    any: true
  onDelete:
    any: true
  onCenter:
    any: true
  onInsertTab:
    any: true
  onSave:
    any: true
  onSaveAll:
    any: true
  onSaveAs:
    any: true
  onFind:
    any: true
  onFindLiteral:
    any: true
  onFindNext:
    any: true
  onFindPrevious:
    any: true
  onDiffPrevious:
    any: true
  onDiffNext:
    any: true
  onUndo:
    any: true
  onRedo:
    any: true
  onCopy:
    any: true
  onCopyLine:
    any: true
  onCut:
    any: true
  onCutLine:
    any: true
  onDuplicateLine:
    any: true
  onDeleteLine:
    any: true
  onIndentSelection:
    any: true
  onOutdentSelection:
    any: true
  onOutdentLine:
    any: true
  onIndentLine:
    any: true
  onPaste:
    any: true
  onSelectAll:
    any: true
  onOpenFile:
    any: true
  onStart:
    any: true
  onEnd:
    any: true
  onPageUp:
    any: true
  onPageDown:
    any: true
  onSelectPageUp:
    any: true
  onSelectPageDown:
    any: true
  onHalfPageUp:
    any: true
  onHalfPageDown:
    any: true
  onStartOfLine:
    any: true
  onEndOfLine:
    any: true
  onStartOfText:
    any: true
  onStartOfTextToggle:
    any: true
  onParagraphPrevious:
    any: true
  onParagraphNext:
    any: true
  onToggleHelp:
    any: true
  onToggleDiffGutter:
    any: true
  onToggleRuler:
    any: true
  onJumpLine:
    any: true
  onClearStatus:
    any: true
  onShellMode:
    any: true
  onCommandMode:
    any: true
  onQuit:
    any: true
  onQuitAll:
    any: true
  onAddTab:
    any: true
  onPreviousTab:
    any: true
  onNextTab:
    any: true
  onNextSplit:
    any: true
  onUnsplit:
    any: true
  onVSplit:
    any: true
  onHSplit:
    any: true
  onPreviousSplit:
    any: true
  onToggleMacro:
    any: true
  onPlayMacro:
    any: true
  onSuspend:
    any: true
  onScrollUp:
    any: true
  onScrollDown:
    any: true
  onSpawnMultiCursor:
    any: true
  onSpawnMultiCursorUp:
    any: true
  onSpawnMultiCursorDown:
    any: true
  onSpawnMultiCursorSelect:
    any: true
  onRemoveMultiCursor:
    any: true
  onRemoveAllMultiCursors:
    any: true
  onSkipMultiCursor:
    any: true
  onJumpToMatchingBrace:
    any: true
  onAutocomplete:
    any: true
  preRune:
    any: true
  preCursorUp:
    any: true
  preCursorDown:
    any: true
  preCursorPageUp:
    any: true
  preCursorPageDown:
    any: true
  preCursorLeft:
    any: true
  preCursorRight:
    any: true
  preCursorStart:
    any: true
  preCursorEnd:
    any: true
  preSelectToStart:
    any: true
  preSelectToEnd:
    any: true
  preSelectUp:
    any: true
  preSelectDown:
    any: true
  preSelectLeft:
    any: true
  preSelectRight:
    any: true
  preSelectToStartOfText:
    any: true
  preSelectToStartOfTextToggle:
    any: true
  preWordRight:
    any: true
  preWordLeft:
    any: true
  preSelectWordRight:
    any: true
  preSelectWordLeft:
    any: true
  preMoveLinesUp:
    any: true
  preMoveLinesDown:
    any: true
  preDeleteWordRight:
    any: true
  preDeleteWordLeft:
    any: true
  preSelectLine:
    any: true
  preSelectToStartOfLine:
    any: true
  preSelectToEndOfLine:
    any: true
  preInsertNewline:
    any: true
  preInsertSpace:
    any: true
  preBackspace:
    any: true
  preDelete:
    any: true
  preCenter:
    any: true
  preInsertTab:
    any: true
  preSave:
    any: true
  preSaveAll:
    any: true
  preSaveAs:
    any: true
  preFind:
    any: true
  preFindLiteral:
    any: true
  preFindNext:
    any: true
  preFindPrevious:
    any: true
  preDiffPrevious:
    any: true
  preDiffNext:
    any: true
  preUndo:
    any: true
  preRedo:
    any: true
  preCopy:
    any: true
  preCopyLine:
    any: true
  preCut:
    any: true
  preCutLine:
    any: true
  preDuplicateLine:
    any: true
  preDeleteLine:
    any: true
  preIndentSelection:
    any: true
  preOutdentSelection:
    any: true
  preOutdentLine:
    any: true
  preIndentLine:
    any: true
  prePaste:
    any: true
  preSelectAll:
    any: true
  preOpenFile:
    any: true
  preStart:
    any: true
  preEnd:
    any: true
  prePageUp:
    any: true
  prePageDown:
    any: true
  preSelectPageUp:
    any: true
  preSelectPageDown:
    any: true
  preHalfPageUp:
    any: true
  preHalfPageDown:
    any: true
  preStartOfLine:
    any: true
  preEndOfLine:
    any: true
  preStartOfText:
    any: true
  preStartOfTextToggle:
    any: true
  preParagraphPrevious:
    any: true
  preParagraphNext:
    any: true
  preToggleHelp:
    any: true
  preToggleDiffGutter:
    any: true
  preToggleRuler:
    any: true
  preJumpLine:
    any: true
  preClearStatus:
    any: true
  preShellMode:
    any: true
  preCommandMode:
    any: true
  preQuit:
    any: true
  preQuitAll:
    any: true
  preAddTab:
    any: true
  prePreviousTab:
    any: true
  preNextTab:
    any: true
  preNextSplit:
    any: true
  preUnsplit:
    any: true
  preVSplit:
    any: true
  preHSplit:
    any: true
  prePreviousSplit:
    any: true
  preToggleMacro:
    any: true
  prePlayMacro:
    any: true
  preSuspend:
    any: true
  preScrollUp:
    any: true
  preScrollDown:
    any: true
  preSpawnMultiCursor:
    any: true
  preSpawnMultiCursorUp:
    any: true
  preSpawnMultiCursorDown:
    any: true
  preSpawnMultiCursorSelect:
    any: true
  preRemoveMultiCursor:
    any: true
  preRemoveAllMultiCursors:
    any: true
  preSkipMultiCursor:
    any: true
  preJumpToMatchingBrace:
    any: true
  preAutocomplete:
    any: true