Numbers Prefer Multiplication

    fork-vue-type-check
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    vue-type-check

    vue-type-check is a type checker for typescript written Vue components.

    It provides both a CLI wrapper and a programmatically API which is easy to integrate with your current workflow.

    Features

    • type checking template code.
    • type checking script code.

    Usage

    CLI

    Install: npm i -g vue-type-check
     
    Usage: vue-type-check or vtc
    Options:
      --workspace        path to your workspace, required
      --srcDir           path to the folder which contains your Vue components, will fallback to the workspace when not passed
      --onlyTemplate     whether to check the script code in a single file component

    Example

    We are going to check a simple Vue component with two type errors:

    <template>
      <div id="app">
        <p>{{ msg }}</p>
      </div>
    </template>
     
    <script lang="ts">
    import Vue from "vue";
     
    export default Vue.extend({
      name: "app",
      data() {
        return {
          message: "Hello World!"
        };
      },
      methods: {
        printMessage() {
          console.log(this.message.toFixed(1));
        }
      }
    });
    </script>

    example.gif

    Programmatical API

    const { check } = require("vue-type-check");
     
    (async () => {
      await check({
        workspace: PATH_TO_WORKSPACE,
        srcDir: PATH_TO_SRC_DIR,
        excludeDir: PATH_TO_EXCLUDE_DIR,
        onlyTemplate: TRUE_OR_FALSE,
        onlyTypeScript: TRUE_OR_FALSE
      });
    })();

    How it works

    Currently, the implementation is heavily based on vetur's awesome interpolation feature.

    If you are interested in the design decisions and the attempts on other approaches, they can be found in this post.

    Install

    npm i fork-vue-type-check

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    17.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • sebastian.s