code-engine





🚧 Caution ‍️🚧
-------------------------------
CodeEngine is still being developed and should be considered an early beta at this point. It may have bugs and/or performance issues, and we may introduce breaking changes as we solidify the API and functionality.

Features
-------------------------------
Code Engine is a highly customizable, plugin-based code generator. It can be used as a build tool, a static site builder, a file processor, or any workflow that entails reading input data, performing a series of transformations on it, and outputing the transformed data.

- 🔌 Plugable

Plugins can read data from any source (filesystem, database, CMS, etc.), process it in any way (compile code, compress images, render templates, etc.), and then output the data to any destination.

- 🚀 Fast

CodeEngine is truly multi-threaded, so it takes full advantage of your multi-core CPU to process multiple files concurrently.

- 👁 Incremental Re-Builds

CodeEngine watches your source files for changes and automatically re-builds _only_ what needs to be re-built based on the changes.

- ✨ Modern

CodeEngine uses bleeding-edge JavaScript features, so you can write plugins using the latest JavaScript syntax, including async/await, for await...of, etc. CodeEngine even natively supports TypeScript - no compilation step needed!

- 🧩 Functional

CodeEngine plugins are pure functions that can easily be chained together in different ways to accomplish amazing things.

Installation
-------------------------------
Install using npm. Add the -g flag to install globally so you can run CodeEngine from any terminal window.

``bash
npm install -g code-engine
`

Usage
-------------------------------
- Command-Line Interface
- Programmatic API
- Creating a Generator
- Writing a Plugin


Contributing
--------------------------
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.

#### Building
To build the project locally on your computer:

1. __Clone this repo__

git clone https://github.com/CodeEngineOrg/code-engine.git

2. __Install dependencies__

npm install

3. __Build the code__

npm run build

4. __Run the tests__

npm test`

License
--------------------------
Code Engine is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To
--------------------------
Thanks to these awesome companies for their support of Open Source developers ❤