tyscan

    0.3.2 • Public • Published

    TyScan logo

    TyScan

    npm version

    TyScan is a command-line tool for scanning TypeScript code by own custom rules.

    Getting started

    1. Install TyScan and TypeScript:
    $ npm install tyscan typescript --save-dev
    1. Verify the installation:
    $ npx tyscan --version
    1. Create a rule file tyscan.yml:
    $ npx tyscan init
    1. Scan your TypeScript files:
    $ npx tyscan scan

    You can write your own rules into the generated tyscan.yml file. See the documentation for more details.

    Docker

    We provide Docker images for TyScan.

    $ docker run -it --rm -v "$PWD":/work sider/tyscan

    You can pick a tag for the version you want to use or try with the latest tag (default).

    Also, you can try with the master tag which points to the latest version on the master branch!

    Documentation

    Contributing

    Bug reports, feature requests, and pull requests are welcome on GitHub at https://github.com/sider/TyScan.

    Keywords

    none

    Install

    npm i tyscan

    DownloadsWeekly Downloads

    471

    Version

    0.3.2

    License

    MIT

    Unpacked Size

    121 kB

    Total Files

    106

    Last publish

    Collaborators

    • sider-org