marten_importmap

0.1.23 versions

github.com/treagod/marten-importmap

No description declared in shard.yml.

4 stars
1 dependent
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  marten_importmap:
    github: treagod/marten-importmap
    version: ~> 0.1.2

Then run:

shards install

shard.yml

Crystal
>= 1.13.0
License
MIT
Author
Marvin Ahlgrimm

Dependencies

Runtime Dependencies

Development Dependencies

  • ameba*github: crystal-ameba/ameba, branch: masterdev
  • sqlite3*github: crystal-lang/crystal-sqlite3dev

README

MartenImportmap

Integration between Marten and the ImportMap shard.

Installation

Add the shard to your shard.yml:

dependencies:
  marten_importmap:
    github: treagod/marten-importmap

Run shards install, then add the two requires to your project:

# src/project.cr
require "marten"
require "marten_importmap"
# src/cli.cr  (needed before running `marten importmap init`)
require "marten/cli"
require "marten_importmap/cli"

Then initialize the project:

marten importmap init

marten importmap init will:

  • add require "marten_importmap" to src/project.cr if not present
  • add require "marten_importmap/cli" to src/cli.cr if the file exists and the require is missing
  • add MartenImportmap::App to config.installed_apps
  • create config/initializers/importmap.cr for user-managed importmap entries
  • create config/initializers/importmap_pins.cr for CLI-managed pins
  • create src/assets/application.js if it does not exist

Template tag

Add {% importmap %} inside the <head> of your base template. It renders the <script type="importmap"> block and a <script type="module"> tag for the entrypoint:

<head>
  <link rel="stylesheet" href="{% asset 'css/app.css' %}" />
  {% importmap %}
</head>

Optional arguments:

{% importmap %}                                  {# default namespace, entrypoint "application" #}
{% importmap "admin" %}                          {# custom namespace #}
{% importmap "admin" entrypoint="admin/app" %}   {# custom namespace and entrypoint #}

Configuration

Marten.configure do |config|
  # Default: false (download resolved modules into vendor_scripts_dir)
  config.importmap.keep_cdn_urls = false

  # Default: "src/assets/vendor/"
  config.importmap.vendor_scripts_dir = "src/assets/vendor/"

  config.importmap.draw do
    pin "application", "application.js"
  end
end

Use config/initializers/importmap.cr for manual pins, namespaces, and pin_all_from directives.

CLI

After initialization, pin a library using JSPM:

marten importmap pin react
marten importmap pin react --from jsdelivr

Supported providers: jspm.io (default), jsdelivr, unpkg, skypack, esm.sh.

The command downloads the resolved module to src/assets/vendor/ and updates config/initializers/importmap_pins.cr:

# AUTO-GENERATED by `marten importmap pin ...`
# DO NOT EDIT.

Marten.configure do |config|
  config.importmap.draw do
    pin "react", "vendor/react.js"
  end
end

config/initializers/importmap_pins.cr is CLI-managed. config/initializers/importmap.cr remains user-managed.

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This release

Version
0.1.2
Tagged
Mar 26, 2026
Commit
c6c6cde8ab18
Crystal
>= 1.13.0
Indexed
yes

Dependents

Repository

github.com/treagod/marten-importmap

Metadata

Created
Aug 18, 2026
Updated
Sep 26, 2026
Synced
Sep 26, 2026
Versions
3