@eventuras/scribo 0.8.3 → 0.10.7

package/README.md

@@ -1,126 +0,0 @@
-# Scribo markdown editor
-
-Markdown editor built on [Lexical framework](https://lexical.dev/). Intended to be used as part of eventuras, but also packed as a standalone component. Scribo is a WYSIWYG editor with markdown export.
-
-The editor should provide simple and intuitive editing of markdown text, with a focus on the most common use cases.
-
-Test the [scribo editor online demo](https://scribo.losol.no/).
-
-> **Lexical version**: we are keeping the lexical version in sync with the [lexical version used in Payload CMS](https://github.com/payloadcms/payload/blob/main/packages/richtext-lexical/package.json), to prevent multiple versions making trouble.
-
-## Installation
-
-```bash
-pnpm add @eventuras/scribo
-```
-
-## Usage
-
-**Important**: You must import the CSS file for Scribo to display correctly:
-
-### MarkdownEditor (WYSIWYG Editor)
-
-```tsx
-import "@eventuras/scribo/style.css";
-import { MarkdownEditor } from "@eventuras/scribo";
-
-function MyComponent() {
-  return <MarkdownEditor defaultValue="# Hello World" />;
-}
-```
-
-### MarkdownInput (Form-ready Input)
-
-For use with native HTML forms (FormData API):
-
-```tsx
-import "@eventuras/scribo/style.css";
-import { MarkdownInput } from "@eventuras/scribo";
-
-function MyForm() {
-  return (
-    <form>
-      <MarkdownInput
-        name="description"
-        label="Description"
-        placeholder="Enter markdown..."
-        defaultValue="# Hello"
-        maxLength={500}
-        className="mb-4"
-        labelClassName="font-bold"
-        editorClassName="border rounded"
-        errorClassName="text-red-500"
-      />
-      <button type="submit">Submit</button>
-    </form>
-  );
-}
-```
-
-The `MarkdownInput` component is framework-agnostic and provides:
-
-- Hidden input for FormData submission
-- Optional label and validation
-- Flexible styling via className props
-- Character limit validation
-
-### Peer Dependencies
-
-Scribo requires the following peer dependencies:
-
-```bash
-pnpm add react react-dom lexical @lexical/code @lexical/hashtag @lexical/link @lexical/list @lexical/mark @lexical/markdown @lexical/overflow @lexical/react @lexical/rich-text @lexical/selection @lexical/table @lexical/utils prismjs
-```
-
-**Prism.js for syntax highlighting:**  
-Scribo uses Prism.js for code syntax highlighting but does not bundle it. You need to install `prismjs` and import the language grammars you need in your application.
-
-Example:
-
-```tsx
-import "prismjs";
-import "prismjs/components/prism-javascript";
-import "prismjs/components/prism-typescript";
-import "prismjs/components/prism-css";
-// Import other languages as needed
-```
-
-## Develop
-
-To start developing Scribo, run the following commands:
-
-```bash
-pnpm install
-vite dev
-```
-
-## Release
-
-Quick release process:
-
-```bash
-# 1. Create changeset (choose one)
-pnpm changeset                 # Manual (recommended)
-pnpm changeset:suggest         # Auto-generate from commits
-
-# 2. Version package
-pnpm changeset:version
-
-# 3. Commit and push (create PR to main)
-git checkout -b release/scribo-v0.x.x
-git add .
-git commit -m "chore(scribo): release v0.x.x"
-git push origin release/scribo-v0.x.x
-
-# 4. Merge PR to main, then automated workflow will publish to npm and create GitHub release
-```
-
-For detailed release instructions, including setup and troubleshooting, see [RELEASE.md](./RELEASE.md).
-
-## Credits
-
-Scribo is built on the [Lexical framework](https://lexical.dev/), and most of the code in the repo is done by [Meta under MIT license](https://github.com/facebook/lexical).
-
-## Learn More
-
-- [Lexical](https://lexical.dev/)

package/RELEASE.md

@@ -1,102 +0,0 @@
-# Release Instructions for @eventuras/scribo
-
-This document explains how to configure the automated release workflow for `@eventuras/scribo`.
-
-## Release Process
-
-### Standard Release
-
-1. **Create changesets** for your changes:
-
-   ```bash
-   # Option A: Manual (recommended for better changelog messages)
-   pnpm changeset
-   
-   # Option B: Auto-generate from commits (review and edit after)
-   pnpm changeset:suggest
-   ```
-
-   > **Tip**: `changeset:suggest` analyzes your git commits since the last release and automatically generates changeset files. Review the generated changesets and edit them for clarity if needed.
-
-2. **Version the package** when ready:
-
-   ```bash
-   pnpm changeset:version
-   ```
-
-3. **Commit and push** the version bump:
-
-   ```bash
-   git add .
-   git commit -m "chore(scribo): release v0.x.x"
-   git push origin main
-   ```
-
-4. **Automated workflow** will:
-   - ✅ Build the package
-   - ✅ Publish to npm with provenance
-   - ✅ Create Git tag `@eventuras/scribo@x.x.x`
-   - ✅ Create GitHub Release with changelog
-
-### Manual Release
-
-If the automated workflow fails or you need to publish manually:
-
-```bash
-cd libs/scribo
-pnpm build
-npm login --scope @eventuras --auth-type web
-npm publish --access public
-```
-
-## Release Setup
-
-### NPM Trusted Publishing Setup (Recommended)
-
-Scribo uses **npm trusted publishing with OIDC** for secure, token-free publishing.
-
-#### Configure Trusted Publisher on npmjs.com
-
-1. Log in to [npmjs.com](https://www.npmjs.com)
-2. Navigate to `@eventuras/scribo` package settings
-3. Find **Trusted Publisher** section
-4. Click **GitHub Actions**
-5. Configure:
-   - **Organization or user**: `losol`
-   - **Repository**: `eventuras`
-   - **Workflow filename**: `scribo-release.yml` (include `.yml` extension)
-   - **Environment name**: `scribo-npm`
-6. Click **Add trusted publisher**
-
-#### Set Up GitHub Environment
-
-The workflow uses a GitHub environment for deployment protection (optional but recommended):
-
-1. Go to your GitHub repository
-2. Navigate to **Settings** → **Environments**
-3. Click **New environment**
-4. Name: `scribo-npm`
-5. (Optional) Add protection rules:
-   - Required reviewers if you want manual approval
-   - Deployment branches: Select "Selected branches" and add `main`
-6. Click **Create environment**
-
-> **Note**: With trusted publishing, you don't need to add any secrets to this environment. The workflow uses OIDC authentication automatically.
-
-### Legacy: Token-Based Publishing (Not Recommended)
-
-If you cannot use trusted publishing, you can fall back to traditional npm tokens:
-
-1. Create a granular access token on npmjs.com with write access to `@eventuras/scribo`
-2. Add it as `NODE_AUTH_TOKEN` secret in the `scribo-npm` environment
-3. Update the workflow to include `NODE_AUTH_TOKEN` environment variable in the publish step
-
-However, trusted publishing is strongly recommended for better security.
-
-
-## Workflow Trigger
-
-The release workflow (`.github/workflows/scribo-release.yml`) triggers automatically when:
-
-- Changes are pushed to the `main` branch
-- The file `libs/scribo/package.json` is modified

package/eslint.config.js

@@ -1,4 +0,0 @@
-/** @type {import("eslint").Linter.Config} */
-module.exports = {
-  extends: ['@eventuras/eslint-config/react-library.js'],
-};

package/src/App.css

@@ -1,35 +0,0 @@
-body {
-  margin: 0;
-  background: #eee;
-  font-family: Arial, Helvetica, sans-serif;
-}
-
-h1 {
-  text-align: center;
-  margin: 20px 0;
-}
-
-.editor-container {
-  display: flex;
-  flex-direction: column;
-}
-
-.markdown-output {
-  white-space: pre-wrap;
-  overflow: auto;
-}
-
-@media (min-width: 768px) {
-  .editor-container {
-    flex-direction: row;
-  }
-
-  .markdown-editor,
-  .markdown-output {
-    flex: 1;
-    margin: 10px;
-    padding: 20px;
-    border: 1px solid #ccc;
-    border-radius: 5px;
-  }
-}

package/src/App.tsx

@@ -1,42 +0,0 @@
-import { useState } from 'react'
-import MarkdownEditor from './MarkdownEditor'
-
-interface Props {
-  /** Initial markdown string */
-  initialMarkdown: string
-}
-
-/**
- * Wraps editor + rendered output
- * @see {@link Props}
- */
-export function App({ initialMarkdown }: Readonly<Props>) {
-  // State for current markdown
-  const [markdown, setMarkdown] = useState<string>(initialMarkdown)
-
-  // Handle editor changes
-  const onChange = (newMd: string) => setMarkdown(newMd)
-
-  return (
-    <div className="App">
-      <h1>Scribo Markdown editor</h1>
-
-      <div className="editor-container">
-        {/* Editor panel */}
-        <div className="markdown-editor">
-          <h2>Edit content</h2>
-          <MarkdownEditor
-            initialMarkdown={markdown}
-            onChange={onChange}
-          />
-        </div>
-
-        {/* Rendered output */}
-        <div className="markdown-output">
-          <h2>See the markdown output</h2>
-          <pre>{markdown}</pre>
-        </div>
-      </div>
-    </div>
-  )
-}

package/src/index.tsx

@@ -1,13 +0,0 @@
-import React from 'react'
-import ReactDOM from 'react-dom/client'
-import { App } from './App'
-import './App.css'
-import './MarkdownEditor.css'
-
-import readmeRaw from '../README.md?raw'
-
-ReactDOM.createRoot(document.getElementById('root')!).render(
-  <React.StrictMode>
-    <App initialMarkdown={readmeRaw} />
-  </React.StrictMode>,
-)

package/tsconfig.node.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "skipLibCheck": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "allowSyntheticDefaultImports": true,
-    "strict": true
-  },
-  "include": ["vite.config.ts"]
-}

package/vite.config.site.ts

@@ -1,19 +0,0 @@
-import { defineConfig } from 'vite';
-import react from '@vitejs/plugin-react';
-import { resolve } from 'path';
-
-/**
- * Vite configuration for building the demo site.
- * Used explicitly via: vite build --config vite.config.site.ts
- */
-export default defineConfig({
-  plugins: [react()],
-  build: {
-    outDir: 'dist/site',
-    rollupOptions: {
-      input: {
-        main: resolve(__dirname, 'index.html'),
-      },
-    },
-  },
-});

package/vite.config.ts

@@ -1,33 +0,0 @@
-import { defineReactLibConfig } from '@eventuras/vite-config/react-lib';
-
-/**
- * Vite configuration for building the Scribo library.
- * For the demo site, see vite.config.site.ts
- */
-export default defineReactLibConfig({
-  entry: 'src/main.tsx',
-  useSWC: false,
-  external: [
-    // Externalize all Lexical packages to avoid bundling them
-    'lexical',
-    '@lexical/code',
-    '@lexical/hashtag',
-    '@lexical/history',
-    '@lexical/link',
-    '@lexical/list',
-    '@lexical/markdown',
-    '@lexical/mark',
-    '@lexical/overflow',
-    '@lexical/react',
-    '@lexical/rich-text',
-    '@lexical/selection',
-    '@lexical/text',
-    '@lexical/utils',
-    // Also externalize any sub-exports from @lexical/react
-    /^@lexical\//,
-    // Externalize Prism.js to avoid bundling all language grammars
-    'prismjs',
-    /^prismjs\//,
-  ],
-});
-