Giter VIP home page Giter VIP logo

anzu's Introduction

๐Ÿ“ Anzu

Anzu is very light CLI tool for checking whether files have license header

Anzu help output Anzu example output

Installation

Remember you have to have deno path set when installing. Do it using this bash command: echo 'export PATH="$HOME/.deno/bin:$PATH"' >> ~/.bashrc You may want to replace ~/.bashrc with your shell rc config, eg. ~/.zshrc for zsh

  • Without explicit permissions:
    • deno install -n anzu https://deno.land/x/anzu@$MODULE_VERSION/src/cli.ts
  • With explicit permissions:
    • deno install -n anzu --allow-read --allow-write --allow-net https://deno.land/x/anzu@$MODULE_VERSION/src/cli.ts
  • You can also do deno run https://deno.land/x/anzu@$MODULE_VERSION/src/cli.ts without actually installing it

๐Ÿ“š Why not deno_license_checker

I got discouraged from deno_license_checker because of several things, majorly:

  • Its size โ€“ 177KB
  • Performance
  • Requirement of config file
  • Doesn't ask for permissions โ€“ they have to be specified otherwise it'll exit

Anzu solves some of these problems:

  • It's significantly smaller โ€“ 27KB
  • In my case its multiple times faster (benchmarks needed)
  • Every option has to be set in CLI
  • If you want to launch same command using one command โ€“ just create bash script that does that (see here)
  • If permissions aren't specified it automatically requests you for them

Why not Anzu?

  • It's not compatible with windows (Im 99.9% sure, but didn't tested it)
  • If you prefer having external config file Anzu probably isn't for you

What can Anzu also do?

  • Additionally it can load license template from given URL and Path
  • It can search for license using RegExp
  • Exclude files and directories using regexp
  • You can see full functionality using -h option.

๐Ÿค Contributing

I'm open to any idea and criticism. Feel free to add any commits, issues and pull requests!

๐Ÿ“ Licensing

This project is available under MIT License conditions.

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.