koporei

Koporei is an easy router for any Express or Koa applications. As Sapper, Koporei use directly your path as route.

Pages
|- abc
    |- hey.html        <----- GET  /abc/hey
    |- hey.js          <----- POST /abc/hey
|- test.js             <----- POST /test
|- hola.html           <----- GET  /hola
|- index.html          <----- GET  /

Install

Npm:

npm i koporei

Yarn:

yarn add koporei

Usage

Add Koporei as middleware:

Express:

import ExpressApp from 'express';
import { express } from 'koporei';

const app = ExpressApp();

const options = {
    pages: 'src/pages'
}

app.use(express(options));

app.listen(3000);

Koa:

import KoaApp from 'koa';
import { koa } from 'koporei';

const app = new KoaApp();

const options = {
    pages: 'src/pages'
}

app.use(koa(options));

app.listen(3000);

Configuration

const options = {
    // Where your pages are
    pages: 'pages',

    // (optionnal) Make the path to lower case
    isLowerCase: true,

    // (optionnal) If GET requests should return a specific page.
    isSinglePage: 'public/index.html',

    // (optionnal) Different hooks to use
    hooks: {
        onLoadEnd: () => console.log('Routes loaded')
    },

    // (optionnal) Preprocessors
    // An array of KoporeiPreprocessor
    // Executed when routes are loaded. Able you to compile specifics routes
    preprocessors: [{
        extension: 'html',
        transform: (route) => {
            const fileContent = fs.readFileSync(route.filePath);
            fs.writeFile(filePath, fileContent.replace(/World/g, 'Koporei Preprocessors'));
        }
    }]
}

Hooks list

onLoadStart?: () => void;
onLoadEnd?: () => void;
onRouteAdded?: (route: KoporeiRoute) => void;
onExecute?: (route: KoporeiRoute) => void;

Preprocessors

extension: string;
options?: any[]; // You can pass any options in this array, and get them in the transform function
transform: (route: KoporeiRoute, ...options) => void;

To know: koporei support POST requests.

All html file are "GET" requests. But what about "POST" request? Easy to do:

// pages/hey.js
exports.default = (ctx) => {
    ctx.body = "So easy routing!";
}

Need more example? Have a look into working examples in the tests directory!

Compatible Frameworks

Depending your framework, you will get more informations as parameters:

Koa: ctx, next
Express: req, res, next

Contributing

Thanks a lot! To make your contribution, I'm just asking that you don't make your pull request on the master branch, but any other branch. If it's a new feature, you can name it feature/myAwesomeFeature for example.

License

Code released under GPL-3.0 license.