Sublime Text > Packages > User > formatter.assets > config

{
        // Enable debug mode to view errors in the console.
        // Accepted values: true (verbose), false, OR "status" (recommended)
        "debug": false,

        // Auto open the console panel whenever formatting fails.
        // This is useful if "debug" is "status" or true
        "open_console_on_failure": false,

        // The counterpart for success.
        "close_console_on_success": false,

        // Timeout to abort subprocess in seconds.
        // Default to 10 seconds. Set to false to disable the timeout.
        "timeout": 10,

        // Integrate your custom modules into the Formatter ecosystem.
        // Modules can be located either locally or remotely (with or without signing).
        // This option must be of type string pointing to the JSON metata file path.
        // More about the format of this file, see README.md > Integrating modules
        "custom_modules_manifest": "",

        // Display results in the status bar with the current settings mode info:
        // PUS: Persistent User Settings
        // PQO: Persistent Quick Options
        // TQO: Temporary Quick Options
        "show_statusbar": true,

        // Display a real-time word and character count in the status bar.
        // By default, whitespace is not included in the character count.
        "show_words_count": {
            "enable": true,
            "use_short_label": false,
            "ignore_whitespace_char": true
        },

        // Remember and restore cursor position, selections and bookmarks
        // each time a file is closed and re-opened.
        // This is helpful to resume your work from where you left off.
        // It does not remember any sublime sessions as name might suggest.
        "remember_session": true,

        // Configure the layout when opening new files.
        // This only takes effect if the "new_file_on_format" option is true.
        // Accepted values: "2cols", "2rows", "single" OR false
        "layout": {
            "enable": "2cols",
            "sync_scroll": true
        },

        // A set of directories where executable programs are located.
        // These can be absolute paths to module directories or Python zipfiles.
        // Any environment variables like PATH, PYTHONPATH, GEM_PATH, GOPATH,
        // GOROOT, GOBIN, TMPDIR, WHATEVER, etc. can be added here.
        // This is similar to running 'export PYTHONPATH="/path/to/my/site-packages"'
        // from the terminal. It is temporary, your system environment remains untouched.
        // On Windows, you can use either escaped backslashes (e.g., "C:\\a\\b\\c") or
        // forward slashes (e.g., "C:/a/b/c") as path separators for all other options.
        // Tip: Activating "print_on_console" will help to set the correct environment.
        "environ": {
            "print_on_console": false,
            "PATH": ["/path/to/erlang@22/bin:$PATH", "$PATH:/path/to/elixir/bin", "/path/to/.cache/rebar3/bin:$PATH"],
            "GEM_PATH": ["${HOME}/to/my/ruby"],
            "PYTHONPATH": ["${packages}/User/MyFolder/python/lib/python3.7/site-packages"],
            "OLALA": ["$HOME/.cabal/bin:$PATH", "~/.olala/bin:$PATH"]
        },

        // This option resolves the syntax conflicts described in "format_on_save".
        // It acts as an override and only applies to the following options:
        // 1. "format_on_save"
        // 2. "format_on_paste"
        // Syntaxes in this option always take precedence over the syntaxes specified there.
        // All syntaxes must be unique without any duplicates.
        "format_on_priority": {
            "enable": false,
            "csscomb": ["css"],
            "jsbeautifier": ["js"]
        },

        // This option enables auto-detect formatting for file.
        // Configure it here and/or by using the dot files in your working folder.
        // If both methods are used, the config from the dot files will override this embedded one.
        // Advantage: The embedded one can handle both saved and unsaved files,
        // while the dot files variant only applies to saved file, as unsaved files
        // (puffer on view) never has an working dir to contain dot files.
        //
        // For "format_on_save" and "format_on_paste" you can use a dictionary format to exclude.
        // "format_on_save": {
        //     "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
        //     "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
        //     "exclude_extensions_regex": ["ya?ml", "mjs", "json"]
        // }
        // More about this feature, see README.md > Auto-detect Formatting
        "auto_format": {
            "config": {
                "format_on_save": false,
                "format_on_paste": false
            },
            "json": {
                "uid": "jsbeautifier"
            },
            "html": {
                "uid": "jsbeautifier",
                "exclude_syntaxes": {
                    "html": ["markdown"]
                }
            },
            "python": {
                "uid": "autopep8"
            }
        },

        // THIRD-PARTY PLUGINS LEVEL
        // Info: Preferences > Package Settings > Formatter > Modules Info
        "formatters": {
            "examplemodule": { // MODULE METHOD
                // Plugin activation.
                // By default, all plugins are disabled.
                "enable": false,

                // Auto formatting whenever the current file is being saved.
                // This option should be used for plugins with unique syntaxes.
                // For multi plugins with the same syntaxes, the first plugin takes precedence.
                // Remove the identical syntaxes from one of the plugins to avoid conflicts.
                // For example:
                // Plugin A (enabled): syntaxes ["css", "js"]
                // Plugin B (enabled): syntaxes ["html", "css"]
                // In the case you want to use Plugin B with "css", then you should remove
                // the "css" from plugin A or just disable it, as there is no guarantee of the
                // execution order between the two, and determining your favorist is not possible.
                // Solution: Use the "format_on_priority" option to workaround this.
                //
                // By default, this option uses a boolean value: false OR true
                // To exclude files or dirs, use a dictionary format:
                // "format_on_save": {
                //     "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
                //     "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
                //     "exclude_extensions_regex": ["ya?ml", "mjs", "json"]
                // }
                "format_on_save": false,

                // Auto formatting whenever code is pasted into the current file.
                // This option affects the same way as "format_on_save".
                // So the mentioned syntax conflicts and solutions are the same.
                //
                // Also you can use the same dictionary format for exclusions:
                // "exclude_dirs_regex", "exclude_files_regex", "exclude_extensions_regex"
                "format_on_paste": false,

                // Create a new file containing formatted code.
                // The value of this option is the suffix of the new file being renamed.
                // Suffix must be of type string. =true, =false means =false
                // Note: It will overwrite any existing file that has the same new name in
                // the same location.
                // For example:
                // "new_file_on_format": "min", will create a new file:
                // myfile.raw.js -> myfile.raw.min.js
                "new_file_on_format": false,

                // Recursive directory formatting, regardless of depth.
                // This option requires an existing and currently opened file
                // to serve as the starting point.
                // - For the sake of convenience, two new folders will be created at
                //   the same level as the file, which will contain all failed and
                //   successfully formatted files.
                // - The "new_file_on_format" option can be used to rename files
                //   at the same time if needed.
                // - The "format_on_save" option above, which only works in the
                //   single-file mode, does not take effect here.
                // - All none-text files (binary) will be automatically ignored.
                // - To STOP the current formatting process, press any of the
                //   arrow keys (up, down, left, right) on your keyboard.
                // Any literal "$" must be escaped to "\\$" to distinguish it from
                // the variable expansion "${...}". This important rule applies
                // to the entire content of this settings file!
                "recursive_folder_format": {
                    "enable": false,
                    "exclude_folders_regex": ["Spotlight-V100", "temp", "cache", "logs", "^_.*foo\\$"],
                    "exclude_files_regex": ["^._.*$", ".*bar.exe"],
                    "exclude_extensions": ["DS_Store", "localized", "TemporaryItems", "Trashes", "db", "ini", "git", "svn", "tmp", "bak"],
                    "exclude_syntaxes": []
                },

                // Syntax support based on the scope name, not file extension.
                // Syntax name is part of the scope name and can be retrieved from:
                // Tools > Developer > Show Scope Name
                // End-users are advised to consult plugin manpages to add more syntaxes.
                "syntaxes": ["css", "html", "js", "php"],

                // Exclude a list of syntaxes for an individual syntax key.
                // A list of excluded syntaxes can be applied to all syntax definitions.
                // In this case, the key must be named: "all".
                // This option is useful to exclude part of the scope selector.
                // For example: text.html.markdown, want html but wish to filter out html.markdown.
                "exclude_syntaxes": {
                    "html": ["markdown"],
                    "all": ["markdown"]
                },

                // Path to the interpreter.
                // Omit this option will force Formatter to detect interpreter on PATH and
                // automatically set them for you.
                // Or you can set the basename as the interpreter name to search on PATH or
                // locally, similar to how it is done with the "executable_path" option.
                "interpreter_path": ["${HOME}/example/path/to\\$my/java.exe"],

                // Path to the plugin executable.
                // This option can be either a string or a list of executable paths.
                // - If this option is omitted or set to null, then the global executable
                //   on PATH will be used, OR the local executable if automatically found.
                // - If this option is exactly the basename, then it will be used as the
                //   executable name and searched for on the PATH.
                //   Basename can be with or without dot.extension as both variants are the same.
                //   For example: "fiLe.exe" (Windows only), "fiLe" (Windows + Unix + Linux)
                // System variable expansions like ${HOME}, ${USER} etc. and the Sublime Text
                // specific ${packages} can be used to assign paths.
                // Note: Again, any literal "$" must be escaped to "\\$" to distinguish
                // it from the variable expansion "${...}".
                "executable_path": ["${HOME}/example/path/to\\$my/php-cs-fixer.phar"],

                // Path to the config file for each individual syntaxes.
                // Syntax keys must match those in the "syntaxes" option above.
                // A single config file can be used to assign to all syntaxes.
                // In this case, the key must be named: "default"
                // - You can choose another config file format as the default one
                //   provided by Formatter if the third-party plugin supports it.
                // - Formatter provides a set of default config files under
                //   "formatter.assets/config" folder for your personal use.
                //   Do not use the reference files with suffix '.master.' directly.
                //   These files could be overwritten by any release updates.
                // - Options from this config file always have precedence over
                //   the options from any local project (per-project config dotfile).
                // - Disabling this option will force Formatter to auto resolve
                //   the per-project config dotfile in the file tree to use.
                // To disable this option:
                // 1. Set the config path of this option to null, OR
                // 2. Use the Quick Options: Ignore Config Path, OR
                // 3. Place an '.sublimeformatter.cfgignore.json' file inside
                //    the working root folder. The structure of this file is
                //    descripted in README.md > Auto-detect Formatting
                // Formatter will start to search up the file tree until a
                // '.sublimeformatter.cfgignore' file is found to bypass this option.
                "config_path": {
                    "css": "${packages}/User/formatter.assets/config/only_css_rc.json",
                    "php": "${packages}/User/formatter.assets/config/only_php_rc.json",
                    "default": "${packages}/User/formatter.assets/config/css_plus_js_plus_php_rc.json"
                },

                // Array of additional arguments for the command line.
                "args": ["--basedir", "./example/my/foo", "--show-bar", "yes"],

                // This option is specifically designed for type graphic.
                // It enables SVG image generation for saving.
                // Enable it if you need SVG image at the cost of processing time.
                // Unlike the generic method, this method only supports SVG generation.
                "render_extended": false,

                // Manipulate hardcoded command-line arguments.
                // This option allow you to modify hardcoded parameters, values and
                // their positions without digging into the source code.
                // This feature is primarily intended to temporarily fix bugs until
                // an official solution is implemented.
                // Note: Hardcoded args can be changed (rarely) by any release updates.
                // Enable debug mode will help to find all current hardcoded args.
                // Use "args" option above to add, this option to remove or manipulate.
                // Using regex: Again, any literal "$" must be escaped to "\\$" to
                // distinguish it from the variable expansion "${...}". Accepted args:
                // [search, [replace, [index, count, new position]]], where:
                // - search:   @type:str (regex)
                // - replace:  @type:str
                // - index:    @type:int (the number is known as a list index); required!
                // - count:    @type:int (the matching occurrences per index, 0 = all); required!
                // - position: @type:int (move old index pos. to new/old one, -1 = delete index); required!
                "fix_commands": [
                    ["--autocorrect", "--autocorrect-all", 4, 0, 4], // no index pos change
                    ["^.*?auto.*\\$", "--with", 4, 1, 5], // using escaped "\\$" regex, move index 4 to pos 5
                    ["${packages}/to/old", "${packages}/to/new", 3, 0, 3], // variable expansion, no escaped "$"
                    ["css", 5, 0, 7], // replace the value in index 5 with "css", move it to pos 7
                    [3, 0, 4], // just move index 3 to the new pos 4. (count 0 irrelevant)
                    [2, 0, -1], // just delete the index 2. (count 0 irrelevant)
                    ["--show-bar", "xxx", 2, 0, -1] // enough bar, pop it out. ("xxx", 2, 0 irrelevant)
                ]
            },
            "examplegeneric": { // GENERIC METHOD
                // Formatter provides 2 methods to add custom plugins:
                // - Generic: this one, you design the bridge yourself. Suitable for simple tasks.
                // - Modules: requires writing Python modules for complex tasks.
                // Note: The Generic method requires a Sublime Text restart after adding or changing
                // the "name" and "type" keys. Also, avoid reusing existing UID keys in JSON.

                // The capitalized Plugin name (REQUIRED!)
                // This will appear in the Sublime menu and other commands.
                "name": "Example Generic",

                // The plugin type (REQUIRED!)
                // This will categorize the plugin. Accepted values:
                // "beautifier", "minifier", "converter", "graphic", or any string of your choice.
                "type": "beautifier",

                // This will activate the "args_extended" option for the graphic type
                // to generate extended files like SVG for saving.
                "render_extended": false,

                // The exit code for the third-party plugin (optional, default is 0).
                "success_code": 0,

                // Same as the one in the examplemodule.
                "enable": false,
                // Same as the one in the examplemodule.
                "format_on_save": false,
                // Same as the one in the examplemodule.
                "format_on_paste": false,
                // Same as the one in the examplemodule, but disabled/unused for type graphic.
                "new_file_on_format": false,
                // Same as the one in the examplemodule, but disabled/unused for type graphic.
                "recursive_folder_format": {},
                // Same as the one in the examplemodule.
                "syntaxes": ["css", "html", "js", "php"],
                // Same as the one in the examplemodule.
                "exclude_syntaxes": {},
                // Same as the one in the examplemodule.
                "interpreter_path": ["${HOME}/example/path/to\\$my/php.exe"],
                // Same as the one in the examplemodule.
                "executable_path": ["${HOME}/example/path/to\\$my/php-cs-fixer.phar"],
                // Same as the one in the examplemodule.
                "config_path": {
                    "css": "${packages}/User/formatter.assets/config/only_css_rc.json",
                    "php": "${packages}/User/formatter.assets/config/only_php_rc.json",
                    "default": "${packages}/User/formatter.assets/config/css_plus_js_plus_php_rc.json"
                },

                // Main commands to trigger the formatting process.
                // You can either set the qualified paths directly or use variable substitution for:
                // - "interpreter_path"   : "{{i}}"
                // - "executable_path"    : "{{e}}", "{{e=node}}" (for local executable auto-resolving with runtime type node)
                // - "config_path"        : "{{c}}"
                // - SPECIAL CASE GRAPHIC : "{{o}}" (output PNG image, e.g: "args": [... "--output", "{{o}}"])
                // Variable substitution provides advanced mechanisms such as auto-search path, auto-config, etc.
                // SPECIAL CASE GRAPHIC requirements:
                // 1. The plugin must support exporting PNG format.
                // 2. The hardcoded "{{o}}" MUST ALWAYS be included in "args".
                //    You might regret using your own path instead of "{{o}}" or daring to omit "{{o}}" in this case.
                // In all other cases, output may not be as a file; use "-" or "--" instead.
                "args": ["{{i}}", "{{e=node}}", "--config", "{{c}}", "--basedir", "./example/my/foo", "--"],

                // This is for the SPECIAL CASE GRAPHIC to saving extended graphic files.
                // To use this, the trigger option "render_extended" above must be activated.
                // Sublime Text only supports PNG, JPG, and GIF images. Formatter uses PNG to display
                // image in view and generates the same image in various formats for you.
                // WARNING: Formatter will loop subprocess to render extended files. This means, process
                // will takes more time. This option might be useful for the final step to production.
                // "key":["value",..], where key is the output file extension, value is the command arguments.
                "args_extended": {
                    "svg": ["{{e}}", "--config", "{{c}}", "--blabla-format", "svgv5", "--output", "{{o}}"],
                    "pdf": ["{{e}}", "--config", "{{c}}", "--blabla-format", "pdf2001", "--output", "{{o}}"]
                }
            },
            // -- END of explanation --
        }
   }

