bluehawk

Namespaces

• tokens

Enumerations

• LogLevel

Classes

• Bluehawk
• ConsoleActionReporter
• Document
• RootParser

Interfaces

• ActionArgs
• ActionReporter
• AnyTag
• BlockCommentTokenConfiguration
• BlockTagNode
• CheckArgs
• CheckResult
• CopyArgs
• EmphasizeRange
• EmphasizeSourceAttributes
• IParser
• IVisitor
• LanguageSpecification
• LineTagNode
• ListStatesArgs
• ListTagArgs
• ParseResult
• PayloadQuery
• PluginArgs
• ProcessOptions
• ProcessRequest
• Project
• PushParserPayload
• PushParserTokenConfiguration
• SnipArgs
• VisitorResult

Type Aliases

AnyTagNode

Ƭ AnyTagNode: LineTagNode | BlockTagNode

Defined in

bluehawk/parser/TagNode.ts:63

---

BinaryFileEvent

Ƭ BinaryFileEvent: FileEvent

Defined in

bluehawk/actions/ActionReporter.ts:51

---

BluehawkErrorsEvent

Ƭ BluehawkErrorsEvent: FileEvent & { errors: BluehawkError[] }

Defined in

bluehawk/actions/ActionReporter.ts:90

---

CopyArgsCli

Ƭ CopyArgsCli: Omit<CopyArgs, "rename"> & { rename?: string }

Defined in

bluehawk/actions/copy.ts:22

---

FileErrorEvent

Ƭ FileErrorEvent: FileEvent & { error: Error }

Defined in

bluehawk/actions/ActionReporter.ts:82

---

FileEvent

Ƭ FileEvent: Object

Type declaration

Name	Type
inputPath	string

Defined in

bluehawk/actions/ActionReporter.ts:47

---

FileParsedEvent

Ƭ FileParsedEvent: FileEvent & { parseResult: ParseResult }

Defined in

bluehawk/actions/ActionReporter.ts:53

---

FileWrittenEvent

Ƭ FileWrittenEvent: FileEvent & { outputPath: string ; type: "text" | "binary" }

Defined in

bluehawk/actions/ActionReporter.ts:57

---

IdRequiredAttributes

Ƭ IdRequiredAttributes: Object

Type declaration

Name	Type
id	string[]

Defined in

bluehawk/tags/Tag.ts:115

---

IdsRequiredAttributes

Ƭ IdsRequiredAttributes: Object

Type declaration

Name	Type
id	string[]

Defined in

bluehawk/tags/Tag.ts:131

---

IdsUnusedEvent

Ƭ IdsUnusedEvent: Object

Type declaration

Name	Type
ids	string[]
paths	string[]

Defined in

bluehawk/actions/ActionReporter.ts:73

---

Listener

Ƭ Listener: (result: ProcessResult) => void | Promise<void>

Type declaration

▸ (result): void | Promise<void>

Parameters

Name	Type
result	ProcessResult

Returns

void | Promise<void>

Defined in

bluehawk/processor/Processor.ts:102

---

LoadedPlugin

Ƭ LoadedPlugin: Plugin & { path: string }

Defined in

bluehawk/Plugin.ts:34

---

NoAttributes

Ƭ NoAttributes: null

Defined in

bluehawk/tags/Tag.ts:141

---

OnBinaryFileFunction

Ƭ OnBinaryFileFunction: (file: string) => void | Promise<void>

Type declaration

▸ (file): void | Promise<void>

Parameters

Name	Type
file	string

Returns

void | Promise<void>

Defined in

bluehawk/OnBinaryFileFunction.ts:1

---

ParserNotFoundEvent

Ƭ ParserNotFoundEvent: FileEvent & { error: Error }

Defined in

bluehawk/actions/ActionReporter.ts:78

---

Plugin

Ƭ Plugin: Object

A plugin is a Node module that exports a register() function.

