basic/src
Interfaces
Section titled “Interfaces”AgentTarget
Section titled “AgentTarget”Defined in: basic/src/agent-skill-generator.ts:9
Properties
Section titled “Properties”format
Section titled “format”format:
"cursor"|"frontmatter"|"kiro"|"plain"
Defined in: basic/src/agent-skill-generator.ts:12
Format variant used when generating content
label:
string
Defined in: basic/src/agent-skill-generator.ts:15
Human-readable label for logging
markerFolder
Section titled “markerFolder”markerFolder:
string
Defined in: basic/src/agent-skill-generator.ts:18
Folder that must exist in cwd to be considered “present”
skillFile
Section titled “skillFile”skillFile:
string
Defined in: basic/src/agent-skill-generator.ts:21
File name for the generated skill
skillSubdir
Section titled “skillSubdir”skillSubdir:
string
Defined in: basic/src/agent-skill-generator.ts:24
Subdirectory inside the agent folder where the skill file is placed
EslintConfigFeatures
Section titled “EslintConfigFeatures”Defined in: basic/src/agent-skill-generator.ts:31
Features extracted from the project’s actual eslint.config.js.
All arrays hold display-friendly labels (e.g. 'TypeScript', 'React').
Properties
Section titled “Properties”configFile
Section titled “configFile”configFile:
string|null
Defined in: basic/src/agent-skill-generator.ts:34
Path to the config file that was loaded, or null when falling back to detection
extensions
Section titled “extensions”extensions:
string[]
Defined in: basic/src/agent-skill-generator.ts:35
formats
Section titled “formats”formats:
string[]
Defined in: basic/src/agent-skill-generator.ts:36
frameworks
Section titled “frameworks”frameworks:
string[]
Defined in: basic/src/agent-skill-generator.ts:37
libraries
Section titled “libraries”libraries:
string[]
Defined in: basic/src/agent-skill-generator.ts:38
lintCommand
Section titled “lintCommand”lintCommand:
string
Defined in: basic/src/agent-skill-generator.ts:41
The lint command found in the project’s package.json scripts, or a sensible default
source
Section titled “source”source:
"config-file"|"detection-fallback"
Defined in: basic/src/agent-skill-generator.ts:44
Whether features came from the real config file or from package.json detection
testing
Section titled “testing”testing:
string[]
Defined in: basic/src/agent-skill-generator.ts:46
tools:
string[]
Defined in: basic/src/agent-skill-generator.ts:48
typescript
Section titled “typescript”typescript:
boolean
Defined in: basic/src/agent-skill-generator.ts:50
GenerateSkillOptions
Section titled “GenerateSkillOptions”Defined in: basic/src/agent-skill-generator.ts:53
Properties
Section titled “Properties”check?
Section titled “check?”
optionalcheck?:boolean
Defined in: basic/src/agent-skill-generator.ts:61
Check mode — compare existing skill files against freshly generated content without writing anything. Stale or missing files are reported in GenerateSkillResult.stale.
Default
Section titled “Default”falsecreateAgentsMd?
Section titled “createAgentsMd?”
optionalcreateAgentsMd?:boolean
Defined in: basic/src/agent-skill-generator.ts:68
Create a root AGENTS.md when it does not exist yet, instead of only
updating an existing one.
Default
Section titled “Default”false
optionalcwd?:string
Defined in: basic/src/agent-skill-generator.ts:71
Working directory — defaults to process.cwd()
force?
Section titled “force?”
optionalforce?:boolean
Defined in: basic/src/agent-skill-generator.ts:77
Overwrite files that already exist.
Default
Section titled “Default”falseGenerateSkillResult
Section titled “GenerateSkillResult”Defined in: basic/src/agent-skill-generator.ts:80
Properties
Section titled “Properties”skipped
Section titled “skipped”skipped:
string[]
Defined in: basic/src/agent-skill-generator.ts:81
stale:
string[]
Defined in: basic/src/agent-skill-generator.ts:84
Files that are out of date (or missing) — only populated in check mode
written
Section titled “written”written:
string[]
Defined in: basic/src/agent-skill-generator.ts:86
Variables
Section titled “Variables”AGENT_TARGETS
Section titled “AGENT_TARGETS”
constAGENT_TARGETS:AgentTarget[]
Defined in: basic/src/agent-skill-generator.ts:96
All AI coding-assistant agent folders that are probed for. Add new entries here as new agents emerge — the generator picks them up automatically on the next run.
angular
Section titled “angular”
constangular: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:109
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
angularConfig
Section titled “angularConfig”
constangularConfig: (options?) =>Promise<ConfigArray> =angular
Defined in: basic/src/frameworks.ts:136
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use angular instead.
constastro: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:110
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
defineConfig
Section titled “defineConfig”
constdefineConfig: (options?, …extraConfigs) =>Promise<ConfigArray> =eslintConfig
Defined in: basic/src/index.ts:859
Alias for eslintConfig() that reads naturally in eslint.config.* files.
Generates the ESLint configuration array, applying configurations and integration settings based on the input configuration.
Parameters
Section titled “Parameters”options?
Section titled “options?”Configuration and integration settings
extraConfigs
Section titled “extraConfigs”…ConfigInput[]
Local flat-config overrides appended after generated config
Returns
Section titled “Returns”Promise<ConfigArray>
The final ESLint configuration array
constexpo: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:111
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
expoConfig
Section titled “expoConfig”
constexpoConfig: (options?) =>Promise<ConfigArray> =expo
Defined in: basic/src/frameworks.ts:139
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use expo instead.
consthono: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:112
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constlit: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:113
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constnest: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:114
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
nestConfig
Section titled “nestConfig”
constnestConfig: (options?) =>Promise<ConfigArray> =nest
Defined in: basic/src/frameworks.ts:142
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use nest instead.
constnext: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:115
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
nextConfig
Section titled “nextConfig”
constnextConfig: (options?) =>Promise<ConfigArray> =next
Defined in: basic/src/frameworks.ts:145
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use next instead.
constnuxt: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:116
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
preact
Section titled “preact”
constpreact: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:117
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
preactConfig
Section titled “preactConfig”
constpreactConfig: (options?) =>Promise<ConfigArray> =preact
Defined in: basic/src/frameworks.ts:148
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use preact instead.
constqwik: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:118
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constreact: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:119
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
reactConfig
Section titled “reactConfig”
constreactConfig: (options?) =>Promise<ConfigArray> =react
Defined in: basic/src/frameworks.ts:151
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use react instead.
reactRouter
Section titled “reactRouter”
constreactRouter: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:120
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constremix: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:133
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Remix merged into React Router v7. Use reactRouter (the
react-router framework key) instead. This alias loads the legacy Remix
config and will be removed in the next major version.
slidev
Section titled “slidev”
constslidev: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:121
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constsolid: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:122
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
solidConfig
Section titled “solidConfig”
constsolidConfig: (options?) =>Promise<ConfigArray> =solid
Defined in: basic/src/frameworks.ts:154
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use solid instead.
svelte
Section titled “svelte”
constsvelte: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:123
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
svelteConfig
Section titled “svelteConfig”
constsvelteConfig: (options?) =>Promise<ConfigArray> =svelte
Defined in: basic/src/frameworks.ts:157
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use svelte instead.
tanstackStart
Section titled “tanstackStart”
consttanstackStart: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:124
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constvite: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:125
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
constvue: (options?) =>Promise<ConfigArray>
Defined in: basic/src/frameworks.ts:126
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
vueConfig
Section titled “vueConfig”
constvueConfig: (options?) =>Promise<ConfigArray> =vue
Defined in: basic/src/frameworks.ts:160
Parameters
Section titled “Parameters”options?
Section titled “options?”FrameworkOptions
Returns
Section titled “Returns”Promise<ConfigArray>
Deprecated
Section titled “Deprecated”Use vue instead.
Functions
Section titled “Functions”eslintConfig()
Section titled “eslintConfig()”eslintConfig(
options?, …extraConfigs):Promise<ConfigArray>
Defined in: basic/src/index.ts:731
Generates the ESLint configuration array, applying configurations and integration settings based on the input configuration.
Parameters
Section titled “Parameters”options?
Section titled “options?”Configuration and integration settings
extraConfigs
Section titled “extraConfigs”…ConfigInput[]
Local flat-config overrides appended after generated config
Returns
Section titled “Returns”Promise<ConfigArray>
The final ESLint configuration array
generateAgentSkills()
Section titled “generateAgentSkills()”generateAgentSkills(
opts?):Promise<GenerateSkillResult>
Defined in: basic/src/agent-skill-generator.ts:922
Detects which AI agent folders exist in the project, reads the actual
eslint.config.js to understand what is configured, and writes a tailored
ESLint standards skill file into each found folder.
Falls back to package.json auto-detection when the config file cannot be dynamically imported (e.g. when running outside a built environment).
Parameters
Section titled “Parameters”GenerateSkillOptions = {}
Returns
Section titled “Returns”Promise<GenerateSkillResult>
Example
Section titled “Example”import { generateAgentSkills } from '@santi020k/eslint-config-basic'
const result = await generateAgentSkills({ cwd: process.cwd() })process.stdout.write(`Written to: ${result.written}\n`)generateSkillContent()
Section titled “generateSkillContent()”generateSkillContent(
features,format):string
Defined in: basic/src/agent-skill-generator.ts:720
Builds the skill document body from the project’s EslintConfigFeatures. Four format variants are produced:
frontmatter— YAML front-matter + Markdown (.agent,.agents,.windsurf)cursor— Cursor MDC front-matter + Markdownkiro— Kiro steering front-matter (inclusion: always) + Markdownplain— pure Markdown, no front-matter (Claude Code, Copilot, Aider, Gemini, Cline, Roo Code)
Parameters
Section titled “Parameters”features
Section titled “features”format
Section titled “format”"cursor" | "frontmatter" | "kiro" | "plain"
Returns
Section titled “Returns”string
References
Section titled “References”Re-exports a11y
Re-exports aiSdk
astroDoctor
Section titled “astroDoctor”Re-exports astroDoctor
autogen
Section titled “autogen”Re-exports autogen
bestPractices
Section titled “bestPractices”Re-exports bestPractices
Re-exports biome
boundaries
Section titled “boundaries”Re-exports boundaries
command
Section titled “command”Re-exports command
compat
Section titled “compat”Re-exports compat
coreConfig
Section titled “coreConfig”Re-exports coreConfig
createCoreConfig
Section titled “createCoreConfig”Re-exports createCoreConfig
createImportGroups
Section titled “createImportGroups”Re-exports createImportGroups
cspell
Section titled “cspell”Re-exports cspell
Re-exports css
cypress
Section titled “cypress”Re-exports cypress
deMorgan
Section titled “deMorgan”Re-exports deMorgan
depend
Section titled “depend”Re-exports depend
DetectedFrameworkName
Section titled “DetectedFrameworkName”Re-exports DetectedFrameworkName
DetectionOptions
Section titled “DetectionOptions”Re-exports DetectionOptions
detectProjectOptions
Section titled “detectProjectOptions”Re-exports detectProjectOptions
docker
Section titled “docker”Re-exports docker
drizzle
Section titled “drizzle”Re-exports drizzle
EslintConfigOptions
Section titled “EslintConfigOptions”Re-exports EslintConfigOptions
Extension
Section titled “Extension”Re-exports Extension
ExtensionName
Section titled “ExtensionName”Re-exports ExtensionName
ExtensionOption
Section titled “ExtensionOption”Re-exports ExtensionOption
FlatConfigArray
Section titled “FlatConfigArray”Re-exports FlatConfigArray
Format
Section titled “Format”Re-exports Format
FormatName
Section titled “FormatName”Re-exports FormatName
FormatOption
Section titled “FormatOption”Re-exports FormatOption
getGlobalsForRuntime
Section titled “getGlobalsForRuntime”Re-exports getGlobalsForRuntime
githubActions
Section titled “githubActions”Re-exports githubActions
gitignore
Section titled “gitignore”Re-exports gitignore
googleGenAi
Section titled “googleGenAi”Re-exports googleGenAi
graphql
Section titled “graphql”Re-exports graphql
groups
Section titled “groups”Re-exports groups
hasReactConfig
Section titled “hasReactConfig”Re-exports hasReactConfig
Re-exports html
i18next
Section titled “i18next”Re-exports i18next
ImportedFramework
Section titled “ImportedFramework”Re-exports ImportedFramework
ImportGroupOptions
Section titled “ImportGroupOptions”Re-exports ImportGroupOptions
Re-exports jest
jestDom
Section titled “jestDom”Re-exports jestDom
jsConfig
Section titled “jsConfig”Renames and re-exports coreConfig
Re-exports jsdoc
Re-exports jsonc
langchain
Section titled “langchain”Re-exports langchain
Library
Section titled “Library”Re-exports Library
LibraryName
Section titled “LibraryName”Re-exports LibraryName
LibraryOption
Section titled “LibraryOption”Re-exports LibraryOption
llamaIndex
Section titled “llamaIndex”Re-exports llamaIndex
markdown
Section titled “markdown”Re-exports markdown
mastra
Section titled “mastra”Re-exports mastra
Re-exports mcp
Re-exports mdx
mikroOrm
Section titled “mikroOrm”Re-exports mikroOrm
NextMode
Section titled “NextMode”Re-exports NextMode
NextModeName
Section titled “NextModeName”Re-exports NextModeName
NextModeOption
Section titled “NextModeOption”Re-exports NextModeOption
Re-exports node
noOnlyTests
Section titled “noOnlyTests”Re-exports noOnlyTests
Re-exports nx
openAiAgents
Section titled “openAiAgents”Re-exports openAiAgents
OptionalConfigMap
Section titled “OptionalConfigMap”Re-exports OptionalConfigMap
OptionalConfigName
Section titled “OptionalConfigName”Re-exports OptionalConfigName
oxlint
Section titled “oxlint”Re-exports oxlint
packageJson
Section titled “packageJson”Re-exports packageJson
perfectionist
Section titled “perfectionist”Re-exports perfectionist
playwright
Section titled “playwright”Re-exports playwright
Re-exports pnpm
Preset
Section titled “Preset”Re-exports Preset
PresetName
Section titled “PresetName”Re-exports PresetName
PresetOption
Section titled “PresetOption”Re-exports PresetOption
prettier
Section titled “prettier”Re-exports prettier
prisma
Section titled “prisma”Re-exports prisma
ProjectConfigOptions
Section titled “ProjectConfigOptions”Re-exports ProjectConfigOptions
ReactConfigKeys
Section titled “ReactConfigKeys”Re-exports ReactConfigKeys
regexp
Section titled “regexp”Re-exports regexp
Runtime
Section titled “Runtime”Re-exports Runtime
RuntimeName
Section titled “RuntimeName”Re-exports RuntimeName
RuntimeOption
Section titled “RuntimeOption”Re-exports RuntimeOption
security
Section titled “security”Re-exports security
sequelize
Section titled “sequelize”Re-exports sequelize
Setting
Section titled “Setting”Re-exports Setting
SettingName
Section titled “SettingName”Re-exports SettingName
SettingOption
Section titled “SettingOption”Re-exports SettingOption
sonarjs
Section titled “sonarjs”Re-exports sonarjs
stencil
Section titled “stencil”Re-exports stencil
storybook
Section titled “storybook”Re-exports storybook
StrictMode
Section titled “StrictMode”Re-exports StrictMode
swagger
Section titled “swagger”Re-exports swagger
tailwind
Section titled “tailwind”Re-exports tailwind
tanstackQuery
Section titled “tanstackQuery”Re-exports tanstackQuery
tanstackRouter
Section titled “tanstackRouter”Re-exports tanstackRouter
Testing
Section titled “Testing”Re-exports Testing
testingLibrary
Section titled “testingLibrary”Re-exports testingLibrary
TestingName
Section titled “TestingName”Re-exports TestingName
TestingOption
Section titled “TestingOption”Re-exports TestingOption
Re-exports toml
Re-exports Tool
ToolName
Section titled “ToolName”Re-exports ToolName
ToolOption
Section titled “ToolOption”Re-exports ToolOption
tsConfig
Section titled “tsConfig”Renames and re-exports typescriptConfig
Re-exports turbo
typeorm
Section titled “typeorm”Re-exports typeorm
typescriptConfig
Section titled “typescriptConfig”Re-exports typescriptConfig
TypeScriptMode
Section titled “TypeScriptMode”Re-exports TypeScriptMode
TypeScriptOptions
Section titled “TypeScriptOptions”Re-exports TypeScriptOptions
unicorn
Section titled “unicorn”Re-exports unicorn
vitest
Section titled “vitest”Re-exports vitest
Re-exports yaml
Re-exports zod
Did this page help?
Your answer stays in this browser. Share details on GitHub to help improve the docs.