{
        "debug": true,

        "environ": {
            "print_on_console": true,
            "PATH": ["/path/to/erlang@22/bin:$PATH", "$PATH:/path/to/elixir/bin", "/path/to/.cache/rebar3/bin:$PATH"],
            "GEM_PATH": ["${HOME}/to/my/ruby"],
            "PYTHONPATH": ["${packages}/User/MyFolder/python/lib/python3.7/site-packages"],
            "OLALA": ["$HOME/.cabal/bin:$PATH", "~/.olala/bin:$PATH"]
        },

        "formatters": {
            "stylelint": {  // EXAMPLE: MODULE METHOD
                "info": "https://github.com/stylelint/stylelint",
                "enable": true,
                "format_on_paste": false,
                "format_on_save": false,
                "new_file_on_format": false,
                "recursive_folder_format": {
                    "enable": false,
                    "exclude_folders_regex": ["Spotlight-V100", "temp", "cache", "logs", "^_.*foo\\$"],
                    "exclude_files_regex": ["^._.*$", ".*bar.exe"],
                    "exclude_extensions": ["DS_Store", "localized", "TemporaryItems", "Trashes", "db", "ini", "git", "svn", "tmp", "bak"],
                    "exclude_syntaxes": []
                },
                "syntaxes": ["css", "scss", "sass", "less", "sss", "sugarss"],
                "executable_path": ["${packages}/User/myjs/node_modules/.bin/stylelint"],
                "args": ["--config-basedir", "/path/to/js/node_modules"],
                "config_path": {
                    "default": "${packages}/User/formatter.assets/config/stylelint_rc.json"
                }
            },
            "uncrustify": {  // EXAMPLE: GENERIC METHOD: Text-to-Text. Restart ST.
                "name": "Uncrustify",
                "type": "beautifier",
                "success_code": 0,
                "args": ["{{e}}", " --style=file:{{c}} ", "--"],

                "info": "https://github.com/uncrustify/uncrustify",
                "enable": true,
                "format_on_save": false,
                // "new_file_on_format": false, // Add this, if needed
                // "recursive_folder_format": {...} // Add this, if needed
                "syntaxes": ["c", "c++", "cs", "objc", "objc++", "d", "java", "pawn", "vala"],
                "executable_path": ["${HOME}/path/to/bin/uncrustify"],
                "config_path": {
                    "objc": "${packages}/User/formatter.assets/config/uncrustify_objc_rc.cfg",
                    "objc++": "${packages}/User/formatter.assets/config/uncrustify_objc_rc.cfg",
                    "java": "${packages}/User/formatter.assets/config/uncrustify_sun_java_rc.cfg",
                    "default": "${packages}/User/formatter.assets/config/uncrustify_rc.cfg"
                }
            },
            "d2": {  // EXAMPLE: GENERIC METHOD: Text-to-Image. Restart ST.
                "name": "D2",
                "type": "graphic",
                "success_code": 0,
                "render_extended": true,

                "info": "https://github.com/terrastruct/d2",
                "enable": true,
                "format_on_save": false,
                "format_on_paste": false,
                "syntaxes": ["d2"],
                "args": ["{{e}}", "--theme", "300", "--dark-theme", "200", "-l", "elk", "--pad", "0", "-", "{{o}}"],
                "args_extended": {
                    "svg": ["{{e}}", "--theme", "300", "--dark-theme", "200", "-l", "elk", "--pad", "0", "-", "{{o}}"],
                    "pdf": ["{{e}}", "--theme", "300", "--dark-theme", "200", "-l", "elk", "--pad", "0", "-", "{{o}}"]
                },
                "executable_path": "/path/to/bin/d2",
                "config_path": {
                    "default": "${packages}/User/formatter.assets/config/d2_rc.yaml"
                }
            }
        }
   }

