https://github.com/grz0zrg/nut
Minimalist build system for JavaScript app.
https://github.com/grz0zrg/nut
Last synced: 3 months ago
JSON representation
Minimalist build system for JavaScript app.
- Host: GitHub
- URL: https://github.com/grz0zrg/nut
- Owner: grz0zrg
- License: bsd-3-clause
- Created: 2017-04-22T15:25:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-13T14:32:13.000Z (about 8 years ago)
- Last Synced: 2025-01-29T12:28:33.773Z (5 months ago)
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nut
---
**Minimalist build system for JavaScript app.**
This is a **minimalist build system** to write JS app. without hassles.
This program is written with the [Anubis language](https://fr.wikipedia.org/wiki/Anubis_(langage))
This is focused on JavaScript app. because it use external programs to build optimized production files but the system can be adapted without much efforts.
It is basically a simple pre-processor producing as many debug and production ready file as needed each time a file change in the app. src directory or specified directories, it is fully recursive.
Files modification date are checked against the build files modification date, if one file appear to be more recent than the build files, the build system trigger itself.
You only need to pass the app file (either CSS or JS) or a list of app files (see usage), Nut will scan one or multiple app files which start with "app_" as filename, they are the entry point of your applications, in these files you can then use directives such as include as follow: `/*#include [FILENAME]*/` Nut will read the entry point file sequentially, include the content of `[FILENAME]` if the directive is encountered (and will seek the include directive in the included files as well) and output a single file application in a dist folder, CSS and JS is automatically detected from the file extension and a program such as a minifier will be called and output a production ready file as well.
It is essential to start Nut in the application root directory, a folder named `dist` should be there.
Base example for web. applications with JS and CSS (basic setup):
* `uglifyjs` and `csso` should be installed with Node/NPM `npm install uglifyjs csso`
* The app. folder should contain a `js` and `css` folder
* `js` folder should contain a file named `app_[APP_NAME].js` where `[APP_NAME]` is your application name
* `css` folder should contain a file named `app_[APP_NAME].css` where `[APP_NAME]` is your application name
* Call Nut in the app. root directory with `anbexec nut -appfile:"[APP_NAME].js" -appfile:"[APP_NAME].css"`
* The debug and production ready files will be available in the `dist` folder as `[APP_NAME].js` `[APP_NAME].css` `[APP_NAME].min.js` `[APP_NAME].min.css`
If you have JS workers which need to be in separate build files, you can use the `-appdir:"path/"` argument, it will produce production build file in a subdirectory for each files JS or CSS files in this directory.
Features:
- Automatized background build by comparing changes between build files and app files every two seconds (recursive)
- Produce debug and production ready files, minified & optimized CSS and JS output in a `dist` folder
- Not restricted to a single build
- Can produce build files for a whole directory if specified (may be useful in case of JS workers)
- Parse `/*#include [FILENAME]*/` directives to provide **KISS** modularity
- Relatively fast & minimalist :)
Recommendation: Only use the include directive in the app file for better clarity, this is my rule, abusing the include directive can be fun but at the expense of clarity... :)
It is not restricted to a single output, just create as many entry point files as wanted and pass a list of output files as argument.
Note: Just don't include files which include themselves, this doesn't check for circularity :P
Usage: `Usage: anbexec nut -appfile:"[app_filename].[js|css]" ...`