Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@goodeggs/tsconfig

goodeggs42MIT2.0.2

Shared Good Eggs TypeScript configurations.

readme

@goodeggs/tsconfig

Shared TypeScript configuration files for use in Good Eggs modules and applications.

Installation

Install via npm:

$ npm install --save-dev @goodeggs/tsconfig

Install via yarn:

$ yarn add --dev @goodeggs/tsconfig

Usage

NOTE: These configurations are intended for use with Babel. If you are transpiling via tsc, these configurations will not work for you!

Use the extends property in your tsconfig.json to inherit from these shared configurations:

{
  "extends": "@goodeggs/tsconfig/base"
}

Releasing

This repo is not currently configured to publish automatically from CI.

To release a new version of this module, use yarn locally to publish the version and create the git tag, then push:

yarn publish --new-version=<major|minor|patch>
git push --follow-tags

Listing of Configurations

  • @goodeggs/tsconfig/base: A base configuration. Makes no assumptions about the environment you're targeting.
  • @goodeggs/tsconfig/browser: A base browser configuration. Assumes you are targeting an ESNext feature set (and using Babel to achieve compatibility with older browsers if desired).
  • @goodeggs/tsconfig/react: A React/JSX configuration. Assumes you are targeting an ESNext feature set (and using Babel to achieve compatibility with older browsers if desired).

changelog

CHANGELOG

2.0.0

  • fix(base): Fix lib option to not include browser-specific libs (e.g. DOM)
  • feat: bump from hardcoded ES2018 target to ESNext