demo

plugins/demo/README.md

@@ -0,0 +1,25 @@
+# Demo
+
+A demo project of a custom scittle build.
+
+See:
+
+- `bb.edn` with
+  - `:deps` which includes:
+    - a dependency on the `scittle.build` project to build scittle + custom features
+    - zero or more plugin dependencies
+    - helpers like static file server
+  - development `:tasks`. Run `bb dev` for development and `bb release` to produce release artifacts.
+- `deps.edn`: this only contains a dependency on scittle itself
+
+Available plugins are in the `plugins` directory inside the top level directory of this repo.
+
+Writing a plugin involves writing
+
+- SCI configuration (this can be shared with users in the [sci.configs](https://github.com/babashka/sci.configs) project
+- Adding a `scittle_plugin.edn` file on the plugin's classpath (e.g. in the `src` directory). This EDN file contains:
+  - `:name`, name of the plugin
+  - `:namespaces`: the namespaces exposed to SCI
+  - `:js`: the name of the produced `.js` module file
+  - `:shadow-config`: the shadow-cljs configuration specific to this plugin
+- A `.cljs` file with an `init` function which calls `scittle/register-plugin!`.

plugins/demo/bb.edn

@@ -1,4 +1,20 @@
-{:deps {acme/custom.scittle {:local/root "."}}
- :tasks {:requires ([scittle.build :as build])
-         release {:task (build/build {})}}}
-x
+{:deps {io.github.babashka/scittle.build {:local/root "../../build"}
+        ;; datascript plugin
+        io.github.babashka/scittle.datascript {:local/root "../../plugins/datascript"}
+        io.github.babashka/http-server
+        {:git/sha "b38c1f16ad2c618adae2c3b102a5520c261a7dd3"}}
+ :tasks
+ {:requires ([scittle.build :as build])
+  watch   {:doc "Watch build"
+           :task (build/build {:action "watch"})}
+  serve {:doc "Starts http server for serving static files"
+         :requires ([babashka.http-server :as http])
+         :task (do (http/serve {:port 1341 :dir "resources/public"})
+                   (println "Serving static assets at http://localhost:1341"))}
+  -dev {:depends [watch serve]
+        :parallel true}
+  dev {:doc "Run compilation in watch mode and start http server"
+       :task (do (run '-dev {:parallel true})
+                 (deref (promise)))}
+  release {:doc "Release build (advanced compiled JS)"
+           :task (build/build {})}}}

plugins/demo/deps.edn

@@ -1,5 +1 @@
-{:deps
- {io.github.babashka/scittle {:local/root "../.."}
-  io.github.babashka/scittle.build {:local/root "../../build"}
-  ;; datascript plugin
-  io.github.babashka/scittle.datascript {:local/root "../../plugins/datascript"}}}
+{:deps {io.github.babashka/scittle {:local/root "../.."}}}