Giter VIP home page Giter VIP logo

materialize-ts-function's Introduction

npm codecov

Materialize typescript functions

A simple cli command to materialize the response of a typescript async function during build time.

The simplest use-case

1. Annotate your function with @materialized

import { readFile } from "fs/promises";

/**
 * @materialized
 */
async function getVersion() {
	// return anything that survives JSON.stringify()

	const pkg = await readFile("./package.json");
	const parsed = JSON.parse(pkg.toString());
	return parsed.version;
}

2. Rewrite the code during build

npx materialize-ts-function

3. End result

/**
 * @materialized
 */
async function getVersion() {
	/* __materialized__ */
	return "1.0.0";
}

Conditionally skipping materialize

Use any boolean returning expression with @if annotation

/**
 * @materialized
 * @if process.env.DEBUG !== undefined
 */
async function someComplexLogic() {
	// add business logic here
}

How it works internally

We scan the codebase for all files containing functions with the @materialized annotation and temporarily add a simple statement to the end of the file to make it executable with ts-node.

Then we capture the output and replace the annotated functions body with the serialized response from the ts-node execution.

// Temporary statements to execute the function
import { materialize } from "materialize-ts-function";

materialize(
	someComplexLogic, // <-- @materialized function
	process.env.DEBUG !== undefined // <-- @if annotation literal
)
	.then(console.log)
	.catch(console.error);

To debug one can add the same statement to the file and execute if with

ts-node ./src/original/file/location.ts

Thats it ...

... happy coding :)

materialize-ts-function's People

Contributors

aarne avatar dependabot[bot] avatar

Watchers

 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.