https://github.com/eik-lib/typescript-config

Shared TypeScript configs for use in Eik modules
https://github.com/eik-lib/typescript-config

eik typescript-config

Last synced: about 1 month ago
JSON representation

Shared TypeScript configs for use in Eik modules

• Host: GitHub
• URL: https://github.com/eik-lib/typescript-config
• Owner: eik-lib
• Created: 2024-07-30T12:06:12.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-11-01T09:17:33.000Z (about 2 months ago)
• Last Synced: 2024-11-01T10:20:37.015Z (about 2 months ago)
• Topics: eik, typescript-config
• Language: JavaScript
• Homepage: https://eik.dev
• Size: 16.6 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# @eik/typescript-config

Shared config for TypeScript, used in Eik projects to generate type definitions from JSDoc and test them.

## Install

```

npm install --save-dev typescript @eik/typescript-config

```

## Usage

Create two files in your root directory.

`tsconfig.json` (assuming source in `lib/`):

```json

{

  "extends": "@eik/typescript-config/module.json",

  "include": ["./lib/**/*.js"],

  "compilerOptions": {

    "outDir": "types"

  }

}

```

`tsconfig.test.json` (assuming tests in `tests/`):

```json

{

  "extends": "@eik/typescript-config/test.json",

  "include": ["./tests/**/*.js"]

}

```

You should have a similar setup in your `package.json`:

```json

{

  "scripts": {

    "types": "run-s types:module types:test",

    "types:module": "tsc",

    "types:test": "tsc --project tsconfig.test.json"

  },

  "dependencies": {

    "npm-run-all": "4.1.5"

  }

}

```