A plugin can be a simple JS file or a transpiled Node module, as long as it exports the register() function:

  // MyPlugin.js
  exports.register = (args) => {
    // Add a new CLI option
    args.yargs.option("myNewOption", { string: true });

    // Add Bluehawk listener
    args.bluehawk.subscribe((result) => {
      console.log("Plugin called for file", result.document.path);
    });
  };

You can then call bluehawk --plugin /path/to/MyPlugin.js to use the plugin.

Type declaration

Name	Type
register	(args: PluginArgs) => void | Promise<void>

Defined in

bluehawk/Plugin.ts:26

---

StateNotFoundEvent

Ƭ StateNotFoundEvent: Object

Type declaration

Name	Type
paths	string[]
state	string

Defined in

bluehawk/actions/ActionReporter.ts:68

---

StatesFoundEvent

Ƭ StatesFoundEvent: Object

Type declaration

Name	Type
action	string
paths	string[]
statesFound	string[]

Defined in

bluehawk/actions/ActionReporter.ts:62

---

WithActionReporter

Ƭ WithActionReporter<T>: T & { reporter: ActionReporter }

Creates a type with a required ActionReporter field.

Type parameters

Name
T

Defined in

bluehawk/actions/ActionReporter.ts:7

---

WriteFailedEvent

Ƭ WriteFailedEvent: FileWrittenEvent & { error: Error }

Defined in

bluehawk/actions/ActionReporter.ts:86

Variables

EmphasizeTag

• Const EmphasizeTag: AnyTag

Defined in

bluehawk/tags/EmphasizeTag.ts:19

---

IdRequiredAttributesSchema

• Const IdRequiredAttributesSchema: JSONSchemaType<IdRequiredAttributes>

Defined in

bluehawk/tags/Tag.ts:116

---

IdsRequiredAttributesSchema

• Const IdsRequiredAttributesSchema: JSONSchemaType<IdsRequiredAttributes>

Defined in

bluehawk/tags/Tag.ts:132

---

NoAttributesSchema

• Const NoAttributesSchema: JSONSchemaType<NoAttributes>

Defined in

bluehawk/tags/Tag.ts:142

---

RENAME_ERR

• Const RENAME_ERR: "Rename flag does not support specifying a path argument. If you would like to see this functionality, please submit an issue or pull request."

Defined in

bluehawk/actions/copy.ts:24

---

RemoveTag

• Const RemoveTag: AnyTag

Defined in

bluehawk/tags/RemoveTag.ts:3

---

ReplaceTag

• Const ReplaceTag: AnyTag

Defined in

bluehawk/tags/ReplaceTag.ts:10

---

SnippetTag

• Const SnippetTag: AnyTag

Defined in

bluehawk/tags/SnippetTag.ts:65

---

StateRemoveTag

• Const StateRemoveTag: AnyTag

Defined in

bluehawk/tags/StateRemoveTag.ts:9

---

StateTag

• Const StateTag: AnyTag

Defined in

bluehawk/tags/StateTag.ts:10

---

System

• Const System: Object

Type declaration

Name	Type
fs	__module
useJsonFs	(directoryJson: DirectoryJSON) => void
useMemfs	() => void
useRealfs	() => void

Defined in

bluehawk/io/System.ts:7

---

UncommentTag

• Const UncommentTag: AnyTag

Defined in

bluehawk/tags/UncommentTag.ts:6

Functions

check

▸ check(args): Promise<void>

Parameters

Name	Type
args	WithActionReporter<CheckArgs>

Returns

Promise<void>

Defined in

bluehawk/actions/check.ts:15

---

commandDir

▸ commandDir<T>(argv, directory, options?): yargs.Argv<T>

Loads a directory as yargs commands while supporting TypeScript for development. See yargs.commandDir().

Type parameters

Name
T

Parameters

Name	Type
argv	Argv<T>
directory	string
options?	RequireDirectoryOptions

Returns

yargs.Argv<T>

Defined in

bluehawk/Plugin.ts:106

---

conditionalForkWithState

▸ conditionalForkWithState(request): void

If we are not processing in a state file, fork a file for each state listed in our tag node.

Parameters

Name	Type
request	ProcessRequest<BlockTagNode>

