Options
All
  • Public
  • Public/Protected
  • All
Menu

@mountainpass/cool-bits-for-projen

Index

Classes

Interfaces

Type Aliases

Variables

Type Aliases

CSpellOptions

CSpellOptions: { cSpell?: boolean; cSpellOptions?: CSpellSettings }

option to enable or disable cSpell and cSpell options

Type declaration

  • Optional cSpell?: boolean

    enable or disable cSpell

    default

    true

  • Optional cSpellOptions?: CSpellSettings

CommitlintOptions

CommitlintOptions: { commitlint?: boolean; commitlintOptions?: UserConfig }

option to enable or disable commitlint

Type declaration

  • Optional commitlint?: boolean

    enable or disable commitlint

    default

    true

  • Optional commitlintOptions?: UserConfig

ContributorsOptions

ContributorsOptions: { additionalContributors?: (string | Entity)[]; autoPopulateFromGit?: boolean; contributors?: boolean }

Contributors options

Type declaration

  • Optional additionalContributors?: (string | Entity)[]
  • Optional autoPopulateFromGit?: boolean
  • Optional contributors?: boolean

DeepRequired

DeepRequired<Type>: { [ Key in keyof Type]-?: Required<DeepRequired<Type[Key]>> }

like Required but for the entire node hierarchy in the Type

Type Parameters

  • Type

Entity

Entity: { email: string; name: string; url?: string }

a person or a organisation

Type declaration

  • email: string
  • name: string
  • Optional url?: string

EslintIgnoreOptions

EslintIgnoreOptions: { eslintIgnore?: boolean }

option to enable or disable ignore in eslint

Type declaration

  • Optional eslintIgnore?: boolean

    enable or disable creating an eslint ignore file

    default

    true

EslintJsdocOptions

EslintJsdocOptions: { eslintJsdoc?: boolean }

option to enable or disable jsdoc linting in eslint

Type declaration

  • Optional eslintJsdoc?: boolean

    enable or disable jsdoc in eslint

    default

    true

EslintJsonCOptions

EslintJsonCOptions: { eslintJsonC?: boolean }

option to enable or disable jsonC in eslint

Type declaration

  • Optional eslintJsonC?: boolean

    enable or disable jsonC in eslint

    default

    true

EslintNoSecretsOptions

EslintNoSecretsOptions: { eslintNoSecrets?: boolean }

option to enable or disable noSecrets in eslint

Type declaration

  • Optional eslintNoSecrets?: boolean

    enable or disable noSecrets in eslint

    default

    true

EslintPrettierFixerOptions

EslintPrettierFixerOptions: { eslintPrettierFixer?: boolean }

option to enable or disable prettier in eslint

Type declaration

  • Optional eslintPrettierFixer?: boolean

EslintUnicornOptions

EslintUnicornOptions: { eslintUnicorn?: boolean }

option to enable or disable unicorn in eslint

Type declaration

  • Optional eslintUnicorn?: boolean

    enable or disable unicorn in eslint

    default

    true

GitHubberOptions

GitHubberOptions: { homepage?: string; name: string; username: string }

GitHubber options

Type declaration

  • Optional homepage?: string

    The homepage of the project. Defaults to the GitHub project page.

  • name: string

    The name of the project.

  • username: string

    The github name of the user or organisation this project belongs to

HuskyHook

HuskyHook: "applypatch-msg" | "pre-applypatch" | "post-applypatch" | "pre-commit" | "pre-merge-commit" | "prepare-commit-msg" | "commit-msg" | "post-commit" | "pre-rebase" | "post-checkout" | "post-merge" | "pre-push" | "pre-receive" | "update" | "proc-receive" | "post-receive" | "post-update" | "reference-transaction" | "push-to-checkout" | "pre-auto-gc" | "post-rewrite" | "sendemail-validate" | "fsmonitor-watchman" | "p4-changelist" | "p4-prepare-changelist" | "p4-post-changelist" | "p4-pre-submit" | "post-index-change"

see https://git-scm.com/docs/githooks

HuskyOptions

HuskyOptions: { husky?: boolean; huskyHooks?: Partial<Record<HuskyHook, string[]>> }

option to enable or disable husky and commands to run for each hook

Type declaration

  • Optional husky?: boolean

    enable or disable husky

    default

    true

  • Optional huskyHooks?: Partial<Record<HuskyHook, string[]>>

NpmReleaserOptions

NpmReleaserOptions: { access?: NpmAccess; name: string; registryUrl?: string; release?: boolean; releaseTag?: string; scope?: string }

NpmReleaser options

Type declaration

  • Optional access?: NpmAccess
  • name: string
  • Optional registryUrl?: string
  • Optional release?: boolean
  • Optional releaseTag?: string
  • Optional scope?: string

OrganisationalOptions

OrganisationalOptions: { organisation: Entity }

Organisational options

Type declaration

RecommendedOptions

RecommendedOptions: Dynamic<EslintPrettierFixerOptions, TypeScriptProject> & Dynamic<EslintUnicornOptions, TypeScriptProject> & Dynamic<HuskyOptions, NodeProject> & Dynamic<CommitlintOptions, NodeProject> & Dynamic<VscodeExtensionRecommendationsOptions, Project> & Dynamic<EslintJsdocOptions, TypeScriptProject> & Dynamic<CSpellOptions, NodeProject> & Dynamic<ContributorsOptions, NodeProject> & Dynamic<EslintNoSecretsOptions, TypeScriptProject> & Dynamic<EslintJsonCOptions, TypeScriptProject> & Dynamic<VscodeSettingsOptions, Project> & Dynamic<EslintIgnoreOptions, Project>

option to enable or disable unicorn in eslint

VscodeExtensionRecommendationsOptions

VscodeExtensionRecommendationsOptions: { vscodeExtensionRecommendations?: boolean; vscodeExtensionRecommendationsOptions?: { recommendations: string[] } }

option to enable or disable VscodeExtensionRecommendations and recommended extensions

Type declaration

  • Optional vscodeExtensionRecommendations?: boolean

    enable or disable vscodeExtensionRecommendations

    default

    true

  • Optional vscodeExtensionRecommendationsOptions?: { recommendations: string[] }
    • recommendations: string[]

VscodeSettingsOptions

VscodeSettingsOptions: { vscodeSettings?: boolean; vscodeSettingsOptions?: any }

option to enable or disable VscodeSettings and recommended extensions

Type declaration

  • Optional vscodeSettings?: boolean

    enable or disable vscodeSettings

    default

    true

  • Optional vscodeSettingsOptions?: any

    settings to add to vscode

    default

    {}

Variables

Const defaultRecommendedOptions

defaultRecommendedOptions: RecommendedOptions = Recommended.defaultOptions

default options for recommended components

deprecated

use Recommended.defaultOptions

Generated using TypeDoc