{"id":18763578,"url":"https://github.com/iguntur/read-tsconfig","last_synced_at":"2025-12-06T03:30:11.308Z","repository":{"id":57348594,"uuid":"161091405","full_name":"iguntur/read-tsconfig","owner":"iguntur","description":"Read tsconfig.json file","archived":false,"fork":false,"pushed_at":"2018-12-20T23:37:09.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-30T09:16:58.711Z","etag":null,"topics":["compiler","config","json5","pkg","read","ts","tsc","tsconfig","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iguntur.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-09T23:30:38.000Z","updated_at":"2023-01-26T00:37:11.000Z","dependencies_parsed_at":"2022-08-24T18:14:25.240Z","dependency_job_id":null,"html_url":"https://github.com/iguntur/read-tsconfig","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iguntur%2Fread-tsconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iguntur%2Fread-tsconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iguntur%2Fread-tsconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iguntur%2Fread-tsconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iguntur","download_url":"https://codeload.github.com/iguntur/read-tsconfig/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239661824,"owners_count":19676411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compiler","config","json5","pkg","read","ts","tsc","tsconfig","typescript"],"created_at":"2024-11-07T18:26:39.679Z","updated_at":"2025-12-06T03:30:11.272Z","avatar_url":"https://github.com/iguntur.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# read-tsconfig\n\n[![Travis CI](https://img.shields.io/travis/iguntur/read-tsconfig.svg?style=flat-square)](https://travis-ci.org/iguntur/read-tsconfig)\n[![node](https://img.shields.io/node/v/read-tsconfig.svg?style=flat-square)](#)\n[![npm](https://img.shields.io/npm/v/read-tsconfig.svg?style=flat-square)](https://www.npmjs.org/package/read-tsconfig)\n[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat-square)](#)\n\n---\n\n## Install\n\n```console\n$ npm install read-tsconfig\n```\n\n## Usage\n\n```js\nconst readTsconfig = require('read-tsconfig');\n\nreadTsconfig().then(config =\u003e {\n    console.log(config);\n    /*\n    {\n        compilerOptions: {\n            outDir: 'dist',\n            // ...\n        }\n    }\n    */\n});\n\nconsole.log(readTsconfig.sync({cwd: './packages/foo'}));\n```\n\n## API\n\n### readTsconfig(`options`)\n\n- Params:\n  - `options`: [`\u003cReadOptions\u003e`](#readoptions)\n- Returns: `Promise\u003c{}\u003e`\n\n### readTsconfig.sync(`options`)\n\n- Params:\n  - `options`: [`\u003cReadOptions\u003e`](#readoptions)\n- Returns: `\u003cobject\u003e`\n\n#### `ReadOptions`\n\n- `cwd`: `\u003cstring\u003e`\n  - default: `process.cwd()`\n\n\n## Related\n\n- [has-tsconfig](https://github.com/iguntur/has-tsconfig) - Indicates whether the project has `tsconfig.json` file.\n\n\n## License\n\nMIT © [Guntur Poetra](https://github.com/iguntur)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figuntur%2Fread-tsconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figuntur%2Fread-tsconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figuntur%2Fread-tsconfig/lists"}