Giter Club home page Giter Club logo

inc's Introduction

inc

An inline pattern compiler for embedding code into static files.

Example use-case

Say we have a README file containing the latest version of a package version. Instead of hardcoding that version number and manually updating it when necessary, you can embed some shell code to fetch the version number and use inc to compile your part-Markdown-part-shell file into static Markdown. Here is an example of what that would look like:

# My package

The latest version for this package is |>cat package.txt<|

# Features

* Continue with markdown...

Once compiled via inc, the final contents of your README file would be something like this:

# My package

The latest version for this package is 1.13.15

# Features

* Continue with markdown...

Usage

-h, --help                  Show the usage for this program.
-i, --input                 Input file path to compile from. If none is provide, the standard input is used.
-o, --output                Output file path to write to. If none is provide, the standard output is used.
-1, --begin                 Beginning pattern to match with.
                            (defaults to "|>")
-2, --end                   Ending pattern to match with.
                            (defaults to "<|")
-I, --[no-]ignore-errors    Continue execution even if stderr contains errors or the exit code is non-zero.
-t, --[no-]trim             Remove leading and trailing whitespaces from the output.
                            (defaults to on)

Installing

If you already have Dart installed, simply activate the package globally:

dart pub global activate inc

Then, assuming your global package directory has been added to your PATH, simply call the executable.

inc's People

Contributors

tytydraco avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

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.