{
       // Comments are allowed.
       "json": {
           "uid": "jsbeautifier"
       },
       "html": {
           "uid": "jsbeautifier",
           "exclude_syntaxes": {
               "html": ["markdown"]
           }
       },
       "python": {
           "uid": "autopep8"
       }
   }

{
       "format_on_save": true,
       "format_on_paste": false
   }

{
       "format_on_save": {
           "exclude_dirs_regex": [".*(\\.git|node_modules|__pycache__|env).*", ".*/project/test"],
           "exclude_files_regex": [".*test_file\\.py\\$", ".*/project/test/config\\.json"],
           "exclude_extensions_regex": ["ya?ml", "mjs", "json"]
       },
       "format_on_paste": false
   }

{
       "json": ["jsbeautifier", "deno"],
       "python": ["autopep8"],
       "default": ["scalafmt", "stylelint"]
   }

{
       "debug": "status",

       "auto_format": {
           "config": {
               "format_on_save": false,  // or use the dictionary format to exclude
               "format_on_paste": false  // or use the dictionary format to exclude
           },
           "json": {
               "uid": "jsbeautifier"
           },
           "html": {
               "uid": "jsbeautifier",
               "exclude_syntaxes": {
                   "html": ["markdown"]
               }
           },
           "python": {
               "uid": "autopep8"
           }
       },

       "formatters": {}
   }

