inkpen 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066e1936d8ce5802174354accd02c7e00a958bde47fc5e207463691afb1bc360
-  data.tar.gz: a25e8197e62b9227b61e8a7ab9f8ca682372aa7fd08d7a9b15c5d199457d1c15
+  metadata.gz: d494c04bfb8bd300d7530a7bf25bf25bcb9de03940d05efae4b7000056344ba4
+  data.tar.gz: 242089e92a90223d06f5ea5569df0e3cd8653c073705989b0b2c168ef8d9f65b
 SHA512:
-  metadata.gz: e57e7c1a93053612ac75e96d1265a6907e531a1061b5b71be173cf1320ffe5346d0966b4b7099ac6dc0f0b4858c8503894bc68d729bf58d38c4d509a45d5cb04
-  data.tar.gz: ca182780b4fcbaebac1def84ed5c8161b23049f2da2e2da98e3a071104a6c6a6a27f59fe6482e6b30875f498f4dffc527c1e1eb472c44724d428d97767295704
+  metadata.gz: 8622c8eec93c586b4e588d830a8f14a1b235a38c1a88269dc4327952586e308898e4ed20b5d2fac9821af1e79c67deb5263a920969c718d3c160caacca5abf91
+  data.tar.gz: 6d4efde0df050df0601d615662443887aca6ab7f267c80ad1903cd94db63fd3c9277fe4768246db9d5419b7659c66d0a2cda6f04c5f0141e88dfd3b41bbb3240

data/CLAUDE.md

@@ -132,10 +132,70 @@ app/
 
 ## Development
 
+### Ruby side
+
 ```bash
-# Run tests
-bundle exec rake test
+bundle install
+bundle exec rake test    # Minitest unit tests
+bin/console              # IRB with Inkpen loaded
+```
 
-# Console
-bin/console
+### JavaScript side (since 0.8.0)
+
+```bash
+npm install              # installs production deps + esbuild + vitest
+npm test                 # runs the spec 01 markdown round-trip tests (vitest)
+npm run build            # rebuilds app/assets/javascripts/inkpen.bundle.js
+npm run build:check      # validates the bundle: parses, has expected
+                         # exports, contains zero third-party CDN refs
 ```
+
+**The bundle is committed to the repo.** Run `npm run build` after every
+JS change so consumers don't need to install npm.
+
+### Releasing a new version
+
+See `02-addons/107-inkpen-docs/docs/release-process.md` for the full
+release runbook. TL;DR:
+
+1. Bump `lib/inkpen/version.rb` + `inkpen.gemspec` (stub line +
+   `s.version`).
+2. `npm run build && npm run build:check && npm test &&
+   bundle exec rake test`.
+3. `bundle exec rake build` → `pkg/inkpen-X.Y.Z.gem`.
+4. Smoke test in InventList (open Nodepad, confirm zero `esm.sh`
+   requests in DevTools).
+5. Publish (path-pinned / private gemserver / rubygems — see release
+   doc).
+
+## Bundle / vendoring (since 0.8.0)
+
+`config/importmap.rb` no longer pins to `esm.sh`. All upstream
+dependencies (TipTap@2.10.3, ProseMirror@1.x, lowlight, highlight.js,
+tippy, popperjs, linkifyjs, and three third-party TipTap extensions)
+are vendored into a single ESM bundle at
+`app/assets/javascripts/inkpen.bundle.js` (1.9 MB minified, source map
+beside it).
+
+The build entrypoint is `app/assets/javascripts/inkpen/index.js`. The
+bundle preserves `import "inkpen"` as a side-effecting import that
+registers `inkpen--editor`, `inkpen--toolbar`,
+`inkpen--sticky-toolbar` Stimulus controllers on `window.Stimulus`
+(or starts its own Application if the host hasn't already).
+
+**Host externals kept out of the bundle** (host provides them):
+
+- `@hotwired/stimulus`
+- `@hotwired/turbo-rails`
+
+**Why this exists:** three production CDN incidents on 2026-05-14
+caused by importmap pinning to esm.sh. Plan and audit live at
+`02-addons/107-inkpen-docs/plans/05-vendor-bundle-cdn-decoupling.md`.
+
+## Internal planning docs
+
+Inkpen has a dedicated planning surface at
+`02-addons/107-inkpen-docs/`. Roadmap, plans, sessions, handoffs,
+audits all live there. Don't recreate that structure here; this gem
+ships its own consumer-facing docs in `docs/` (README, CHANGELOG,
+FEATURES, ROADMAP, MARKDOWN_MODE planning doc, audits).

data/README.md

@@ -400,6 +400,10 @@ bundle exec rake test  # Run tests
 bin/console            # Interactive console
 ```
 
+## Used by
+
+Powering the series editor at [inventlist.com/stream?type=series](https://inventlist.com/stream?type=series) — where indie builders write build-in-public stories.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub.

data/app/assets/javascripts/inkpen/export/markdown.js

@@ -5,6 +5,8 @@
  * Supports frontmatter, tables, task lists, callouts, and custom blocks.
  */
 
+import { parseMarkdownToHTMLReal } from "./markdown_parser.js"
+
 // Mark serializers for inline formatting
 const MARK_SERIALIZERS = {
   bold: (text) => `**${text}**`,
@@ -74,13 +76,20 @@ export function importFromMarkdown(markdown, schema, options = {}) {
   // Parse frontmatter if present
   const { content, frontmatter } = parseFrontmatter(markdown)
 
-  // Parse markdown to HTML first (using browser or a simple parser)
-  const html = parseMarkdownToHTML(content)
+  // Parser selection. Default is the legacy regex parser to preserve
+  // behavior for existing callers. Pass `options.parser: "real"` to opt
+  // into the GFM-correct marked-based parser. Step 6 of spec 01 will flip
+  // the default once round-trip fixtures pass.
+  const parser = options.parser === "real" ? "real" : "legacy"
+  const html = parser === "real"
+    ? parseMarkdownToHTMLReal(content)
+    : parseMarkdownToHTML(content)
 
   // Return structured result
   return {
     html,
-    frontmatter
+    frontmatter,
+    parser
   }
 }