Git Product home page Git Product logo

ts-typesversions's Introduction

ts-typesversions

Build Status Greenkeeper badge

A library for Typescript package authors to:

  • publish multiple type declaration files using the new typesVersions feature available in Typescript 3.1
  • determine the minimum Typescript version that a package is compatible with

Install

yarn add -D ts-typesversions

Usage

There are two primary intended uses for this project:

  1. As a CLI to check project compatibility with different Typescript versions
  2. Programmatically as part of an npm/yarn release process

CLI

yarn run ts-typesversions

This will invoke an interactive CLI where you can opt to:

  1. just check compilation compatibility with different versions of Typescript
  2. generate declaration files for different TS versions

For full usage instructions, run:

yarn run ts-typesversions --help

As Part of a Release Step

We suggest that you add yarn run ts-typesversions --declarations as part of the prepublishOnly step of the package publish lifecycle.

For example:

{
    "scripts": {
        "prepublishOnly": "rm -rf dist && tsc && yarn run ts-typesversions --declarations"
    }
}

To limit the supported versions to only a subset of Typescript releases you can supply the --ts-versions option.

yarn run ts-typesversions --declarations --ts-versions 3.1,3.0,2.9,2.8

ts-typesversions's People

Contributors

jacobdr avatar greenkeeper[bot] avatar

Stargazers

Kieran Mann avatar

Watchers

James Cloos avatar  avatar

ts-typesversions's Issues

Typescript 4.* support

Hi,

Does this project support newer versions of Typescript?

Are there plans to support version 4.* ?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

An in-range update of inquirer is breaking the build 🚨

The dependency inquirer was updated from 6.2.0 to 6.2.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

inquirer is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details
  • Smoke tests: The build is pending on Semaphore 2.0. (Details).
  • Unit tests: The build is pending on Semaphore 2.0. (Details).
  • Integration tests: The build is pending on Semaphore 2.0. (Details).
  • Push Image: The build is pending on Semaphore 2.0. (Details).
  • Build: The build passed on Semaphore 2.0. (Details).
  • semaphoreci: The build failed on Semaphore. (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of bluebird is breaking the build 🚨

The dependency bluebird was updated from 3.5.3 to 3.5.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

bluebird is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details
  • Unit tests: The build is pending on Semaphore 2.0. (Details).
  • Integration tests: The build is pending on Semaphore 2.0. (Details).
  • Push Image: The build is pending on Semaphore 2.0. (Details).
  • Build: The build passed on Semaphore 2.0. (Details).
  • semaphoreci: The build failed on Semaphore. (Details).
  • Smoke tests: The build passed on Semaphore 2.0. (Details).

Release Notes for v3.5.4
  • Proper version check supporting VSCode(#1576)
Commits

The new version differs by 6 commits.

  • e0222e3 Release v3.5.4
  • 4b9fa33 missing --expose-gc flag (#1586)
  • 63b15da docs: improve and compare Promise.each and Promise.mapSeries (#1565)
  • 9dcefe2 .md syntax fix for coming-from-other-languages.md (#1584)
  • b97c0d2 added proper version check supporting VSCode (#1576)
  • 499cf8e Update jsdelivr url in docs (#1571)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.