{
    "folders": [
        {
            "path": "/path/to/my/project"
        }
    ],

    "settings": {
        "Formatter": {
            "debug": "status",
            "formatters": {
                "htmltidy": {
                    "format_on_save": true
                },
                "jsbeautifier": {
                    "config_path": {
                        "default": "${HOME}/path/to/new/jsbeautify_rc.json"
                    }
                }
            }
        }
    }
}

Sublime Text > View > Syntax

Syntax out of the scope.

Formatter > config

{
       "debug": true,  // printing error messages
       "dev": true     // updating modified files
       ...
   }

INTERPRETERS = []                                           # optional: fallback list of interpreter names
   EXECUTABLES = []                                            # REQUIRED: fallback list of executable names
   DOTFILES = []                                               # optional: names list of the per-project config dotfiles
   MODULE_CONFIG = {}                                          # REQUIRED: template to create several sublime config files


   class ThisismyfirstpluginmoduleFormatter(Module):           # REQUIRED: the Capitalized of uid and the Capitalized word "Formatter", nothing else!
       def __init__(self, *args, **kwargs):
           super().__init__(*args, **kwargs)                   # REQUIRED: initialize the module APIs from common.Module

       def get_cmd(self):                                      # optional: get commands, e.g get the "config_path", "executable_path" etc...

       def format(self):                                       # REQUIRED: the entry point, predefined function name exact as written

