{"id":20037827,"url":"https://github.com/openedx/typescript-config","last_synced_at":"2025-03-02T06:24:03.716Z","repository":{"id":65632500,"uuid":"596190360","full_name":"openedx/typescript-config","owner":"openedx","description":"Common TypeScript configuration for Open edX","archived":false,"fork":false,"pushed_at":"2023-09-28T14:41:02.000Z","size":80,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":45,"default_branch":"master","last_synced_at":"2024-05-10T02:41:33.448Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-01T16:54:40.000Z","updated_at":"2024-08-08T13:51:55.159Z","dependencies_parsed_at":"2024-08-08T14:08:24.569Z","dependency_job_id":null,"html_url":"https://github.com/openedx/typescript-config","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ftypescript-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ftypescript-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ftypescript-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ftypescript-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/typescript-config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241467796,"owners_count":19967728,"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":[],"created_at":"2024-11-13T10:23:01.663Z","updated_at":"2025-03-02T06:24:03.683Z","avatar_url":"https://github.com/openedx.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/openedx/typescript-config/actions/workflows/release.yml/badge.svg)](https://github.com/openedx/typescript-config/actions/workflows/release.yml/)\n[![NPM Version](https://img.shields.io/npm/v/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/typescript-config)\n[![npm_downloads](https://img.shields.io/npm/dt/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/tpyescript-config)\n[![license](https://img.shields.io/npm/l/@edx/typescript-config.svg)](https://github.com/openedx/typescript-config/blob/main/LICENSE)\n[![semantic release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n# @edx/typescript-config\n\n## About\n\nThe presence of a tsconfig.json file in a directory indicates that the directory is the root of a TypeScript project. The tsconfig.json file specifies the root files and the compiler options required to compile the project (from https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).\n\n## Installation\n\n```\nnpx install-peerdeps --dev @edx/typescript-config\n```\n\nThis will install the package and all of its peer dependencies.\n\n## Usage\n\nCreate file in repository `tsconfig.json`, with a clause `\"extends\": \"@edx/typescript-config\"`, adding references to the root directory, output directory, and directories to include/exclude in TypeScript compilation.\n\n```Sample json\n{\n  \"extends\": \"@edx/typescript-config\",\n  \"compilerOptions\": {\n    \"rootDir\": \".\",\n    \"outDir\": \"dist\"\n  },\n  \"include\": [\"src/**/*\"],\n  \"exclude\": [\"dist\", \"node_modules\"]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ftypescript-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ftypescript-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ftypescript-config/lists"}