Giter Club home page Giter Club logo

vue-tsc-files's Introduction

vue-tsc-files

GitHub Workflow Status

A tiny tool to run tsc on specific files without ignoring tsconfig.json.

English | 简体中文

About vue-tsc-files

Fork from gustavopch/tsc-files, and support the Typescript in Vue.

Installation

npm i -D vue-tsc-files
yarn add -D vue-tsc-files

Why

I wanted to type-check only the staged files with lint-staged.

Unfortunately passing specific files like tsc --noEmit file1.ts file2.ts will cause TypeScript to simply ignore your tsconfig.json.

There's already an open issue in the TypeScript repo to support this use case — you may want to give a 👍 there: microsoft/TypeScript#27379

Usage

With lint-staged:

{
  "lint-staged": {
    "*.{vue,ts}": "vue-tsc-files --noEmit"
  }
}

Vue-tsc-files can auto search d.ts from root or src dir. If you have more, you can add there in lint-staged.config.js

const declarationFiles = ['src/global.d.ts', 'src/shims-vue.d.ts']

module.exports = {
  '*.{vue,ts}': (filenames) => {
    const files = [...filenames, ...declarationFiles]
    return `vue-tsc-files ${files.join(' ')} --noEmit --skipLibCheck`
  },
}

How it works

For the most part, it just forwards all arguments to tsc with one exception: the specified files will not be forwarded — instead, they will be put at the files property of a temporary config that will be generated next to your original tsconfig.json. Other than that, just read tsc --help.

License

Released under the MIT License.

vue-tsc-files's People

Contributors

gustavopch avatar dependabot[bot] avatar leglegend avatar ipwright83 avatar mrorz avatar scrungrth avatar

Stargazers

 avatar  avatar  avatar

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.