autocomplete-moose
MOOSE finite element framework input file autocompletions
dschwen 6,994 2 1.5.3 MIT GitHub

Services

This package provides:

Dependencies

  • fs-plus@>=3.1.0
  • web-tree-sitter@^0.16.4

MOOSE Autocomplete Package

Context sensitive Atom.io autocompletion for MOOSE Framework input files. Install autocomplete-plus before installing this package.

The MOOSE autocomplete plugin will automatically call your MOOSE-based app to obtain the input file syntax data. The syntax is cached and will be rebuilt if your app is recompiled. The MOOSE-based app (or a symbolic link pointing to the executable) must be in or (an arbitrary number of parent directory levels) above the directory of the current input file.

The plugin will automatically find an execute MOOSE-based apps on macOS and Linux. On Windows support for MOOSE-based apps built in WSL2 is built-in. If the current input file path is a WSL path (\\wsl$\MyDistribution\home\user\...) any discovered MOOSE-based app will be run through WSL to create a seamless experience.

A Fallback Moose Dir configuration option is available to point to a directory containing a MOOSE-based app executable that will be used in case the automatic discovery of a suitable executable fails.

Supported completions

All completions are context sensitive, i.e. only valid items are suggested for the current cursor position. The following completions are provided:

  • Block names and subblock names
  • Block type parameters with a selection of applicable Moose objects
    • Class documentation string is shown
  • Parameter names depending on the type of the current block
    • Parameter documentation string is shown
  • Parameter values (also for vector parameters) for
    • Variable names for non-linear and/or auxiliary variables
    • Function names for functions explicitly defined in the [Functions] block
    • UserObject, Postprocessor, and VectorPostprocessorName names
    • Valid options for MooseEnum and MultiMooseEnum parameters
    • Initial support for output types
    • Boolean types
    • Pre-fill default values

The plugin supports the legacy HIT syntax (with [../] subblock terminations) as well as the new HIT syntax with [] subblock terminations.

Screen shot

in action

Changes

Check the changelog on GitHub.