Source code format (.rb)

Product copy held in source files, such as package descriptions and installer notes.

IDsourcecode

SourcePlugin

Extensions.rb

MIME Typestext/x-ruby

CapabilitiesRead

Parameters

Parameter	Type	Default	Description
comments	boolean	false	Read the file's comments as well as its strings, each comment one block named for what it documents, without its markers and with the directives tools read set aside. Off by default: a comment is written for the next person reading the code, and holding it to the register of published prose is a separate decision from holding a product string to it.
language	string	""	The grammar to parse with, by name (for example "ruby"). Empty picks the grammar from the file's extension, which is the usual case; set it when the file reaches the reader without a name or the extension is ambiguous.
nodePathPatterns	string[]	[]	The calls whose arguments hold prose, e.g. ["desc", "caveats"] for a Homebrew cask. The analogue of the JSON and YAML readers' key paths: a recipe already says which keys of a config file hold sentences, and says the same thing here about a call. Empty extracts every string the grammar exposes, which is how you find out what a file holds before narrowing it.

Configure it live

Configuration

Loading form…

Configuration output

vs defaults no changes

apiVersion: neokapi/v1
kind: SourcecodeFormatConfig
metadata:
  name: sourcecode
spec:
  # (default configuration)

← Back to the Format Reference