Please note: This project is mainly public because it's used to build Structure Together, which I am in the process of open sourcing. I have written little documentation, but will write more if anyone else is interested.
Minimally-expressive macros for Typescript/Javascript, appropriate for inlining and/or stripping custom print/log/assertion/timing/etc commands (in general: void function calls; see the macros I use for Structure Together for examples. The main benefit of the inlining is so your custom commands don't make your browser console's source code links and stack traces less useful or more cluttered.
Has a simple multiple file watching solution, so you don't need to integrate it into your build script. Instead, you (easily) set it up to run on the final js file outputs of your build script, overwriting the file. If you're not generating any javascript (so not using webpack, browserify, typescript, babel, minifying, etc), and you still want to use Minimal Macros, you also have the option to write to a file of the same name but with the extension ".out.js" instead of ".js" (obviously do this if your source code is the javascript that you'll be serving, which could be the case if you have a small or teaching-related project).
Essentially all it does is inline or strip commands according to a simple configuration file, where the action to be done can depend on a build key and the watched file. Your macro commands can be typed and can use a ...rest parameter. For anything more complex, you'll want to use sweet.js.
Design constraints:
- Don't parse to an AST, for the sake of simplicity and speed.
- The pre-macro-expanded code should be valid TypeScript/JavaScript that does basically the same thing as the expanded code. So you don't ever NEED to run the expand/strip script.
- Currently preserves line numbers. This isn't a hard constraint, in that if someone wants to add support for source maps, or explain to me why it's really easy so I can do it myself, I'm on board.
Python 3.x. On my mac, python3 and python3.6 are aliases to it that I don't think I created.
First set at least the two path variables at the top of src/YOUR_PROJECT_SPECIFIC_MAIN_FILE_TO_MODIFY.py. That should be enough to run the tests. Then:
python3 src/YOUR_PROJECT_SPECIFIC_MAIN_FILE_TO_MODIFY.py -h
If that works, make a copy of YOUR_PROJECT_SPECIFIC_MAIN_FILE_TO_MODIFY.py, name it something better, and put it in your project's repo (not your clone of Minimal Macros), and set the remaining configuration options in it.
- Put the Typescript-specific code behind an interface, so this project can be used to add Minimal Macros to other languages.
- More documentation.
- Anything in "Improvements I'll do if there is interest".
- Any organization or style improvements. Just please don't use highly-abbreviated names.
I'm likely to accept any pull request that doesn't make the project technically worse.
Check the issues to make sure somebody isn't already working on it. Then make an issue for what you want to work on.
This project does not yet use a testing library, but you can run it on the source code for which it was developed as follows.
First set the two path variables at the top of src/YOUR_PROJECT_SPECIFIC_MAIN_FILE_TO_MODIFY.py so that they have the correct root for where this repo is located on your computer.
Then python3 test/run_tests.py