Merge commit '36c66dd290d3ce6eb1ccd310d0c658d4a32bb8eb' as 'repos/effect'
This commit is contained in:
-Puter
43
repos/effect/.agents/skills/grill-me/SKILL.md
Normal file
43
repos/effect/.agents/skills/grill-me/SKILL.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: grill-me
|
||||
description: Interview the user about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".
|
||||
---
|
||||
|
||||
Interview me about every aspect of this plan until we reach a shared understanding and a defensible design.
|
||||
|
||||
Ask exactly one question at a time, then wait for my answer before asking the next question.
|
||||
|
||||
Use each answer to choose the next highest-leverage unresolved question. Maintain an implicit decision tree of resolved decisions, open questions, assumptions, dependencies, risks, and rejected alternatives.
|
||||
|
||||
For each question, include:
|
||||
|
||||
- clear answer options when appropriate
|
||||
- your recommended answer, marked as recommended
|
||||
- a brief reason for the recommendation
|
||||
|
||||
Use open-ended questions when fixed options would prematurely constrain the design space.
|
||||
|
||||
Challenge vague, inconsistent, risky, or unsupported assumptions. If an answer creates a contradiction or unresolved dependency, ask a follow-up before moving on.
|
||||
|
||||
Cover, as relevant:
|
||||
|
||||
- goals and non-goals
|
||||
- users and stakeholders
|
||||
- constraints
|
||||
- alternatives
|
||||
- APIs and interfaces
|
||||
- data model
|
||||
- error handling
|
||||
- security
|
||||
- observability
|
||||
- testing
|
||||
- migration and rollout
|
||||
- failure modes
|
||||
- operational ownership
|
||||
- success criteria
|
||||
|
||||
If repository facts are needed, inspect the codebase instead of asking the user. Do not ask me to provide information that can be determined locally.
|
||||
|
||||
When an available user-input tool such as `request_user_input` fits the question, use it to ask one short question with a small set of mutually exclusive options. Otherwise, ask in plain text and present clear possible answers as a numbered list when that helps me answer quickly. Include your recommended option and mark it as recommended.
|
||||
|
||||
Stop when the major branches of the design tree have been resolved. Then summarize the agreed design, remaining risks, assumptions, rejected alternatives, and next steps.
|
||||
203
repos/effect/.agents/skills/jsdocs/SKILL.md
Normal file
203
repos/effect/.agents/skills/jsdocs/SKILL.md
Normal file
@@ -0,0 +1,203 @@
|
||||
---
|
||||
name: jsdocs
|
||||
description: Write, insert, or update Effect public API JSDoc so it satisfies the jsdocs oxlint rule. Use when adding or fixing JSDoc comments, resolving jsdocs diagnostics, preparing docs for JSON extraction, or reviewing public API documentation.
|
||||
---
|
||||
|
||||
Use this skill to write well-formed JSDoc for Effect public APIs.
|
||||
|
||||
## Workflow
|
||||
|
||||
When updating public API JSDoc:
|
||||
|
||||
1. Inspect the declaration, implementation, nearby tests, and nearby JSDoc before editing.
|
||||
2. Decide whether the task is a single API fix or a module refinement pass.
|
||||
3. Rewrite comments into the required documentation shape while preserving correct facts and examples.
|
||||
4. For module refinements, complex APIs, or APIs with related alternatives, run the `@see` and `**Gotchas**` audits.
|
||||
5. Run the narrowest relevant validation.
|
||||
|
||||
## Required documentation shape
|
||||
|
||||
Use a normal multiline JSDoc comment in TypeScript source:
|
||||
|
||||
```ts
|
||||
/**
|
||||
* Short description as one paragraph.
|
||||
*
|
||||
* **When to use**
|
||||
*
|
||||
* Optional practical usage guidance.
|
||||
*
|
||||
* **Details**
|
||||
*
|
||||
* Optional details for complex APIs, options, overloads, or behavior.
|
||||
*
|
||||
* **Gotchas**
|
||||
*
|
||||
* Optional edge cases, footguns, or surprising behavior.
|
||||
*
|
||||
* **Example** (Short title)
|
||||
*
|
||||
* Optional prose explaining the example.
|
||||
*
|
||||
* ```ts
|
||||
* const result = example()
|
||||
* ```
|
||||
*
|
||||
* @category constructors
|
||||
* @since 1.0.0
|
||||
*/
|
||||
```
|
||||
|
||||
## Prose Rules
|
||||
|
||||
- Use sober, practical prose.
|
||||
- Write all public JSDoc prose in English.
|
||||
- Do not use jargon when a plain word works.
|
||||
- Do not be clever.
|
||||
- Do not add filler sections.
|
||||
- The short description is required and must be exactly one paragraph.
|
||||
- Make the short description stand on its own. Do not rely on `**When to use**`
|
||||
to make the API understandable.
|
||||
- For functions and methods, prefer present-tense, action-first prose such as
|
||||
`Creates`, `Returns`, `Checks`, `Provides`, `Represents`, `Converts`,
|
||||
`Decodes`, or `Formats`.
|
||||
- For technical value exports, use consistent noun forms such as `Schema for`,
|
||||
`Layer that`, `Service that`, `Context reference that`, or
|
||||
`Constructors and matchers for`.
|
||||
- Avoid leading `A` or `An` for canonical technical nouns when the surrounding
|
||||
module uses a standard noun family, for example prefer `Schema for ...` over
|
||||
`A schema for ...`.
|
||||
- Do not describe implementation mechanics when a public concept is clearer.
|
||||
For example, prefer `Constructors and matchers for ...` over wording that
|
||||
only says an API uses `Data.taggedEnum`.
|
||||
- Avoid generic purity or non-mutation remarks unless they document a real
|
||||
surprise, caveat, or meaningful contrast with a mutating-looking API.
|
||||
- Optional sections must appear in this order:
|
||||
1. `**When to use**`
|
||||
2. `**Details**`
|
||||
3. `**Gotchas**`
|
||||
- Include an optional section only when it has useful, non-empty content.
|
||||
- Prefer prose over bullet lists for single-item `**Details**`, `**When to use**`, or `**Gotchas**` sections. Use bullets only when there are two or more parallel facts, options, cases, or caveats.
|
||||
- `**When to use**` describes the positive use case for the documented API. Do not use it as a routing section for sibling APIs. If neighboring APIs need to be mentioned, put that boundary in `@see` tag text instead.
|
||||
- `**When to use**` is important when the API has close alternatives, trade-offs, or `@see` tags. If `@see` tags are present, inspect the referenced APIs and add `**When to use**` when it clarifies the documented API's own use case.
|
||||
- `**When to use**` must start with one of these practical guidance forms: `Use to`, `Use when`, `Use as`, or `Use with`. Avoid bullet lists and vague openers such as `Use this...` or `Useful for...`.
|
||||
- Prefer reader-centered `**When to use**` wording, especially `Use when you ...`,
|
||||
when the sentence describes a user's goal. Avoid third-person noun-phrase
|
||||
subjects such as `the input is ...`, `a service needs ...`, or
|
||||
`values should ...` when they would become awkward in generated prompts.
|
||||
- A good `**When to use**` sentence should still read naturally if reused as
|
||||
a user intent prompt, for example after `I need ...` or `I have ...`.
|
||||
- Keep `short` and `**When to use**` distinct: the short description says what
|
||||
the API is or does; `**When to use**` says when to choose it.
|
||||
- Add internal `@see` tags only for semantically useful related public APIs.
|
||||
- Write `@see` tag text as normal prose after the link; no special separator is required. Prefer forms like `@see {@link otherApi} for ...` when a short explanation helps.
|
||||
- Use exactly one blank line between the short description, sections, examples, and tags.
|
||||
- Do not use Markdown headings such as `# Heading` or ad hoc bold headings such as `**Notes**`; only the standard headings are allowed.
|
||||
- Examples must use `**Example** (Title)`, optional prose, and exactly one non-empty `ts` code fence.
|
||||
- Example titles must be unique after trimming and lowercasing.
|
||||
- Example titles should be short use-case phrases, not generic labels.
|
||||
- Prefer gerund or action-noun titles that read naturally after `for`, for
|
||||
example `Parsing JSON`, `Creating a scoped runtime`, or `Comparing structs`.
|
||||
- Avoid imperative titles such as `Parse JSON`, vague labels such as `Syntax`
|
||||
or `Basic usage`, and title-cased fragments such as `String Ordering`.
|
||||
- Preserve canonical technical capitalization inside the phrase, such as
|
||||
`Option`, `Effect`, `Schema`, `DateTime`, `HashMap`, `Base64`, and `JSON`.
|
||||
- For multiple examples on the same API, make each title describe the distinct
|
||||
use case shown by that example.
|
||||
- Prefer examples with stable, deterministic output. Avoid assertions or
|
||||
`console.log` comments that depend on stack traces, object inspection,
|
||||
`Error` formatting, concurrency order, timing, randomness, or
|
||||
environment-specific formatting. Examples may assume Node.js console
|
||||
formatting. Direct `Set` / `Map` output is acceptable when insertion order is
|
||||
deterministic and the expected output uses Node's format; otherwise
|
||||
demonstrate a stable property instead.
|
||||
- Do not use `@example`.
|
||||
- Do not put TypeScript code fences outside `**Example** (Title)` sections.
|
||||
- Inline `{@link Symbol}` targets must resolve to TypeScript symbols; do not link to URLs with `{@link}`.
|
||||
- Avoid overlinking in prose. Use `{@link Symbol}` only when navigation to
|
||||
that symbol helps the reader choose or understand the API. For the API being
|
||||
documented, the module's central type, nearby obvious names, or repeated
|
||||
mentions, prefer plain code formatting such as `Cause`, `Effect`, or
|
||||
`Context`.
|
||||
- Do not document module-level comments; module JSDoc is ignored by this rule.
|
||||
- `@internal` means the item is ignored; do not rewrite it as public docs.
|
||||
- Default exports are ignored by this rule and do not need JSDoc.
|
||||
- Do not add unsupported constructs such as enums or empty exports in checked files.
|
||||
- For low-level public values, prefer accurate categories such as `symbols`,
|
||||
`type IDs`, or `prototypes` over compensating with verbose descriptions.
|
||||
|
||||
## Tag rules
|
||||
|
||||
When multiple tags are present, keep them in this order:
|
||||
|
||||
1. `@deprecated`
|
||||
2. `@default`
|
||||
3. `@see`
|
||||
4. `@category`
|
||||
5. `@since`
|
||||
|
||||
Tag requirements by declaration kind:
|
||||
|
||||
- Root declarations require `@category` and stable-semver `@since`, and must
|
||||
not use `@default`.
|
||||
- Namespaces and declarations inside namespaces require stable-semver `@since`,
|
||||
may use `@category`, and must not use `@default`.
|
||||
- Member JSDoc is optional. When present, it follows the same prose and layout
|
||||
rules, may use optional stable-semver `@since`, may use non-empty `@default`,
|
||||
and must not use `@category`.
|
||||
- Any declaration may use `@deprecated` with a non-empty message and repeated
|
||||
non-empty `@see` tags for semantically useful related public APIs.
|
||||
|
||||
## Updating existing JSDoc
|
||||
|
||||
When fixing or updating existing docs:
|
||||
|
||||
1. Preserve correct facts and examples.
|
||||
2. Rewrite the layout into the standard template.
|
||||
3. Move usage guidance into `**When to use**`, behavior details into `**Details**`, and real caveats into `**Gotchas**`.
|
||||
4. Convert `@example` tags and loose `ts` fences into `**Example** (Title)` sections.
|
||||
5. Preserve valid `@see`, `@deprecated`, `@default`, `@category`, and `@since` tags.
|
||||
6. Remove `@see` tags that do not point to semantically useful related public APIs.
|
||||
7. Replace redundant inline `{@link ...}` tags with plain code formatting when
|
||||
the link target is already obvious from the current declaration or module.
|
||||
8. Remove sections that would be empty.
|
||||
|
||||
## Module refinement
|
||||
|
||||
When asked to refine an existing module:
|
||||
|
||||
1. First scan the module for local documentation patterns, repeated API families, and category conventions.
|
||||
2. Keep the change focused on documentation quality unless the user also asked for rule or source changes.
|
||||
3. Prefer improving existing comments over rewriting every comment into a new voice.
|
||||
4. Preserve examples unless they are wrong, stale, nondeterministic, or fail
|
||||
the required documentation shape.
|
||||
5. Apply the `@see` and `**Gotchas**` audits across the module before finishing.
|
||||
|
||||
## See audit
|
||||
|
||||
When refining an existing public API module, always do a dedicated `@see` pass:
|
||||
|
||||
1. Inspect existing `@see` tags and referenced APIs before keeping, changing, or removing them.
|
||||
2. Look for close alternatives in the same module or API family when the documented API is one of several ways to do similar work.
|
||||
3. Keep or add `@see` only when the linked API is semantically useful to understand the documented API.
|
||||
4. Good `@see` targets include sibling APIs, alternatives, inverse operations, lower-level or higher-level variants, complementary operations, and closely returned, consumed, or configured types/values.
|
||||
5. Do not use `@see` for implementation dependencies, broad concepts, external background links, APIs that merely share a word or name, helper APIs used only inside examples, undocumented/private members, or APIs that are only generally compatible.
|
||||
6. When `@see` tags are kept or added, include `**When to use**` guidance if the documented API's own use case is not obvious from the short description. Keep comparisons with sibling APIs in the `@see` tag text.
|
||||
|
||||
## Gotchas audit
|
||||
|
||||
When refining an existing public API module, always do a dedicated `**Gotchas**` pass:
|
||||
|
||||
1. Scan existing prose for caveat language: warnings, exceptions, limitations, preconditions, special cases, or behavior that is easy to misuse.
|
||||
2. Inspect the implementation and nearby tests for behavior that is not obvious from the type signature or short description.
|
||||
3. Move real caveats from `**Details**` into `**Gotchas**` when they describe edge cases, footguns, preconditions, surprising behavior, or important failure modes.
|
||||
4. Add `**Gotchas**` only when the caveat is concrete and useful to a reader choosing or using the API.
|
||||
5. If no gotchas are added during a refinement pass, state that a gotchas audit was performed and why no caveats were worth documenting.
|
||||
|
||||
## Validation
|
||||
|
||||
Run the narrowest validation that matches the change:
|
||||
|
||||
- For JSDoc or example changes in a package with generated docs, run `pnpm docgen` from that package directory.
|
||||
- Run `pnpm lint` because the linter includes the custom rule that checks public API JSDoc.
|
||||
- Do not run broad validation for prose-only skill edits.
|
||||
44
repos/effect/.agents/skills/scratchpad/SKILL.md
Normal file
44
repos/effect/.agents/skills/scratchpad/SKILL.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
name: scratchpad
|
||||
description: Extract the JSDoc example nearest the active source selection or cursor into ./scratchpad as a TypeScript file. Use when the user asks to dump, copy, open, or try a source example in scratchpad.
|
||||
---
|
||||
|
||||
Use this skill to create a scratchpad TypeScript file from the JSDoc `**Example**`
|
||||
nearest the user's active source cursor or selection.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Determine the source path and line:
|
||||
- Use the IDE active file and selection/cursor line when present.
|
||||
- Use an explicit file and line when the user provides them.
|
||||
- If no line or selection is available, ask for it.
|
||||
2. Run:
|
||||
|
||||
```sh
|
||||
node .agents/skills/scratchpad/scripts/extract-example.mjs <source-path> <line>
|
||||
```
|
||||
|
||||
3. If the script exits with code 2 because there is no obvious runner, ask the
|
||||
user whether to preserve the example exactly, name an Effect value to run, or
|
||||
cancel.
|
||||
- To preserve exactly, rerun with `--mode preserve`.
|
||||
- To run a specific Effect value, rerun with `--runner <identifier>`.
|
||||
4. Report the created path as a clickable file link. This is the deterministic
|
||||
way to open it in the code pane.
|
||||
5. Do not run the scratchpad file unless the user explicitly asks.
|
||||
|
||||
## Behavior
|
||||
|
||||
- The script chooses the example whose `**Example**` section contains the line;
|
||||
otherwise it chooses the first following example; otherwise the nearest
|
||||
previous example.
|
||||
- Filenames are derived from the source file and example title, for example
|
||||
`scratchpad/Schedule-retrying-and-repeating-effects.ts`.
|
||||
- Existing files are not overwritten. The script appends a numeric suffix.
|
||||
- In auto mode, if a top-level `program` binding exists, the script appends:
|
||||
|
||||
```ts
|
||||
Effect.runPromise(program).then(console.log, console.error)
|
||||
```
|
||||
|
||||
- If the example already contains an Effect runner, the script preserves it.
|
||||
@@ -0,0 +1,7 @@
|
||||
interface:
|
||||
display_name: "Scratchpad"
|
||||
short_description: "Extract examples into scratchpad"
|
||||
default_prompt: "Use $scratchpad to extract the active JSDoc example into scratchpad."
|
||||
|
||||
policy:
|
||||
allow_implicit_invocation: true
|
||||
@@ -0,0 +1,260 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs"
|
||||
import { basename, extname, isAbsolute, join, relative, resolve } from "node:path"
|
||||
|
||||
const usage = `Usage:
|
||||
node .agents/skills/scratchpad/scripts/extract-example.mjs <source-path> <line> [--mode auto|preserve] [--runner <identifier>] [--out-dir <dir>]
|
||||
|
||||
Examples:
|
||||
node .agents/skills/scratchpad/scripts/extract-example.mjs packages/effect/src/Schedule.ts 9
|
||||
node .agents/skills/scratchpad/scripts/extract-example.mjs packages/effect/src/Schedule.ts 9 --mode preserve
|
||||
node .agents/skills/scratchpad/scripts/extract-example.mjs packages/effect/src/Schedule.ts 9 --runner myProgram
|
||||
`
|
||||
|
||||
const args = process.argv.slice(2)
|
||||
const sourcePath = args[0]
|
||||
const lineInput = args[1]
|
||||
let mode = "auto"
|
||||
let runner = undefined
|
||||
let outDir = "scratchpad"
|
||||
|
||||
for (let index = 2; index < args.length; index++) {
|
||||
const arg = args[index]
|
||||
if (arg === "--mode") {
|
||||
mode = args[++index]
|
||||
} else if (arg === "--runner") {
|
||||
runner = args[++index]
|
||||
} else if (arg === "--out-dir") {
|
||||
outDir = args[++index]
|
||||
} else {
|
||||
fail(`Unknown option: ${arg}`)
|
||||
}
|
||||
}
|
||||
|
||||
if (!sourcePath || !lineInput) {
|
||||
fail(usage)
|
||||
}
|
||||
|
||||
if (mode !== "auto" && mode !== "preserve") {
|
||||
fail(`Invalid --mode: ${mode}`)
|
||||
}
|
||||
|
||||
if (runner !== undefined && !/^[A-Za-z_$][\w$]*$/.test(runner)) {
|
||||
fail(`Invalid --runner identifier: ${runner}`)
|
||||
}
|
||||
|
||||
const line = Number.parseInt(lineInput, 10)
|
||||
|
||||
if (!Number.isSafeInteger(line) || line < 1) {
|
||||
fail(`Invalid line number: ${lineInput}`)
|
||||
}
|
||||
|
||||
const resolvedSourcePath = resolve(sourcePath)
|
||||
const source = readFileSync(resolvedSourcePath, "utf8")
|
||||
const sourceLines = source.split(/\r?\n/)
|
||||
const examples = findExamples(sourceLines)
|
||||
|
||||
if (examples.length === 0) {
|
||||
fail(`No JSDoc examples found in ${sourcePath}`)
|
||||
}
|
||||
|
||||
const example = chooseExample(examples, line)
|
||||
const hasRunner = /\bEffect\.run[A-Za-z]*\s*\(/.test(example.code)
|
||||
const programRunner = /^\s*(?:export\s+)?(?:const|let|var)\s+program\s*=/m.test(example.code)
|
||||
|
||||
let code = example.code.trimEnd()
|
||||
let runnerStatus = "none"
|
||||
|
||||
if (runner !== undefined) {
|
||||
code = appendRunner(code, runner)
|
||||
runnerStatus = `appended:${runner}`
|
||||
} else if (mode === "auto") {
|
||||
if (hasRunner) {
|
||||
runnerStatus = "already-present"
|
||||
} else if (programRunner) {
|
||||
code = appendRunner(code, "program")
|
||||
runnerStatus = "appended:program"
|
||||
} else {
|
||||
const payload = {
|
||||
status: "needs-runner",
|
||||
title: example.title,
|
||||
sourcePath: displayPath(resolvedSourcePath),
|
||||
titleLine: example.titleLine,
|
||||
codeStartLine: example.codeStartLine,
|
||||
codeEndLine: example.codeEndLine
|
||||
}
|
||||
process.stderr.write(`${JSON.stringify(payload, null, 2)}\n`)
|
||||
process.exit(2)
|
||||
}
|
||||
}
|
||||
|
||||
mkdirSync(outDir, { recursive: true })
|
||||
|
||||
const outputPath = uniqueOutputPath(outDir, resolvedSourcePath, example.title)
|
||||
writeFileSync(outputPath, `${code}\n`, "utf8")
|
||||
|
||||
process.stdout.write(
|
||||
`${JSON.stringify(
|
||||
{
|
||||
outputPath: displayPath(resolve(outputPath)),
|
||||
title: example.title,
|
||||
sourcePath: displayPath(resolvedSourcePath),
|
||||
titleLine: example.titleLine,
|
||||
codeStartLine: example.codeStartLine,
|
||||
codeEndLine: example.codeEndLine,
|
||||
runner: runnerStatus
|
||||
},
|
||||
null,
|
||||
2
|
||||
)}\n`
|
||||
)
|
||||
|
||||
function findExamples(lines) {
|
||||
const examples = []
|
||||
let blockStart = -1
|
||||
let block = []
|
||||
|
||||
for (let index = 0; index < lines.length; index++) {
|
||||
const line = lines[index]
|
||||
|
||||
if (blockStart === -1 && line.includes("/**")) {
|
||||
blockStart = index
|
||||
block = [line]
|
||||
if (line.includes("*/")) {
|
||||
collectExamples(examples, block, blockStart)
|
||||
blockStart = -1
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
if (blockStart !== -1) {
|
||||
block.push(line)
|
||||
if (line.includes("*/")) {
|
||||
collectExamples(examples, block, blockStart)
|
||||
blockStart = -1
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return examples
|
||||
}
|
||||
|
||||
function collectExamples(examples, block, blockStart) {
|
||||
const cleaned = block.map(cleanJSDocLine)
|
||||
|
||||
for (let index = 0; index < cleaned.length; index++) {
|
||||
const line = cleaned[index]
|
||||
const titleMatch = line.match(/\*\*Example\*\*(?:\s*\(([^)]+)\))?/)
|
||||
|
||||
if (titleMatch === null) {
|
||||
continue
|
||||
}
|
||||
|
||||
const title = titleMatch[1]?.trim() || `example-${blockStart + index + 1}`
|
||||
const fenceStart = findFenceStart(cleaned, index + 1)
|
||||
|
||||
if (fenceStart === -1) {
|
||||
continue
|
||||
}
|
||||
|
||||
const fenceEnd = findFenceEnd(cleaned, fenceStart + 1)
|
||||
|
||||
if (fenceEnd === -1) {
|
||||
continue
|
||||
}
|
||||
|
||||
examples.push({
|
||||
title,
|
||||
titleLine: blockStart + index + 1,
|
||||
codeStartLine: blockStart + fenceStart + 2,
|
||||
codeEndLine: blockStart + fenceEnd,
|
||||
code: cleaned.slice(fenceStart + 1, fenceEnd).join("\n")
|
||||
})
|
||||
|
||||
index = fenceEnd
|
||||
}
|
||||
}
|
||||
|
||||
function findFenceStart(lines, startIndex) {
|
||||
for (let index = startIndex; index < lines.length; index++) {
|
||||
const trimmed = lines[index].trim()
|
||||
|
||||
if (trimmed.startsWith("**Example**")) {
|
||||
return -1
|
||||
}
|
||||
|
||||
if (/^```(?:ts|typescript)?\s*$/.test(trimmed)) {
|
||||
return index
|
||||
}
|
||||
}
|
||||
|
||||
return -1
|
||||
}
|
||||
|
||||
function findFenceEnd(lines, startIndex) {
|
||||
for (let index = startIndex; index < lines.length; index++) {
|
||||
if (lines[index].trim() === "```") {
|
||||
return index
|
||||
}
|
||||
}
|
||||
|
||||
return -1
|
||||
}
|
||||
|
||||
function cleanJSDocLine(line) {
|
||||
return line.replace(/^\s*\/\*\*\s?/, "").replace(/^\s*\*\/\s?$/, "").replace(/^\s*\* ?/, "")
|
||||
}
|
||||
|
||||
function chooseExample(examples, line) {
|
||||
const containing = examples.find((example) => example.titleLine <= line && line <= example.codeEndLine)
|
||||
|
||||
if (containing !== undefined) {
|
||||
return containing
|
||||
}
|
||||
|
||||
const following = examples.find((example) => line < example.titleLine)
|
||||
|
||||
if (following !== undefined) {
|
||||
return following
|
||||
}
|
||||
|
||||
return examples[examples.length - 1]
|
||||
}
|
||||
|
||||
function appendRunner(code, identifier) {
|
||||
return `${code.trimEnd()}\n\nEffect.runPromise(${identifier}).then(console.log, console.error)`
|
||||
}
|
||||
|
||||
function uniqueOutputPath(directory, source, title) {
|
||||
const sourceName = basename(source, extname(source))
|
||||
const titleSlug = slug(title) || "example"
|
||||
const base = `${sourceName}-${titleSlug}`
|
||||
let candidate = join(directory, `${base}.ts`)
|
||||
let suffix = 2
|
||||
|
||||
while (existsSync(candidate)) {
|
||||
candidate = join(directory, `${base}-${suffix}.ts`)
|
||||
suffix++
|
||||
}
|
||||
|
||||
return candidate
|
||||
}
|
||||
|
||||
function slug(value) {
|
||||
return value
|
||||
.normalize("NFKD")
|
||||
.replace(/[\u0300-\u036f]/g, "")
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, "-")
|
||||
.replace(/^-+|-+$/g, "")
|
||||
}
|
||||
|
||||
function displayPath(path) {
|
||||
return isAbsolute(path) ? relative(process.cwd(), path) || "." : path
|
||||
}
|
||||
|
||||
function fail(message) {
|
||||
process.stderr.write(`${message}\n`)
|
||||
process.exit(1)
|
||||
}
|
||||
Reference in New Issue
Block a user