# @edx/typescript-config

> TypeScript configuration for edX JavaScript code.

Latest version **1.1.0** (published 2024-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @edx/typescript-config
pnpm add @edx/typescript-config
yarn add @edx/typescript-config
bun add @edx/typescript-config
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-08-08 |
| First published | 2023-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 40.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | edX |
| Maintainers | openedx-semantic-release-bot, feanil, edx-old-org, edx-semantic-release |
| Keywords | typescript, tsconfig, open edx, edx |

## Links

- npm: https://www.npmjs.com/package/@edx/typescript-config
- Repository: https://github.com/openedx/typescript-config
- Homepage: https://github.com/openedx/typescript-config#readme
- Issues: https://github.com/openedx/typescript-config/issues
- npm.io page: https://npm.io/package/@edx/typescript-config

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-08-08
- 1.0.1 — 2023-05-12
- 1.0.0 — 2023-04-13

## 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/)
[![NPM Version](https://img.shields.io/npm/v/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/typescript-config)
[![npm_downloads](https://img.shields.io/npm/dt/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/tpyescript-config)
[![license](https://img.shields.io/npm/l/@edx/typescript-config.svg)](https://github.com/openedx/typescript-config/blob/main/LICENSE)
[![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)

# @edx/typescript-config

## About

The 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).

## Installation

```
npx install-peerdeps --dev @edx/typescript-config
```

This will install the package and all of its peer dependencies.

## Usage

Create 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.

```Sample json
{
  "extends": "@edx/typescript-config",
  "compilerOptions": {
    "rootDir": ".",
    "outDir": "dist"
  },
  "include": ["src/**/*"],
  "exclude": ["dist", "node_modules"]
}
```

---
_Source: https://npm.io/package/@edx/typescript-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._