from .. import log                                          # REQUIRED: log to debugging this file
   from ..core.common import Module                            # REQUIRED: a collection of APIs to assist in running this file


   INTERPRETERS = ['node']                                     # optional: case-sensitive fallback names (without extension) if interpreter is not found
   EXECUTABLES = ['terser']                                    # optional: case-sensitive fallback names (without extension) if executable is not found
   DOTFILES = ['.terser.json']                                 # optional: to auto-resolve the per-project config dotfile if "config_path" is disabled
   MODULE_CONFIG = {                                           # REQUIRED: template to create several sublime config files
       'source': 'https://thirdparty-plugin.com',              # REQUIRED: info on where the user can download the plugin
       'name': 'My First Plugin',                              # REQUIRED: a Capitalized plugin name of your choice, preferably short and comprehensive
       'uid': 'thisismyfirstpluginmodule',                     # REQUIRED: must match the suffix of "formatter_thisismyfirstpluginmodule.py"
       'type': 'minifier',                                     # REQUIRED: "beautifier" OR "minifier" OR "converter" OR "graphic",
                                                               #           OR any string of your choice (for private purposes).
       'syntaxes': ['js', 'html'],                             # REQUIRED: array of syntaxes, obtained from: Tools > Developer > Show Scope Name
       'exclude_syntaxes': {                                   # optional: blacklist syntaxes per syntax or None to omit it.
           'html': ['markdown']
       },
       "interpreter_path": ["/path/to/bin/node"],              # optional: use an empty string "" to include this key in config files or None to omit it
       "executable_path": ["/path/to/bin/terser"],             # optional: use an empty string "" to include this key in config files or None to omit it
       'args': None,                                           # optional: an array ['arg1', 'args2', ...] to include this key in config files or None to omit it
       'config_path': {                                        # optional: a dictionary to include this key in config files or None to omit it
           'js': 'my_first_plugin_js_rc.json'                  # optional: a key-value pair or just omit it. See Formatter.sublime-settings for explanation
           'default': 'my_first_plugin_rc.json'                # optional: a key-value pair or just omit it. See Formatter.sublime-settings for explanation
       },
       'comment': 'build-in, no executable'                    # optional: a single short comment, limited to 200 chars or just omit it
   }


   class ThisismyfirstpluginmoduleFormatter(Module):           # REQUIRED: the Capitalized of uid and the Capitalized word "Formatter", nothing else!
       def __init__(self, *args, **kwargs):                    # REQUIRED: initialization
           super().__init__(*args, **kwargs)                   # REQUIRED: initialize the module APIs from common.Module

       def get_cmd(self):                                      # optional: get commands e.g get the "config_path", "executable_path" etc...
           cmd = self.get_combo_cmd(runtime_type='node')       # See API below
           if not cmd:
               return None

           path = self.get_config_path()                       # See API below
           if path:
               cmd.extend(['--config-file', path])             # an array of args to run the third-party plugin

           cmd.extend(['--compress', '--mangle', '--'])

           # cmd.extend(['--output', self.get_output_image()]) # REQUIRED: only for special case of "type": "graphic"

           return cmd

       def format(self):                                       # REQUIRED: the entry point, predefined function name exact as written
           cmd = self.get_cmd()

           try:
               exitcode, stdout, stderr = self.exec_cmd(cmd)   # REQUIRED: process command

               if exitcode > 0:                                # REQUIRED: please consult the plugin documentation for the exit codes
                   self.print_exiterr(exitcode, stderr)
               else:
                   # if self.is_render_extended():             # is render extended mode activated?
                   #     cmd = self.all_png_to_svg_cmd(cmd)
                   #     try:
                   #         self.exec_cmd(cmd)                # REQUIRED: only for special case of "type": "graphic" to generate SVG image.
                   #     except Exception as e:
                   #         log.error('Error: %s', e)

                   return stdout                               # REQUIRED: return the formatted code on success
           except OSError:
               self.print_oserr(cmd)

           return None                                         # REQUIRED: return None to indicate failure

