@visulima/tsconfig
Advanced tools
Find and/or parse the tsconfig.json file from a directory path.
Find and / or parse the tsconfig.json file from a directory path, this package is built on top of
@visulima/fs, @visulima/path, jsonc-parser and resolve-pkg-maps
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
npm install @visulima/tsconfig
yarn add @visulima/tsconfig
pnpm add @visulima/tsconfig
Retrieves the TsConfig by searching for the "tsconfig.json" file from a given current working directory.
import { findTsConfig } from "@visulima/tsconfig";
const tsconfig = await findTsConfig(); // => { path: "/Users/../Projects/visulima/packages/tsconfig/tsconfig.json", config: { compilerOptions: { ... } } }
Writes the provided TypeScript configuration object to a tsconfig.json file.
import { writeTsConfig } from '@visulima/package';
writeTsConfig({ compilerOptions: { ... } }/* ,{ cwd: "./" }*/);
Reads the TypeScript configuration from a tsconfig.json file.
import { readTsConfig } from "@visulima/package";
const tsconfig = await readTsConfig("/Users/../Projects/visulima/packages/tsconfig.json" /* { tscCompatible: false } */);
tscCompatible: If true, the configuration will be parsed in a way that is compatible with the TypeScript compiler.
type TsConfigJson: object;
Type for TypeScript's tsconfig.json file (TypeScript 3.7).
optional compileOnSave: boolean;
Enable Compile-on-Save for this project.
optional compilerOptions: CompilerOptions;
Instructs the TypeScript compiler how to compile .ts files.
optional exclude: string[];
Specifies a list of files to be excluded from compilation. The exclude property only affects the files included via the include property and not the files property.
Glob patterns require TypeScript version 2.0 or later.
optional extends: string | string[];
Path to base configuration file to inherit from.
optional files: string[];
If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude. When a files property is specified, only those files and those specified by include are included.
optional include: string[];
Specifies a list of glob patterns that match files to be included in compilation.
If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude.
optional references: References[];
Referenced projects.
optional typeAcquisition: TypeAcquisition;
Auto type (.d.ts) acquisition options for this project.
optional watchOptions: WatchOptions;
Instructs the TypeScript compiler how to watch files.
node_modules/.pnpm/type-fest@4.26.1/node_modules/type-fest/source/tsconfig-json.d.ts:1
function findTsConfig(cwd?, options?): Promise<TsConfigResult>
An asynchronous function that retrieves the TSConfig by searching for the "tsconfig.json" first, second attempt is to look for the "jsconfig.json" file from a given current working directory.
• cwd?: string | URL
Optional. The current working directory from which to search for the "tsconfig.json" file.
The type of cwd is string.
• options?: Options = {}
Promise<TsConfigResult>
A Promise that resolves to the TSConfig result object.
The return type of the function is Promise<TsConfigResult>.
An Error when the "tsconfig.json" file is not found.
packages/tsconfig/src/find-tsconfig.ts:29
function findTsConfigSync(cwd?, options?): TsConfigResult
• cwd?: string | URL
• options?: Options = {}
packages/tsconfig/src/find-tsconfig.ts:66
function readTsConfig(tsconfigPath, options?): object
• tsconfigPath: string
• options?: Options
object
optional compileOnSave: boolean;
Enable Compile-on-Save for this project.
optional compilerOptions: CompilerOptions;
Instructs the TypeScript compiler how to compile .ts files.
optional exclude: string[];
Specifies a list of files to be excluded from compilation. The exclude property only affects the files included via the include property and not the files property.
Glob patterns require TypeScript version 2.0 or later.
optional files: string[];
If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude. When a files property is specified, only those files and those specified by include are included.
optional include: string[];
Specifies a list of glob patterns that match files to be included in compilation.
If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude.
optional references: References[];
Referenced projects.
optional typeAcquisition: TypeAcquisition;
Auto type (.d.ts) acquisition options for this project.
optional watchOptions: WatchOptions;
Instructs the TypeScript compiler how to watch files.
packages/tsconfig/src/read-tsconfig.ts:308
function writeTsConfig(tsConfig, options): Promise<void>
An asynchronous function that writes the provided TypeScript configuration object to a tsconfig.json file.
• tsConfig: TsConfigJson
The TypeScript configuration object to write. The type of tsConfig is TsConfigJson.
• options: WriteFileOptions & object & object = {}
Optional. The write options and the current working directory. The type of options is an
intersection type of WriteOptions and a Record type with an optional cwd key of type string.
Promise<void>
A Promise that resolves when the tsconfig.json file has been written.
The return type of function is Promise<void>.
packages/tsconfig/src/write-tsconfig.ts:17
function writeTsConfigSync(tsConfig, options): void
A function that writes the provided TypeScript configuration object to a tsconfig.json file.
• tsConfig: TsConfigJson
The TypeScript configuration object to write. The type of tsConfig is TsConfigJson.
• options: WriteFileOptions & object & object = {}
Optional. The write options and the current working directory. The type of options is an
intersection type of WriteOptions and a Record type with an optional cwd key of type string.
void
A Promise that resolves when the tsconfig.json file has been written.
The return type of function is Promise<void>.
packages/tsconfig/src/write-tsconfig.ts:35
const implicitBaseUrlSymbol: typeof implicitBaseUrlSymbol;
packages/tsconfig/src/read-tsconfig.ts:305
type TsConfigJsonResolved: Except<TsConfigJson, "extends">;
packages/tsconfig/src/types.ts:3
type TsConfigResult: object;
config: TsConfigJsonResolved;
path: string;
packages/tsconfig/src/find-tsconfig.ts:14
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
If you would like to help take a look at the list of issues and check our Contributing guidelines.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
The visulima tsconfig is open-sourced software licensed under the MIT
FAQs
Find and/or parse the tsconfig.json file from a directory path.
The npm package @visulima/tsconfig receives a total of 933 weekly downloads. As such, @visulima/tsconfig popularity was classified as not popular.
We found that @visulima/tsconfig demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.
Security News
Socket has been recognized for the second consecutive year on the Fortune Cyber 60 list, which identifies the most significant venture-backed cybersecurity startups.
Security News
Python becomes GitHub's top language in 2024, driven by AI and data science projects, while AI-powered security tools are gaining adoption.