eik-lib/typescript-config

Shared TypeScript configs for use in Eik modules

@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/):

{
  "extends": "@eik/typescript-config/module.json",
  "include": ["./lib/**/*.js"],
  "compilerOptions": {
    "outDir": "types"
  }
}

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

{
  "extends": "@eik/typescript-config/test.json",
  "include": ["./tests/**/*.js"]
}

You should have a similar setup in your package.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"
  }
}

typescript-config's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update dependency @eik/eslint-config to v1.0.2
• chore(deps): update dependency eslint to v9.9.0
• chore(deps): update dependency semantic-release to v24.1.0

Detected dependencies

github-actions

.github/workflows/publish.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/test.yml

• actions/checkout v4
• actions/setup-node v4

npm

package.json

• @eik/eslint-config 1.0.0
• @eik/prettier-config 1.0.1
• @eik/semantic-release-config 1.0.0
• eslint 9.8.0
• prettier 3.3.3
• rimraf 6.0.1
• semantic-release 24.0.0
• typescript >= 5

---

• Check this box to trigger a request for Renovate to run again on this repository

Create a shareable set of typescript configs

Similar to https://github.com/sindresorhus/tsconfig

We should export two configs from such a module:

• one for buildling the module types
• one for testing them locally (typechecking unit tests)

Looking at this, we should be able to have multiple JSONs in the same module
https://pyk.sh/creating-shareable-and-reusable-typescript-configuration-tsconfigjson