{
    "custom_modules_manifest": "/path/to/local/metadata.json",  // or
    "custom_modules_manifest": "https://raw.githubusercontent.com/you/repo/main/metadata.json",
}

{
    "version": "0.0.1",                              // tells to update
    "ca_cert": "/path/to/ca_cert.pem",               // optional, CA Certificate path for ssl
    "public_key": "/path/to/public_key.asc",         // optional, but required for .sig file
    "gpg": "gpg.exe (on PATH) or /path/to/gpg.exe",  // optional, omit this to auto-detect gpg on PATH
    "local": {
        "config": ["/path/to/dir", "/path/to/file"],
        "libs": ["/path/to/dir", "/path/to/file"],
        "modules": ["/path/to/dir", "/path/to/file"]
    },
    "remote": [
        "http|s|ftp://example.com/archive/refs/heads/myproject1.zip",      // only zip or tar.gz
        "http|s|ftp://example.com/archive/refs/heads/myproject1.zip.sig",  // optional, but pattern: filename + '.sig'
        "http|s|ftp://example.com/archive/refs/heads/myproject2.tar.gz",
        "http|s|ftp://example.com/archive/refs/heads/myproject2.tar.gz.sig"
    ]
}

# This alias method combines get_interpreter() and get_executable().
   # Set runtime_type=(None|'node'|'python'|'perl'|'ruby') to enable local executable search.
   # Currently, only None and 'node' are functional. All others are placeholders for future use.
   cmd = self.get_iprexe_cmd(runtime_type=None)

   # This alias method just extends get_iprexe_cmd() with get_args().
   cmd = self.get_combo_cmd(runtime_type=None)

   # Get the interpreter path or None.
   interpreter = self.get_interpreter()

   # Get the executable path or None.
   # Set runtime_type=(None|'node'|'python'|'perl'|'ruby') to enable local executable search.
   executable = self.get_executable(runtime_type=None)

   # Get the input arguments "args" from the User settings or None.
   args = self.get_args()

   # Get the input "config_path" from the User settings or
   # the path of the per-project config dotfile if found or None.
   path = self.get_config_path()

   # Get the current text content in view or the current selected text.
   text = self.get_text_from_region(self.region)

   # Get the detected syntax of the current file or None.
   syntax = self.get_assigned_syntax()

   # Get the path to the output PNG image. Applicable only to the special case of type: graphic
   output_image = self.get_output_image()

   # Get a dictionary of file path components:
   # {'path':, 'cwd':, 'base':, 'stem':, 'suffix':, 'ext':} or None.
   components = self.get_pathinfo()

   # Create and get the temp file path.
   # Useful for plugins lacking a built-in mechanism to fix files inplace.
   tmp_file = self.create_tmp_file(suffix=None)

   # Remove temp file.
   self.remove_tmp_file(tmp_file)

# To replace cmd list items to generate SVG file for download.
   # It is applicable only to the special case of type: graphic.
   # Note: extended_cmd MUST be executed right before return stdout (=success)!
   extended_cmd = self.ext_png_to_svg_cmd(cmd)  # replace extension .png -> .svg
   extended_cmd = self.all_png_to_svg_cmd(cmd)  # replace all occurred png -> svg

   # To process the formatting with all input (fixed) arguments.
   # stdout as PIPE. 99% of plugins use this way.
   exitcode, stdout, stderr = self.exec_cmd(cmd)

   # stdout as file. 1% are just retarded.
   exitcode, stdout, stderr = self.exec_cmd(cmd, outfile='/path/to/save/outfile')

   # To print formatting exit error.
   self.print_exiterr(exitcode, stderr)

   # To print executing commands error.
   self.print_oserr(cmd)