Skip to content

Releases: mentat-collective/Clerk-Utils

0.6.0: CAS release, custom-js support

08 Jun 17:09
Compare
Choose a tag to compare
  • #34:

    • adds mentat.clerk-utils.build/release->cas! for sending compiled JS bundles up to Garden.

    • adds :custom-js options to mentat.clerk-utils.build/{build!, serve!} for specifying a different bundle than Clerk's built-in bundle (from Emmy-Viewers, for example)

  • #33 modifies mentat.clerk-utils.build.shadow/install-npm-deps! to skip running an extra npm command if there are no uninstalled dependencies in any deps.cljs files.

0.5.1: compatibility with new Clerk

08 Jun 12:43
Compare
Choose a tag to compare
  • #32 modifies mentat.clerk-utils.build.shadow to include nextjournal.clerk.static-app only when available, adding backwards compatibility in for previous Clerk versions.

  • #31 upgrades Clerk in the project and the template to "5e875e256a28a6deabf27bd6fc20f44cee5dad20", past the sha that removed nextjournal.clerk.static-app in favor of nextjournal.clerk.sci-env.

0.5.0: better cljc support

18 Apr 13:47
a508ab0
Compare
Choose a tag to compare
  • #30 adds better support for Windows by invoking npm using npm.bat when
    appropriate.

  • #29 converts mentat.clerk-utils to cljc. The CLJS side doesn't do
    anything, but this allows the require and macro calls to live inside cljc
    files.

  • #28:

    • Removes the babashka dependency from mentat.clerk-utils.build

    • mentat.clerk-utils.show/q now applies to the forms passed to show-sci,
      allowing for value-splicing, namespace resolution etc inside of show-sci.

  • #24 renames the clj-kondo hooks to have extension .clj_kondo, for the same
    reason as #23.

  • #23 renames .clj and .cljs files in the templates to .tmpl, to prevent
    cljdoc and other tooling from trying to process them as Clojure files.

0.4.1: docs update, fix kondo hooks

20 Feb 16:41
Compare
Choose a tag to compare
  • #24 renames the clj-kondo hooks to have extension .clj_kondo, for the same
    reason as #23.

  • #23 renames .clj and .cljs files in the templates to .tmpl, to prevent
    cljdoc and other tooling from trying to process them as Clojure files.

0.4.0: q macro, latest Clerk compatibility

18 Feb 16:19
Compare
Choose a tag to compare
  • #17 adds mentat.clerk-utils.viewers/q, similar to quote or ', for
    writing viewers with alias resolution and splicing. The clj-kondo config has
    an accompanying hook that handles linting of this form.

  • #21:

    • Adds bb test, GitHub Action for tests and the deps.edn entry required to
      make it work.

    • Fixes a j/ alias left over in mentat.clerk-utils.show/loading-viewer;
      these aliases aren't available in the latest Clerk SCI environment, and need
      to be fully expanded.

  • #19:

    • Upgrades to Clerk version fad499407d979916d21b33cc7e46e73f7a485e37

    • Modifies the clerk-utils/custom template and project to use fully
      qualified vars inside of viewers.

    • Removes mentat.clerk-utils.sci, as register-js! was superceded by the
      new :js-libs option provided by SCI.

  • #18 adds a provided dependency on clerk to the published jar, so that
    cljdoc's analysis will succeed.

  • #16:

    • Fix broken deps reference in clerk-utils/custom template instructions
      (closes #15)

    • In mentat.clerk-utils.build/serve!, call clerk/show! before
      clerk/serve! to prevent flashing loading screen, if an index is supplied.

    • Fix incorrect docstrings in project template bb.edn

    • Add config.edn to clerk-utils/custom template, so that future
      clj-kondo commands (like --copy-config calls etc) work.

0.3.0: custom ClojureScript, new templates

06 Feb 22:44
582c804
Compare
Choose a tag to compare

The big addition with this release is mentat.clerk-utils.build.{serve!,halt!,build!}. These are like the nextjournal.clerk versions, but build custom ClojureScript.

See https://clerk-utils.mentat.org/#custom-clojurescript-builds for more detail.

The other big news is the clerk-utils/custom template, for generating projects with all of the custom ClojureScript wisdom built in. This will make it easy to use Clerk plugins like https://mafs.mentat.org/ and friends.

[0.3.0]

  • #13:

    • Adds a shutdown hook to mentat.clerk-utils.build that calls halt! when
      the JVM shuts down

    • Switches from npm http-server to babashka's http-server, slimming down the
      required entries in package.json just a touch more

    • adds the clerk-utils/custom deps-new template in the resources
      directory, along with an entry in the docs notebook on how to run it. The
      resources/clerk-utils/custom directory has a detailed README, as does the
      generated project.

  • #11:

    • Adds mentat.clerk-utils.sci/register-js! for adding custom JS libraries to
      Clerk's SCI environment.

    • Adds documentation on how to generate custom ClojureScript builds for Clerk.

  • #10:

    • Adds mentat.clerk-utils.css with add-css!, set-css! and reset-css!
      functions for customizing the CSS served in Clerk's header

    • Adds mentat.clerk-utils.docs with git-sha and git-dependency for
      injecting git dependency instructions into a notebook

    • Adds mentat.clerk-utils.build with serve!, build! and halt!
      variations that support custom CLJS compilation

0.2.0: show-cljs and show-sci

30 Dec 13:21
66039ac
Compare
Choose a tag to compare

This release renames the cljs macro to show-sci, and adds a proper show-cljs macro, thanks to @mhuebert.

The other big addition is a documentation page detailing how to use Clerk with a custom ClojureScript bundle. This is a requirement for using ClojureScript and Reagent libraries and plugins that don't ship with Clerk.

That page, along with examples of show-cljs, lives here: https://clerk-utils.mentat.org/dev/clerk_utils/show.html

  • #8:

    • fleshes out show.cljc notebook

    • adds a guide for how to use Clerk with custom ClojureScript

  • #6:

    • Moves the cljs macro to mentat.clerk-utils.show/show-sci, to make it clearer what it's doing.

    • show-sci now works in cljc files by emitting nothing on the Clojurescript side, and maintaining its old behavior on the clj side.

    • Adds a new mentat.clerk-utils.show/show-cljs, ported with permission from @mhuebert's clerk-cljs library.

    • Adds a new documentation notebook at https://clerk-utils.mentat.org/dev/clerk_utils/show.html showing off how to use show-cljs to compile Clojurescript code and render it in Clerk in a single file.

    • To support the above change, https://clerk-utils.mentat.org now builds its own custom JS bundle.

    • Add missing clj-kondo config to the shipped jar.

Better docs: 0.1.0

14 Dec 14:20
a6ec069
Compare
Choose a tag to compare

Announcing v0.1.0 of clerk-utils. This library provides utilities that have been handy writing interactive docs notebooks like https://jsxgraph.mentat.org with #clerk, and documenting library code that won’t ship with a Clerk dependency.

See the interactive docs notebook for more detail: https://clerk-utils.mentat.org

Clojars: https://clojars.org/org.mentat/clerk-utils
Github: https://github.com/mentat-collective/clerk-utils
cljdoc: https://cljdoc.org/d/org.mentat/clerk-utils/0.1.0

From the CHANGELOG, this release:

  • Adds ->clerk-only macro, and better documentation for the
    mentat.clerk-utils namespace.
  • Upgrades the documentation notebook and adds a solid README.

First release: v0.0.1

13 Dec 17:43
0132724
Compare
Choose a tag to compare

Testing the release flow.