Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

ingenr

0.5.0 • Public • Published

InGenR

InGenR (pronounced in-gen-are) is a generic utility for inline code generation.

When working with large codebases, esp. those involving (one or more) type systems it is often the case that reusing code (while retaining end-to-end type-safety) becomes difficult and repetitive boilerplate is required in some cases to satisfy the type system. Not sure what this means ? Check out the typescript definitions for some node APIs, the repetitive boilerplate in elm-css, etc.

Features like Higher kinded polymorphism largely alleviate this problem, but if your language of choice doesn't have such features, then you are pretty much stuck. It is not always feasible or practical to switch to a language with an advanced type system to eliminate redundancy in some parts of your application.

InGenR aims to be a simple generic utility that solves this through a much simpler and crude approach: code generation. For many use cases this is a much more practical and simple solution. You can get started in a matter of seconds, or browse available features.

InGenR cares about the developer experience

  • Clear unambiguous error messages.

  • Minimal Configuration: no surprises, no magic.

  • Plays well with the tools (linters, type-checkers, loaders, etc.) which you already have in place.

It is heavily inspired by Crystal Macros and Sinaps.

Development Status

⚠️ Beta

Build Status Known Vulnerabilities FOSSA Status

SonarCloud badge Greenkeeper badge GitHub Join the chat at https://gitter.im/InGenR/Lobby

How does it work ?

  1. Add InGenR directives to your source files in comment blocks:

    Eg. In src/data-layer/users.ts:

    /*! InGenR:expand knex-dal
    * ---
    * tableName: users
    * columns:
    *   - name: name
    *     type: string
    *   - name: email
    *     type: string
    */
    /*! InGenR:end */

    An InGenR directive specifies the name of generator (knex-dal) and arguments passed to the generator (in YAML or JSON formats).

  2. Write/install your code generator:

    The code generator specified by your directive (here knex-dal) can either reside locally (in a <project-root>/ingenr-generators directory) or in an npm package.

    A generator can be a simple doT template, eg. In ingenr-generators/knex-dal.dot:

    interface {{= it.interfaceName || it.tableName }} {
        {{~ it.columns :c}}
        {{= c.fieldName || c.name }}: {{= c.tsType || c.type }};
        {{~}}
    }
     
    const createTable = () =>
        knex.schema.createTable("{{= it.tableName }}", (table) => {
            table.uuid("id").primary();
            {{~ it.columns :c}}
            table.{{= c.colType || c.type}}("{{= c.columnName || c.name }}")
            {{~}}
        })

    Or a plain javascript module, eg. in ingenr-generators/knex-dal.js:

    export default async () => {
        const result = await getListOfRowsFromDB();
        return result.toJSON();
    }

    Note that our generator can be asynchronous and can do anything that is possible through node.js eg. connect to databases, connect to external resources, use your favorite templating library etc. This is powerful 😎 because you can use any language that compiles to javascript and typecheck or test your generators

    See configuration below to change the location of the directory where InGenR will look for generators.

    Also this generator doesn't have to be local to your project. If a local generator was not found InGenR will try to require knex-dal. This means that you can create and share your generators through npm modules and use them across projects.

  3. Run the generator:

    $ npx ingenr run ./src/**/*

    Don't already have npx ? Read more here.

    InGenR will find all the files with InGenR directives like the above, and expand them in place.

    So after running this, src/data-layer/users.ts will contain:

    /*! InGenR:expand knex-dal
     * ---
     * tableName: users
     * - columns:
     *   - name: name
     *     type: string
     *   - type: email
     *     type: string
     */
    interface IUser {
        user: string;
        email: string;
    }
     
    const createTable = () =>
        knex.schema.createTable("users", (table) => {
            table.uuid("id").primary();
            table.string("user")
            table.string("email")
        })
     
    /*! InGenR:end */

    The result of the generator will be injected right into the source file between the InGenR directive comment blocks.

    Note that running the generator again will have no effect. InGenR checks the contents within the InGenR:expand and InGenR:end blocks and if the content matches what the generator would have generated, nothing will happen. If there is a mismatch - either because the template (or its arguments) have changed or the generated content has been edited manually, InGenR will replace the content within the block entirely.

    You can commit the generated code, and verify the correctness of generated code through any linters, type checkers etc. that you are already familiar with.

Features

The usage outlined above is pretty much all you need to use and get productive with InGenR.

A few additional advanced features are summarized below:

In place expansion or external targets:

Most of the use cases are served well through in place expansion (result of template is injected within the source file where the directive is present). However, in some cases (eg. when you are dealing with multiple languages, your framework expects a specific directory structure etc.) it is desirable that the directives expand into new files.

