Index > stdlib

Exposes the standard library of Grit steps.

These actions are included:

• transform
• getContext
• readFile
• apply

A single match within a file. One file may have multiple matches.

Values extracted from inside a file, with positional information.

ApplySettings: object

Settings for applying a GritQL pattern.

apply(arg, options): Promise< {files: string[]; matches: ApplyMatch[]; outputs: Extraction[]; success: true;} | {message: string; success: false;} >

Apply a GritQL pattern to the given paths.

Promise< {files: string[]; matches: ApplyMatch[]; outputs: Extraction[]; success: true;} | {message: string; success: false;} >

A standardized name/level identifier for a check criterion, such as a GritQL pattern.

CheckResult: object

check(arg, options): Promise< CheckResult | {message: string; success: false;} >

Run all enforced GritQL patterns on a repository.

Promise< CheckResult | {message: string; success: false;} >

The result of getting the current workflow context.

• StepResult

getContext(arg, options): Promise< WorkflowContextResult | {message: string; success: false;} >

Get info about the current execution context.

Promise< WorkflowContextResult | {message: string; success: false;} >

ChatMessage: object

LLMQuery: object

Settings for an LLM call

LLMResult: object

Result of running an LLM call

llm(settings, options): Promise< LLMResult | {message: string; success: false;} >

Retrieve a result from an LLM call

Promise< LLMResult | {message: string; success: false;} >

QueryResult: object

Result of running a query on synthetic files

QuerySettings: object

Settings for a query

query(settings, options): Promise< QueryResult | {message: string; success: false;} >

Apply a GritQL pattern to input files.

Promise< QueryResult | {message: string; success: false;} >

ReadFilesResult: object

The result of reading multiple files.

readFiles(arg, options): Promise< ReadFilesResult | {message: string; success: false;} >

Reads multiple files from the current workspace.

Promise< ReadFilesResult | {message: string; success: false;} >

ReadFileResult: object

The result of reading a file.

readFile(arg, options): Promise< ReadFileResult | {message: string; success: false;} >

Reads a file from the current workspace.

Promise< ReadFileResult | {message: string; success: false;} >

RemoveFilesResult: object

The result of removing a file.

RemoveFilesSettings: object

Settings for removing files.

removeFiles(arg, options): Promise< RemoveFilesResult | {message: string; success: false;} >

Remove files from the current workspace.

Promise< RemoveFilesResult | {message: string; success: false;} >

A pair of before and after examples.

[{ input: 'console.log("hello world')', replacements: ['winston.log'] }]

TransformHistory: object

[key: FilePath]: TransformFileHistory

TransformSettings: object

Settings for a particular transformation

const settings = {
  objective: 'Convert logging statements to winston.log',
  principles: ['Preserve equivalent log levels'],
  examples: [
    { input: 'console.log("hello world")', replacements: ['winston.log'] }
  ],
  query: `js"console.$_"`,
  model: 'fast',
};

transform(arg, options): Promise< {fileHistory: TransformHistory; message: string; paths: string[]; success: true; warnings: boolean;} | {message: string; success: false;} >

Transform files using AI

Promise< {fileHistory: TransformHistory; message: string; paths: string[]; success: true; warnings: boolean;} | {message: string; success: false;} >

writeFile(arg, options): Promise< WriteFileResult | {message: string; success: false;} >

Write a file to the current workspace.

Promise< WriteFileResult | {message: string; success: false;} >

WriteFileResult: object

Write a single file result

WriteFileSettings: object

Settings for writing files.

WriteFilesResult: object

The result of writing a set of files.

WriteFilesSettings: object

Settings for writing files.

writeFiles(arg, options): Promise< WriteFilesResult | {message: string; success: false;} >

Write files to the current workspace.

Promise< WriteFilesResult | {message: string; success: false;} >

Generated using TypeDoc and typedoc-plugin-markdown