jspicl / jspicl

A Javascript to PICO-8 Lua transpiler

jspicl is a Javascript to PICO-8 Lua transpiler. It creates an AST out of the JavaScript code and then transpiles it down to the LUA subset of which PICO-8 supports.

Visit jspicl.github.io for docs, guides, API and more!

jspicl's Issues

Error: There is no handler for ThrowStatement

const { output, polyfills } = jspicl(src);
Thrown:
Error: There is no handler for ThrowStatement
at filter.map.node (/home/zaoqi/src/temp/node_modules/trastpiler/lib/trastpiler.js:39:15)
at Array.map ()
at transpile (/home/zaoqi/src/temp/node_modules/trastpiler/lib/trastpiler.js:35:6)
at BlockStatement (/home/zaoqi/src/temp/node_modules/jspicl/lib/jspicl.js:582:53)
at filter.map.node (/home/zaoqi/src/temp/node_modules/trastpiler/lib/trastpiler.js:42:22)
at Array.map ()
at transpile (/home/zaoqi/src/temp/node_modules/trastpiler/lib/trastpiler.js:35:6)
at FunctionDeclaration (/home/zaoqi/src/temp/node_modules/jspicl/lib/jspicl.js:356:27)
at filter.map.node (/home/zaoqi/src/temp/node_modules/trastpiler/lib/trastpiler.js:42:22)
at Array.map ()

Incompatible with Node 9 / NPM 5.5.1

Had to downgrade to node 8.8.1 / npm 5.4.2 to get this working.
Placeholder issue, will look into what needs changing.

Add support for ArrowFunctionExpression

Technically it should be enough to simply import and call FunctionExpression and return the result, passing in the same arguments.

http://esprima.readthedocs.io/en/latest/syntax-tree-format.html#arrow-function-expression

Create CLI

A CLI would make jspicl more accessible and eliminate the need to setup your own build pipeline using rollup-plugin-jspicl.

The CLI should accept the same input parameters as rollup-plugin-jspicl in addition to the following parameters:

• path to entry source file [mandatory]
• path to output final cartridge [mandatory]
• prettify output
• path to file exporting custom handlers
• path to file exporting custom polyfills

Add polyfill: Object.keys

Add support for for-statement

Add polyfill: Array.prototype.map

function() end()

(function(){...})() => function() ... end()
`> function() end
function: 0x55bdfbe64b10

function() end()
stdin:1: expected near '('
`

Ternary conditional is not supported

Writing a ternary conditional in your code results in an error:

[!] Error: Error transforming bundle: Conditional expressions such as 'a ? b : c;' are not supported.

"use strict"

error loading module 'a' from file './a.lua':
./a.lua:1: unexpected symbol near '"use strict"'

assert(true,????

WARNING #LANG en_CN.UTF-8

ThrowStatement: ({ argument }, { transpile }) =>
assert(true, ${transpile(argument)}),

assert(true,????
Why it is not assert(false,...

Variable and function names are not always normalized

For instance, the following

var $a = 1;

transpiles into

local $a = 1

which is not valid since lua doesn't allow $ in names.

Add polyfill: Array.prototype.includes

Add support for bitwise operators

Examples:

if (a & b) {
  ...
}

if (a | b) {
  ...
}

Logic should be added in binaryExpression.js

Available PICO 8 operators that could be used:

band
bor
bxor
bnot

Add support for TemplateLiteral

https://esprima.readthedocs.io/en/latest/syntax-tree-format.html#tagged-template-expression

Add polyfill: Object.values

Add polyfill: Math.random

Math.random should be transpiled into a polyfilled function random

function random()
  return rnd(0, 1000) / 1000 -- 1000 determines the precision, i.e. 3 decimals
end

Add a LICENSE file

I know that jspicl has an MIT license, but you should also add a LICENSE file, to the repository, to have it "light up" in the GitHub UI

https://help.github.com/articles/adding-a-license-to-a-repository/

-=

error loading module 'a' from file './a.lua':
./a.lua:309: syntax error near '-'

ERROR == error

Add polyfill: String.prototype.split

Include referenced polyfills only

Currenty all polyfills are always included in the generated lua code.
Only include them if they are used by the code.

Collect usage during traversal of the AST tree?

Change logical operators to lowercase

Uppercase logical operators are causing the pico-8 run command to throw a syntax error.

If the cart is loaded first though, pico-8 will automatically change the code to lowercase and the problem will disappear.

• Update logicalExpression.js to output 'AND' and 'OR' as lowercase

Investigate: classes and instantiation

Determine how well jspicl handles:

• classes / prototypal inheritance
• Instatiation with new

Document outcome

Sample project

• add sample project
• add wiki page with show cases

Unit tests are not run in watch mode

Mocha doesn't seem to re-run tests when in watch mode.
Culprit seems to be the -u tdd argument.

Polyfills should have a prefix to avoid collisions with client code

Writing a function in javascript with the same name as a polyfill results in a crash.

Enhance Object.assign polyfill

It should be able to accept more than two arguments

Add Array.prototype.length polyfill.

The Array.prototype.length is missing, add polyfill!

Move code from rollup-plugin-jspicl to this repo

Polyfills for various javascript functions that are handled by rollup-plugin-jspicl should be handled by jspicl instead.

jspicl(source)
      .replace(/\$/g, "_")
      .replace(/Math\.max\(/g, "max(")
      .replace(/Math\.floor\(/g, "flr(")
      .replace(/Object\.assign\(/g, "merge(")
      .replace(/(\w+)\.forEach\(/g, "foreach($1, ")
      .replace(/(\w+)\.push\(/g, "add($1, ")
      .replace(/(\w+)\.join\(/g, "join($1, ");

Includes: https://github.com/AgronKabashi/rollup-plugin-jspicl/blob/master/src/utilities.js

Null/non-value return from functions not supported #9

Hopefully easy fix.

Currently transpiles:

JS `return;`

to

Lua `return nil`

but should be

Lua do return end

Add polyfill: Object.entries

Undefined and nulls are not transpiled.

const a = null; // local a = null
const b = undefined; // local b = undefined

Expected

const a = null; // local a = nil
const b = undefined; // local b = nil

Add units tests and fixtures for statements, expressions and declarations

• Use Mocha & Sinon
• Unit tests for statements
• Unit tests for expressions
• Unit tests for declarations
• Integration tests using sample code

Update Readme with badges

Badges can be created here: https://shields.io/#/

Consider adding:

dependencies
size
downloads (npm)
license
version

Add polyfill: Array.prototype.reduce

Add polyfill: Array.prototype.toString

Insanely nice-to-have and not needed at all. Still, useful.

Add polyfill: Array.prototype.filter

Add support for Switch & Break statements

http://esprima.readthedocs.io/en/latest/syntax-tree-format.html#switch-statement

http://esprima.readthedocs.io/en/latest/syntax-tree-format.html#break-statement

Example output

switch (choice) {
  case "option1":
    break;
  
  case "optionN":
    break;

  default: break;
}

Possible Lua alternatives:

-- Using lookup table: faster ( O(1) ) but requires more tokens
local switch =
{
  ["option1"] = function () ${option1-case-contents} end,
  ["optionN"] = ...,
  ["default"] = ...
}

(switch[choice] or switch["default"] or noop)()

-- Regular if/else statements: slower ( O(n) ) but requires fewer tokens
-- Potential problem: need to make sure that default case is last if available
if (choice == "option1") then
  ${option1-case-contents}
elseif (choice == "optionN") then
  ${option2-case-contents}
else
  ${default-case-contents}
end

Add polyfill: Array.prototype.forEach

For each is good stuff