Returns

void

Defined in

bluehawk/tags/StateTag.ts:31

---

copy

▸ copy(args): Promise<void>

Parameters

Name	Type
args	WithActionReporter<CopyArgs>

Returns

Promise<void>

Defined in

bluehawk/actions/copy.ts:27

---

createFormattedCodeBlock

▸ createFormattedCodeBlock(«destructured»): Promise<void>

Parameters

Name	Type
«destructured»	Object
› format	string
› output	string
› reporter	ActionReporter
› result	ProcessResult

Returns

Promise<void>

Defined in

bluehawk/actions/snip.ts:20

---

flatten

▸ flatten<T>(node): T[]

Type parameters

Name	Type
T	extends Object

Parameters

Name	Type
node	T

Returns

T[]

Defined in

bluehawk/parser/flatten.ts:2

---

formatInDocusaurus

▸ formatInDocusaurus(result): Promise<undefined | string>

Parameters

Name	Type
result	ProcessResult

Returns

Promise<undefined | string>

Defined in

bluehawk/actions/snip.ts:167

---

formatInMd

▸ formatInMd(result): undefined | string

Parameters

Name	Type
result	ProcessResult

Returns

undefined | string

Defined in

bluehawk/actions/snip.ts:154

---

formatInRst

▸ formatInRst(result): Promise<undefined | string>

Parameters

Name	Type
result	ProcessResult

Returns

Promise<undefined | string>

Defined in

bluehawk/actions/snip.ts:75

---

getBluehawk

▸ getBluehawk(): Promise<Bluehawk>

Returns a standard, shared Bluehawk instance.

Returns

Promise<Bluehawk>

Defined in

bluehawk/getBluehawk.ts:23

---

listStates

▸ listStates(args): Promise<void>

Parameters

Name	Type
args	WithActionReporter<ListStatesArgs>

Returns

Promise<void>

Defined in

bluehawk/actions/listStates.ts:12

---

listTags

▸ listTags(args): Promise<void>

Parameters

Name	Type
args	ListTagArgs

Returns

Promise<void>

Defined in

bluehawk/actions/listTags.ts:9

---

loadPlugins

▸ loadPlugins(path): Promise<LoadedPlugin[]>

Load the given plugin(s).

Parameters

Name	Type
path	undefined | string | string[]

Returns

Promise<LoadedPlugin[]>

Defined in

bluehawk/Plugin.ts:71

---

loadProjectPaths

▸ loadProjectPaths(project): Promise<string[]>

Parameters

Name	Type
project	Project

Returns

Promise<string[]>

Defined in

bluehawk/project/loadProjectPaths.ts:56

---

makeBlockCommentTokens

▸ makeBlockCommentTokens(startPattern, endPattern, configuration?): [TokenType, TokenType]

Parameters

Name	Type
startPattern	RegExp
endPattern	RegExp
configuration?	BlockCommentTokenConfiguration

Returns

[TokenType, TokenType]

Defined in

bluehawk/parser/lexer/makeBlockCommentTokens.ts:9

---

makeBlockOrLineTag

▸ makeBlockOrLineTag<AttributesType>(tag): AnyTag

Type parameters

Name
AttributesType

Parameters

Name	Type
tag	Tag & { attributesSchema: JSONSchemaType<AttributesType> ; process: (request: ProcessRequest<AnyTagNode>) => NotPromise }

Returns

AnyTag

Defined in

bluehawk/tags/Tag.ts:93

---

makeBlockTag

▸ makeBlockTag<AttributesType>(tag): AnyTag

Type parameters

Name
AttributesType

Parameters

Name	Type
tag	Tag & { attributesSchema: JSONSchemaType<AttributesType> ; process: (request: ProcessRequest<BlockTagNode>) => NotPromise }

Returns

AnyTag

Defined in

bluehawk/tags/Tag.ts:60

---

makeCstVisitor

▸ makeCstVisitor(parser, getParser?): IVisitor

Parameters

Name	Type
parser	RootParser
getParser?	(parserId: string) => undefined | IVisitor

