npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tstl-simple-inline-func

v1.0.0

Published

TypeScriptToLua plugin that performs inline expansion to simple functions without arguments

Downloads

5

Readme

tstl-simple-inline-func

CI

TypeScriptToLua plugin that performs inline expansion to functions that you annotate.

This plugin is intended to handle functions that do NOT take parameters. If you need to handle parameters, try TSTL-extensions by @Cheatoid instead.

Inline expansion may or may not provide any performance benefit depending on your Lua runtime. Always measure with real world code.

:exclamation: Use this and any code transformation plugin with caution. Mistakes are possible.

Usage

Add a comment containing @inlineStart before the function you want to inline, and @inlineEnd directly afterwards.

Example:

/** @inlineStart */
const FOO = () => {
	const BAR = 1 + 2 + 3;
};
/** @inlineEnd */

FOO();

Becomes:

-- @inlineStart@inlineEnd
local BAR = 1 + 2 + 3

Subsequent comments

Keep in mind, TSTL may choose to strip comments. If you have multiple inline functions next to each other, you may have to combine comments.

This example may NOT work because the first @inlineEnd may get stripped:

/** @inlineStart */
const FOO = () => {
	...
};
/** @inlineEnd */
/** @inlineStart */
const BAR = () => {
	...
};
/** @inlineEnd */

This example may work because we've combined the middle comments:

/** @inlineStart */
const FOO = () => {
	...
};
/** @inlineEnd @inlineStart */
const BAR = () => {
	...
};
/** @inlineEnd */

Removing return

To strip the return keyword from your function, add a comment with @removeReturn somewhere after @inlineStart.

Example:

/** @inlineStart @removeReturn */
const FOO = () => {
	return 7;
};
/** @inlineEnd */

const BAR = FOO();

Becomes:

-- @inlineStart@inlineEnd
local BAR =  7

Installation

Requires TSTL >= 1.22.0

  1. Install this plugin
yarn add tstl-simple-inline-func -D
# or
npm install tstl-simple-inline-func --save-dev
  1. Add tstl-simple-inline-func to tstl.luaPlugins in tsconfig.json
{
	"tstl": {
		"luaPlugins": [
+			{ "name": "tstl-simple-inline-func" }
		],
	}
}

License

CC0