README.md

node-talisman ·

A npm package for running Thoughtwork's Talisman tool as a CLI.

Requires

• Node 12+

Features

• Supports Talisman v1.32.0.
• Linux, MacOS and Windows supported.

Installation

1. Add package

   npm install --save-dev node-talisman

2. Add a script to package.json

   {
     "scripts" : {
       "node-talisman": "node-talisman",
       ...
     }
     ...
   }

3. Use it as you like 😉

   Using above script:

   npm run node-talisman -- --githook [pre-commit|pre-push]
   
   # finds all .js and .ts files in the current directory (recursively)
   npm run node-talisman -- --pattern="./**/*.{js,ts}"

   Using npx:

   npx node-talisman --githook [pre-commit|pre-push]
   
   # finds all .js and .ts files in the current directory (recursively)
   npx node-talisman --pattern="./**/*.{js,ts}"

   For more details checkout Talisman as a CLI utility.

Contributing Guide

Anyone can help to make this project better - check out the Contributing Guide!

Code of Conduct

Please adhere to Code of Conduct.

Issues

Please make sure to read the Issue Reporting Guidelines before opening an issue.

Changelog

Detailed changes for each release are documented in the release notes.

License

Licensed under the MIT licensed.