Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/intent/functions/checkStaleness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: checkStaleness
title: checkStaleness
---

# Function: checkStaleness()

```ts
function checkStaleness(packageDir, packageName?): Promise<StalenessReport>;
```

Defined in: [staleness.ts:75](https://github.com/TanStack/intent/blob/main/packages/intent/src/staleness.ts#L75)

## Parameters

### packageDir

`string`

### packageName?

`string`

## Returns

`Promise`\<[`StalenessReport`](../interfaces/StalenessReport.md)\>
22 changes: 22 additions & 0 deletions docs/intent/functions/containsSecrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: containsSecrets
title: containsSecrets
---

# Function: containsSecrets()

```ts
function containsSecrets(text): boolean;
```

Defined in: [feedback.ts:26](https://github.com/TanStack/intent/blob/main/packages/intent/src/feedback.ts#L26)

## Parameters

### text

`string`

## Returns

`boolean`
22 changes: 22 additions & 0 deletions docs/intent/functions/detectAgentConfigs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: detectAgentConfigs
title: detectAgentConfigs
---

# Function: detectAgentConfigs()

```ts
function detectAgentConfigs(root): string[];
```

Defined in: [init.ts:35](https://github.com/TanStack/intent/blob/main/packages/intent/src/init.ts#L35)

## Parameters

### root

`string`

## Returns

`string`[]
24 changes: 24 additions & 0 deletions docs/intent/functions/findSkillFiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: findSkillFiles
title: findSkillFiles
---

# Function: findSkillFiles()

```ts
function findSkillFiles(dir): string[];
```

Defined in: [utils.ts:8](https://github.com/TanStack/intent/blob/main/packages/intent/src/utils.ts#L8)

Recursively find all SKILL.md files under a directory.

## Parameters

### dir

`string`

## Returns

`string`[]
16 changes: 16 additions & 0 deletions docs/intent/functions/hasGhCli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: hasGhCli
title: hasGhCli
---

# Function: hasGhCli()

```ts
function hasGhCli(): boolean;
```

Defined in: [feedback.ts:34](https://github.com/TanStack/intent/blob/main/packages/intent/src/feedback.ts#L34)

## Returns

`boolean`
22 changes: 22 additions & 0 deletions docs/intent/functions/hasIntentBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: hasIntentBlock
title: hasIntentBlock
---

# Function: hasIntentBlock()

```ts
function hasIntentBlock(filePath): boolean;
```

Defined in: [init.ts:45](https://github.com/TanStack/intent/blob/main/packages/intent/src/init.ts#L45)

## Parameters

### filePath

`string`

## Returns

`boolean`
22 changes: 22 additions & 0 deletions docs/intent/functions/injectIntentBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: injectIntentBlock
title: injectIntentBlock
---

# Function: injectIntentBlock()

```ts
function injectIntentBlock(filePath): boolean;
```

Defined in: [init.ts:54](https://github.com/TanStack/intent/blob/main/packages/intent/src/init.ts#L54)

## Parameters

### filePath

`string`

## Returns

`boolean`
22 changes: 22 additions & 0 deletions docs/intent/functions/metaToMarkdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: metaToMarkdown
title: metaToMarkdown
---

# Function: metaToMarkdown()

```ts
function metaToMarkdown(payload): string;
```

Defined in: [feedback.ts:229](https://github.com/TanStack/intent/blob/main/packages/intent/src/feedback.ts#L229)

## Parameters

### payload

[`MetaFeedbackPayload`](../interfaces/MetaFeedbackPayload.md)

## Returns

`string`
24 changes: 24 additions & 0 deletions docs/intent/functions/parseFrontmatter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: parseFrontmatter
title: parseFrontmatter
---

# Function: parseFrontmatter()

```ts
function parseFrontmatter(filePath): Record<string, unknown>;
```

Defined in: [utils.ts:25](https://github.com/TanStack/intent/blob/main/packages/intent/src/utils.ts#L25)

Parse YAML frontmatter from a file. Returns null if no frontmatter or on error.

## Parameters

### filePath

`string`

## Returns

`Record`\<`string`, `unknown`\>
22 changes: 22 additions & 0 deletions docs/intent/functions/readProjectConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: readProjectConfig
title: readProjectConfig
---

# Function: readProjectConfig()

```ts
function readProjectConfig(root): IntentProjectConfig;
```

Defined in: [init.ts:83](https://github.com/TanStack/intent/blob/main/packages/intent/src/init.ts#L83)

## Parameters

### root

`string`

## Returns

[`IntentProjectConfig`](../interfaces/IntentProjectConfig.md)
22 changes: 22 additions & 0 deletions docs/intent/functions/resolveFrequency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: resolveFrequency
title: resolveFrequency
---

# Function: resolveFrequency()

```ts
function resolveFrequency(root): string;
```

Defined in: [feedback.ts:54](https://github.com/TanStack/intent/blob/main/packages/intent/src/feedback.ts#L54)

## Parameters

### root

`string`

## Returns

`string`
22 changes: 22 additions & 0 deletions docs/intent/functions/runInit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: runInit
title: runInit
---

# Function: runInit()

```ts
function runInit(root): InitResult;
```

Defined in: [init.ts:103](https://github.com/TanStack/intent/blob/main/packages/intent/src/init.ts#L103)

## Parameters

### root

`string`

## Returns

`InitResult`
33 changes: 33 additions & 0 deletions docs/intent/functions/runSetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
id: runSetup
title: runSetup
---

# Function: runSetup()

```ts
function runSetup(
root,
metaDir,
args): SetupResult;
```

Defined in: [setup.ts:141](https://github.com/TanStack/intent/blob/main/packages/intent/src/setup.ts#L141)

## Parameters

### root

`string`

### metaDir

`string`

### args

`string`[]

## Returns

`SetupResult`
22 changes: 22 additions & 0 deletions docs/intent/functions/scanForIntents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: scanForIntents
title: scanForIntents
---

# Function: scanForIntents()

```ts
function scanForIntents(root?): Promise<ScanResult>;
```

Defined in: [scanner.ts:142](https://github.com/TanStack/intent/blob/main/packages/intent/src/scanner.ts#L142)

## Parameters

### root?

`string`

## Returns

`Promise`\<[`ScanResult`](../interfaces/ScanResult.md)\>
39 changes: 39 additions & 0 deletions docs/intent/functions/submitFeedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: submitFeedback
title: submitFeedback
---

# Function: submitFeedback()

```ts
function submitFeedback(
payload,
repo,
opts): SubmitResult;
```

Defined in: [feedback.ts:301](https://github.com/TanStack/intent/blob/main/packages/intent/src/feedback.ts#L301)

## Parameters

### payload

[`FeedbackPayload`](../interfaces/FeedbackPayload.md)

### repo

`string`

### opts

#### ghAvailable

`boolean`

#### outputPath?

`string`

## Returns

`SubmitResult`
Loading
Loading