2024-02-13 16:09:42 +00:00
# ningle-fbr (WIP)
Plugin for [ningle ](https://github.com/fukamachi/ningle ) and [jingle ](https://github.com/dnaeon/cl-jingle ) to enable file-based routing
2024-02-13 18:57:19 +00:00
# What is file-based routing?
File-based routing is a concept commonly used in modern web frameworks such as [Next.js ](https://nextjs.org/ ). Instead of explicitly defining routes through configuration or code, the framework automatically sets up routes based on the file hierarchy of a particular directory (usually the "pages" or "routes" directory).
2024-02-13 16:09:42 +00:00
# Usage
To use ningle-fbr, you must use [package-inferred-system ](https://asdf.common-lisp.dev/asdf/The-package_002dinferred_002dsystem-extension.html ).
`/example.asd`
```lisp
(defsystem "example"
:class :package-inferred-system
:pathname "src"
:depends-on ("example/app")
```
`/src/app.lisp`
```lisp
(uiop:define-package #:example
(:nicknames #:example/app )
(:use #:cl )
(:import-from #:ningle )
(:import-from #:ningle -fbr))
(in-package #:example/app )
(defparameter *app* (make-instance 'ningle:< app > ))
(defun update-routes ()
(ningle-fbr:enable-file-based-routing
*app*
2024-02-25 05:06:22 +00:00
:directory "src/routes"
:system "example"))
2024-02-13 16:09:42 +00:00
(update-routes)
```
## Static routing
`/src/routes/index.lisp` → `/`
```lisp
(uiop:define-package #:example/routes/index
(:use #:cl )
(:export #:on -get
#:on -post
#:on -put
#:on -delete))
(in-package #:example/routes/index )
(defun on-get (params)
...)
(defun on-post (params)
...)
(defun on-put (params)
...)
(defun on-delete (params)
...)
```
## Dynamic routing
A file or directory name prefixed with '=' indicates a dynamic path.
In the example below, the name parameter can be obtained from handler's params.
`/src/routes/user/=name.lisp` → `/user/:name`
# License
Licensed under MIT License.
Copyright (c) 2024, skyizwhite.
