Have ideas to improve npm?Join in the discussion! »

    code-engine
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    CodeEngine

    Cross-Platform Compatibility Build Status

    Coverage Status Dependencies

    npm License Buy us a tree

    🚧 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.

    npm install -g code-engine

    Usage

    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 ❤

    Travis CI SauceLabs Coveralls

    Install

    npm i code-engine

    DownloadsWeekly Downloads

    1

    Version

    0.0.7

    License

    MIT

    Unpacked Size

    9.45 kB

    Total Files

    7

    Homepage

    engine.codes

    Last publish

    Collaborators

    • avatar