Options
All
  • Public
  • Public/Protected
  • All
Menu

Package yarnpkg-sdks

@yarnpkg/sdks

A CLI tool designed for generating and updating Editor SDKs and settings.

Installation

yarn add -D @yarnpkg/sdks

Commands

  • sdks - Generate editor SDKs and settings.

Enumerations

Classes

Type aliases

Variables

Functions

Type aliases

AllIntegrations

AllIntegrations: object

Type declaration

BaseSdks

BaseSdks: Array<[]>

GenerateBaseWrapper

GenerateBaseWrapper: function

Type declaration

GenerateDefaultWrapper

GenerateDefaultWrapper: function

Type declaration

GenerateIntegrationWrapper

GenerateIntegrationWrapper: function

Type declaration

IntegrationSdks

IntegrationSdks: Array<[] | []>

MapKey

MapKey<S>: S extends Map<infer K, any> ? K : never

Type parameters

  • S

SupportedIntegration

SupportedIntegration: MapKey<typeof SUPPORTED_INTEGRATIONS>

SupportedSdk

SupportedSdk: "eslint" | "prettier" | "typescript-language-server" | "typescript" | "svelte-language-server" | "flow-bin"

TemplateOptions

TemplateOptions: object

Type declaration

  • Optional setupEnv?: undefined | false | true
  • Optional usePnpify?: undefined | false | true
  • Optional wrapModule?: undefined | string

Variables

Const BASE_SDKS

BASE_SDKS: BaseSdks = [[`eslint`, generateEslintBaseWrapper],[`prettier`, generatePrettierBaseWrapper],[`typescript-language-server`, generateTypescriptLanguageServerBaseWrapper],[`typescript`, generateTypescriptBaseWrapper],[`svelte-language-server`, generateSvelteLanguageServerBaseWrapper],[`flow-bin`, generateFlowBinBaseWrapper],]

Const COC_VIM_SDKS

COC_VIM_SDKS: IntegrationSdks = [[`eslint`, generateEslintWrapper],[`typescript`, generateTypescriptWrapper],]

Const INTEGRATIONS_FILE

INTEGRATIONS_FILE: string & object = `integrations.yml` as Filename

Const SDK_FOLDER

SDK_FOLDER: string & object = `.yarn/sdks` as PortablePath

Const SUPPORTED_INTEGRATIONS

SUPPORTED_INTEGRATIONS: Map<"vscode" | "vim", ([null, null | function] | ["typescript" | "eslint" | "prettier" | "typescript-language-server" | "svelte-language-server" | "flow-bin", null | function])[]> = new Map([[`vim`, COC_VIM_SDKS],[`vscode`, VSCODE_SDKS],] as const)

Const VSCODE_SDKS

VSCODE_SDKS: IntegrationSdks = [[null, generateDefaultWrapper],[`eslint`, generateEslintWrapper],[`prettier`, generatePrettierWrapper],[`typescript-language-server`, null],[`typescript`, generateTypescriptWrapper],[`svelte-language-server`, generateSvelteLanguageServerWrapper],[`flow-bin`, generateFlowBinWrapper],]

Const cli

cli: Cli<object> = new Cli({binaryLabel: `Yarn SDKs`,binaryName: `sdks`,binaryVersion: require(`@yarnpkg/sdks/package.json`).version,})

Const dynamicRequire

dynamicRequire: NodeRequire = eval(`require`)

Functions

Const TEMPLATE

  • TEMPLATE(relPnpApiPath: PortablePath, module: string, __namedParameters: object): string

Const addCocVimWorkspaceConfiguration

Const addSettingWorkspaceConfiguration

  • addSettingWorkspaceConfiguration(pnpApi: PnpApi, relativeFileName: PortablePath, patch: any): Promise<void>

Const addVSCodeWorkspaceConfiguration

dynamicRequireNoCache

Const generateDefaultWrapper

  • generateDefaultWrapper(pnpApi: PnpApi): Promise<void>

Const generateEslintBaseWrapper

Const generateEslintWrapper

Const generateEslintWrapper

Const generateFlowBinBaseWrapper

Const generateFlowBinWrapper

Const generatePrettierBaseWrapper

Const generatePrettierWrapper

Const generateSdk

  • generateSdk(pnpApi: PnpApi, __namedParameters: object, __namedParameters: object): Promise<void>

Const generateSvelteLanguageServerBaseWrapper

Const generateSvelteLanguageServerWrapper

Const generateTypescriptBaseWrapper

Const generateTypescriptLanguageServerBaseWrapper

Const generateTypescriptWrapper

Const generateTypescriptWrapper

Const getDisplayName

  • getDisplayName(name: string): string

Const merge

  • merge(cjsonData: unknown, patch: unknown): unknown

Const validateIntegrations

  • validateIntegrations(integrations: Set<string>): void

Generated using TypeDoc