Returns

IVisitor

Defined in

bluehawk/parser/visitor/makeCstVisitor.ts:44

---

makeLineCommentToken

▸ makeLineCommentToken(pattern): TokenType

Parameters

Name	Type
pattern	RegExp

Returns

TokenType

Defined in

bluehawk/parser/lexer/makeLineCommentToken.ts:4

---

makeLineTag

▸ makeLineTag(tag): AnyTag

Parameters

Name	Type
tag	Tag & { attributesSchema?: undefined ; process: (request: ProcessRequest<LineTagNode>) => NotPromise }

Returns

AnyTag

Defined in

bluehawk/tags/Tag.ts:77

---

makeParser

▸ makeParser(languageSpecification): IParser

Parameters

Name	Type
languageSpecification	LanguageSpecification

Returns

IParser

Defined in

bluehawk/parser/makeParser.ts:29

---

makePayloadPattern

▸ makePayloadPattern<PayloadType>(pattern, getPayload): ICustomPattern

Type parameters

Name
PayloadType

Parameters

Name	Type
pattern	RegExp
getPayload	(query: PayloadQuery) => PayloadType

Returns

ICustomPattern

Defined in

bluehawk/parser/lexer/makePayloadPattern.ts:20

---

makePushParserTokens

▸ makePushParserTokens(pushPattern, popPattern, configuration): [TokenType, TokenType]

Parameters

Name	Type
pushPattern	RegExp
popPattern	RegExp
configuration	PushParserTokenConfiguration

Returns

[TokenType, TokenType]

Defined in

bluehawk/parser/lexer/makePushParserTokens.ts:19

---

mapShorthandArgsToAttributes

▸ mapShorthandArgsToAttributes(«destructured»): void

Parameters

Name	Type
«destructured»	Object
› shorthandArgsAttributeName?	string
› tagNode	AnyTagNode

Returns

void

Defined in

bluehawk/tags/Tag.ts:147

---

removeMetaRange

▸ removeMetaRange(s, tagNode): MagicString

Parameters

Name	Type
s	default
tagNode	AnyTagNode

Returns

MagicString

Defined in

bluehawk/tags/removeMetaRange.ts:25

---

snip

▸ snip(args): Promise<void>

Parameters

Name	Type
args	WithActionReporter<SnipArgs>

Returns

Promise<void>

Defined in

bluehawk/actions/snip.ts:205

---

withGenerateFormattedCodeSnippetsOption

▸ withGenerateFormattedCodeSnippetsOption<T>(yargs): Argv<T & { generateFormattedCodeSnippets?: string }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { generateFormattedCodeSnippets?: string }>

Defined in

bluehawk/options.ts:68

---

withIdOption

▸ withIdOption<T>(yargs): Argv<T & { id?: string | string[] }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { id?: string | string[] }>

Defined in

bluehawk/options.ts:59

---

withIgnoreOption

▸ withIgnoreOption<T>(yargs): Argv<T & { ignore?: string | string[] }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { ignore?: string | string[] }>

Defined in

bluehawk/options.ts:28

---

withJsonOption

▸ withJsonOption<T>(yargs): Argv<T & { json?: boolean }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { json?: boolean }>

Defined in

bluehawk/options.ts:82

---

withLogLevelOption

▸ withLogLevelOption<T>(yargs): Argv<T & { logLevel?: number }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { logLevel?: number }>

Defined in

bluehawk/options.ts:92

---

withOutputOption

▸ withOutputOption<T>(yargs): Argv<T & { output: string }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { output: string }>

Defined in

bluehawk/options.ts:16

---

withRenameOption

▸ withRenameOption<T>(yargs): Argv<T & { rename?: string }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { rename?: string }>

Defined in

bluehawk/options.ts:49

---

withStateOption

▸ withStateOption<T>(yargs): Argv<T & { state?: string }>

Type parameters

Name
T

Parameters

Name	Type
yargs	Argv<T>

Returns

Argv<T & { state?: string }>

Defined in

bluehawk/options.ts:39