This is possible by specifying targetFilePath (relative to path of current file):

/*! InGenR:expand knex-dal
 *
 * targetFilePath: users-table.ts
 * ---
 * tableName: users
 * columns:
 *   - name: name
 *     type: string
 *   - name: email
 *     type: string
 */
/*! InGenR:end */

This will populate users-table.ts file with the result of the generator.

Note that the arguments before --- are arguments to the directive itself, where as the arguments after --- are passed on to the generator.

Running multiple generators with same arguments

It is sometimes convenient to invoke multiple generators with the same set of arguments in a single directive. For this we can provide a comma separated list of generator names.

/*! InGenR:expand foo, bar
 * ---
 * tableName: users
 * columns:
 *   - name: name
 *     type: string
 *   - name: email
 *     type: string
 */
/*! InGenR:end */

Passing template arguments through external file

/*! InGenR:expand knex-dal config.yml */
/*! InGenR:end */

This is helpful for sharing config among multiple directives.

Embedded templates

In some cases, for some very small templates it is convenient to embed the template in place within the comment.

While this is available as a convenience feature, it is recommended that larger templates reside in their own files.

/*! InGenR:expand
* ---
* name: lorefnon
* ---
* <div>{{=it.name}}</div>
*/
/*! InGenR:end */

Caveats

  • To be safe, ensure that your files are checked in before running the generator. While InGenR is in beta, we don't recommend running it in pre-commit hooks or as a part of automated pipelines.

    Please report any bugs or unexpected behavior that you encounter.

  • InGenR does not run the generators in a sandboxed environment. If you are using external generators, make sure you trust their authors.

  • InGenR doesn't sanitize the input, or validate the output because doing this in a way that works across languages is hard. Please make sure that you review the inputs that are passed to the templates and validate the outputs through a linter or type-checker.

  • You should not manually edit any code generated by InGenR. When InGenR will be re-run all manual edits will be obliterated.

  • Configuration assumes that referenced filenames don't have spaces

Non-goals

InGenR templates are not reentrant. You can not nest InGenR templates. You can not generate InGenR templates through InGenR templates and expect them to be evaluated. There is no way to compose InGenR expand directives or make them inter-dependant.

This is by design. PRs to change this behavior are not welcome.

InGenR strongly assumes that code generation should be used only as a last resort and the generated code should be minimal and understandable.

While it is possible to re-use doT templates across generators, but seriously, if you have a use case that requires complex code generation routines, then please consider using a language that supports compile time hygenic macros or a different solution.

Contributing

We welcome your contributions. Read more here.

FAQs

Isn't modifying source files risky ?

Not really !

InGenR does not modify any code outside of annotated expand blocks. It is safe to run it multiple times against the same source.

Having generated code live along-side source code in same file often simplifies use cases where expansions are desirable in nested scopes, within class declarations etc.

For small templates (primary use case) it also improves the readability and conveys the intent better. If you want the generated code to reside in dedicated files separate from your source directory, you are more than welcome to do so.

Is InGenR type-safe / hygenic ?

No. InGenR is entirely unaware of what is being templated / replaced / generated. It is entirely language agnostic.

However, it makes it easy to retain your existing linters or type checkers and use them to check the safety of generated code.

Is InGenR similar to C/C++ Macros ?

Yes, in the sense that both are text replacement utilities.

No, in the sense that InGenR is much more explicit and does not try to abstract away the transformations. The generated code is injected right in the source files and is expected to be checked-in.

It is expected that this discourages overuse of macros/templates for things which can be easily achieved through language features.

Why not write babel plugins or Sweet.js macros instead ?

Writing AST transformations is often more cumbersome than text based templates.

Making them play well with TypeScript (or other type systems) and static analyzers can be difficult.

Supported languages

InGenR itself is language agnostic and can be used with any language.

However, if your language natively supports compile time macros (eg. Haxe, Scala, Clojure etc.) or higher order polymorphism (eg. Haskell), or you are happy with dynamic metaprogramming (eg. Ruby, Lisp) then this project may not be useful for you.

It is strongly advised that generated code be run through a linter / syntax-checker after generation because InGenR does not guarantee syntactic validity of generated code.

If at some point I realize that InGenR is not for me. Am I locked in ?

Not at all. Run InGenR once and after your code has been generated, feel free to just remove all (or some) InGenR directives. You are now free to edit and modify the generated code manually.

install

npm i ingenr

Downloadsweekly downloads

8

version

0.5.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability