Pretty-gd-js NPM

pretty.gd for JavaScript

pretty godot

A formatter for GDScript that just works!

Usage

Command line

$ npm install -g pretty-gd-js

$ pretty.gd --help
Usage: pretty.gd [options] [path] [files...]

Options:
  -s, --spaces <size>  enforce (or, if -t is also set, convert from) space-based indentation
  -t, --tabs           enforce tab-based indentation
  -p, --stdio          read from stdin and write it prettified to stdout
  -d, --dir            prettify all *.gd files in [path]
  -w, --watch          automatically prettify any modified *.gd files in [path]
  -v, --version        display version
  -h, --help           display help for command

JavaScript API

prettify(input: string, startInsideString: string = null): string
- input: string // The string of GDScript to make pretty.
- startInsideString: string // If set to a string delimiter, assume input is starting inside a string. Default is null.
isInsideString: string // If last operation ended inside a string, this will be set to the type of quotes of the string. Otherwise null.
indent: string // Indentation string. Default is null for auto-detect.
tabSize: number // Tab size. This will be overwritten if indent is set or detected to be space-based. Default is 4.

To parse a document line by line, remember to feed isInsideString back into the prettify() call as the second parameter.

Keep in mind that indent and tabSize will be preserved between calls to prettify(). If you want to auto-detect for each call, remember to reset these properties to null.

Example

import fs from "node:fs"
import pretty from "pretty-gd-js"

// configure indentation
pretty.indent = "\t"
pretty.tabSize = 4

let file = "my_script.gd"
let input = fs.readFileSync(file)
let output = pretty.prettify(input) // <- This is the main function
fs.writeFileSync(file, output + "\n")

Known Issues

If you come across any issues with using this software, please let me know.

Release Notes

1.15.0

In --watch mode, file changes will be delayed by one second to ensure Godot editor will detect it as an external change.
Added --stdio mode for piping data in and out.

1.14.2

Display version with --version.
Refactored to use ES modules instead of require.
Test tool that runs in the browser.
Fixed bug parsing multi-line strings.

1.14.1

If --dir or --watch are used without specifying a path, it will default to current directory.
Command-line tool will safely ignore files and folders it cannot access.

1.14.0

Number literals, including hexadecimals, will be corrected to lower case.
Support for all types of strings, including r"raw strings", '''triple-single-quoted strings''' and %"node strings".
Better handling of multiline strings of any type. API changed slightly.

1.13.1

Command line options to prettify entire folders.
not is no longer treated as a keyword that has to be surrounded by whitespace.
{ curly brackets } are now padded inside.
Vertical spacing gets adjusted. func and class declarations get two blank lines above them. Maximum one consecutive blank line everywhere else.