react-static-plugin-typescript

    7.6.2 • Public • Published

    react-static-plugin-typescript

    A plugin for React Static that allows you to use TypeScript.

    There instructions for enabling this plugin on existing projects below. When setting up a new project using React Static, you can simply select the TypeScript template after running react-static create.

    Installation

    npm install react-static-plugin-typescript @types/react --save-dev

    Usage

    There are three steps to complete before being able to use this plugin.

    First, add the plugin to your static.config.js:

    export default {
      plugins: ['react-static-plugin-typescript'],
    }

    Then add a tsconfig.json, e.g. this one:

    {
      "compilerOptions": {
        "target": "es2015",
        "module": "esnext",
        "lib": ["es2015", "dom"],
        "moduleResolution": "node",
        "skipLibCheck": true,
        "isolatedModules": true,
        "noEmit": true,
        "allowJs": true,
        "jsx": "preserve",
        "sourceMap": true,
        "removeComments": false,
        "strict": true,
        "esModuleInterop": true
      }
    }

    Finally, rename a file from .js to .tsx. You can then start using TypeScript!

    Options

    Options can be passed by using an array, e.g.:

    // In static.config.js:
    export default {
      plugins: [['react-static-plugin-typescript', { typeCheck: true }]],
    }

    typeCheck: boolean

    Default value: true

    Enable or disable type checking for your application during compilation. When this is off, your TypeScript files will still be loaded, but you won't get warnings about type errors unless you set that up separately, e.g. in your editor, a commit hook, or in your CI server. When this is on, your application will fail to run locally when there are type errors.

    Changelog

    See CHANGELOG.md.

    License

    MIT © Vincent Tunru

    Keywords

    none

    Install

    npm i react-static-plugin-typescript

    DownloadsWeekly Downloads

    950

    Version

    7.6.2

    License

    MIT

    Unpacked Size

    14 kB

    Total Files

    6

    Last publish

    Collaborators

    • tannerlinsley
    • sleeplessbyte
    • vincenttunru