Package io.github.cdklabs.projen.typescript

Interface TypeScriptProjectOptions

    • Method Detail

      • getDisableTsconfig

        @Stability(Experimental)
@Nullable
default Boolean getDisableTsconfig()
        (experimental) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

        Default: false

      • getDisableTsconfigDev

        @Stability(Experimental)
@Nullable
default Boolean getDisableTsconfigDev()
        (experimental) Do not generate a tsconfig.dev.json file.

        Default: false

      • getDocgen

        @Stability(Experimental)
@Nullable
default Boolean getDocgen()
        (experimental) Docgen by Typedoc.

        Default: false

      • getDocsDirectory

        @Stability(Experimental)
@Nullable
default String getDocsDirectory()
        (experimental) Docs directory.

        Default: "docs"

      • getEntrypointTypes

        @Stability(Experimental)
@Nullable
default String getEntrypointTypes()
        (experimental) The .d.ts file that includes the type declarations for this module.

        Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

      • getEslint

        @Stability(Experimental)
@Nullable
default Boolean getEslint()
        (experimental) Setup eslint.

        Default: true

      • getEslintOptions

        @Stability(Experimental)
@Nullable
default EslintOptions getEslintOptions()
        (experimental) Eslint options.

        Default: - opinionated default options

      • getLibdir

        @Stability(Experimental)
@Nullable
default String getLibdir()
        (experimental) Typescript artifacts output directory.

        Default: "lib"

      • getProjenrcTs

        @Stability(Experimental)
@Nullable
default Boolean getProjenrcTs()
        (experimental) Use TypeScript for your projenrc file (.projenrc.ts).

        Default: false

      • getProjenrcTsOptions

        @Stability(Experimental)
@Nullable
default ProjenrcOptions getProjenrcTsOptions()
        (experimental) Options for .projenrc.ts.

      • getSampleCode

        @Stability(Experimental)
@Nullable
default Boolean getSampleCode()
        (experimental) Generate one-time sample in src/ and test/ if there are no files there.

        Default: true

      • getSrcdir

        @Stability(Experimental)
@Nullable
default String getSrcdir()
        (experimental) Typescript sources directory.

        Default: "src"

      • getTestdir

        @Stability(Experimental)
@Nullable
default String getTestdir()
        (experimental) Jest tests directory. Tests files should be named xxx.test.ts.

        If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

        Default: "test"

      • getTsconfig

        @Stability(Experimental)
@Nullable
default TypescriptConfigOptions getTsconfig()
        (experimental) Custom TSConfig.

        Default: - default options

      • getTsconfigDev

        @Stability(Experimental)
@Nullable
default TypescriptConfigOptions getTsconfigDev()
        (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).

        Default: - use the production tsconfig options

      • getTsconfigDevFile

        @Stability(Experimental)
@Nullable
default String getTsconfigDevFile()
        (experimental) The name of the development tsconfig.json file.

        Default: "tsconfig.dev.json"

      • getTsJestOptions

        @Stability(Experimental)
@Nullable
default TsJestOptions getTsJestOptions()
        (experimental) Options for ts-jest.

      • getTypescriptVersion

        @Stability(Experimental)
@Nullable
default String getTypescriptVersion()
        (experimental) TypeScript version to use.

        NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

        Default: "latest"