diff --git a/README.ko.md b/README.ko.md index 1549744..9dacf9a 100644 --- a/README.ko.md +++ b/README.ko.md @@ -1,5 +1,11 @@ # editor-ruler +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler)](https://www.npmjs.com/package/@devslab/editor-ruler) [![CI](https://github.com/devslab-kr/editor-ruler/actions/workflows/ci.yml/badge.svg)](https://github.com/devslab-kr/editor-ruler/actions/workflows/ci.yml) ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-3178C6?logo=typescript&logoColor=white) diff --git a/README.md b/README.md index ad789be..91fa592 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # editor-ruler +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler)](https://www.npmjs.com/package/@devslab/editor-ruler) [![CI](https://github.com/devslab-kr/editor-ruler/actions/workflows/ci.yml/badge.svg)](https://github.com/devslab-kr/editor-ruler/actions/workflows/ci.yml) ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-3178C6?logo=typescript&logoColor=white) diff --git a/docs/assets/brand/oss-brand.json b/docs/assets/brand/oss-brand.json new file mode 100644 index 0000000..6289b55 --- /dev/null +++ b/docs/assets/brand/oss-brand.json @@ -0,0 +1,10 @@ +{ + "schemaVersion": 1, + "source": "https://github.com/devslab-kr/oss-brand/releases/tag/v0.1.1", + "release": "v0.1.1", + "guide": "https://devslab.kr/brand/open-source/", + "registryId": "O01", + "project": "editor-ruler", + "glyphConcept": "measured rail with a movable stop", + "relationship": "parent identity for editor adapters" +} diff --git a/docs/assets/brand/project-lockup.svg b/docs/assets/brand/project-lockup.svg new file mode 100644 index 0000000..74435c1 --- /dev/null +++ b/docs/assets/brand/project-lockup.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/brand/project-mark.svg b/docs/assets/brand/project-mark.svg new file mode 100644 index 0000000..200cac1 --- /dev/null +++ b/docs/assets/brand/project-mark.svg @@ -0,0 +1 @@ +editor-ruler \ No newline at end of file diff --git a/docs/assets/brand/readme-header.png b/docs/assets/brand/readme-header.png new file mode 100644 index 0000000..174dca7 Binary files /dev/null and b/docs/assets/brand/readme-header.png differ diff --git a/package.json b/package.json index 7a32bfa..6d98958 100644 --- a/package.json +++ b/package.json @@ -16,9 +16,10 @@ "build": "pnpm -r build", "test": "pnpm -r test", "typecheck": "pnpm -r typecheck", - "verify": "pnpm check:versions && pnpm build && pnpm typecheck && pnpm test", + "verify": "pnpm check:brand && pnpm check:versions && pnpm build && pnpm typecheck && pnpm test", "sync:versions": "node scripts/sync-versions.mjs", "check:versions": "node scripts/sync-versions.mjs --check", + "check:brand": "node scripts/check-brand-assets.mjs", "build:pages": "node scripts/build-pages.mjs", "changeset": "changeset" }, diff --git a/packages/editor-ruler-ckeditor5/README.ko.md b/packages/editor-ruler-ckeditor5/README.ko.md index 7c4288f..f2c5529 100644 --- a/packages/editor-ruler-ckeditor5/README.ko.md +++ b/packages/editor-ruler-ckeditor5/README.ko.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-ckeditor5 +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-ckeditor5)](https://www.npmjs.com/package/@devslab/editor-ruler-ckeditor5) **[문서 & 라이브 데모](https://devslab-kr.github.io/editor-ruler/)** · [English](README.md) diff --git a/packages/editor-ruler-ckeditor5/README.md b/packages/editor-ruler-ckeditor5/README.md index 27bc414..1fb78aa 100644 --- a/packages/editor-ruler-ckeditor5/README.md +++ b/packages/editor-ruler-ckeditor5/README.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-ckeditor5 +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-ckeditor5)](https://www.npmjs.com/package/@devslab/editor-ruler-ckeditor5) **[Docs & live demo](https://devslab-kr.github.io/editor-ruler/)** · [한국어](README.ko.md) diff --git a/packages/editor-ruler-froala/README.ko.md b/packages/editor-ruler-froala/README.ko.md index 4fe3b51..8d5109c 100644 --- a/packages/editor-ruler-froala/README.ko.md +++ b/packages/editor-ruler-froala/README.ko.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-froala +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-froala)](https://www.npmjs.com/package/@devslab/editor-ruler-froala) **[문서 & 라이브 데모](https://devslab-kr.github.io/editor-ruler/)** · [English](README.md) diff --git a/packages/editor-ruler-froala/README.md b/packages/editor-ruler-froala/README.md index 47e53bc..0742656 100644 --- a/packages/editor-ruler-froala/README.md +++ b/packages/editor-ruler-froala/README.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-froala +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-froala)](https://www.npmjs.com/package/@devslab/editor-ruler-froala) **[Docs & live demo](https://devslab-kr.github.io/editor-ruler/)** · [한국어](README.ko.md) diff --git a/packages/editor-ruler-summernote/README.ko.md b/packages/editor-ruler-summernote/README.ko.md index 5bced00..3a03cf2 100644 --- a/packages/editor-ruler-summernote/README.ko.md +++ b/packages/editor-ruler-summernote/README.ko.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-summernote +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-summernote)](https://www.npmjs.com/package/@devslab/editor-ruler-summernote) **[문서 & 라이브 데모](https://devslab-kr.github.io/editor-ruler/)** · [English](README.md) diff --git a/packages/editor-ruler-summernote/README.md b/packages/editor-ruler-summernote/README.md index 119ed74..2847e64 100644 --- a/packages/editor-ruler-summernote/README.md +++ b/packages/editor-ruler-summernote/README.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-summernote +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-summernote)](https://www.npmjs.com/package/@devslab/editor-ruler-summernote) **[Docs & live demo](https://devslab-kr.github.io/editor-ruler/)** · [한국어](README.ko.md) diff --git a/packages/editor-ruler-tiptap/README.ko.md b/packages/editor-ruler-tiptap/README.ko.md index 1523272..ef5e930 100644 --- a/packages/editor-ruler-tiptap/README.ko.md +++ b/packages/editor-ruler-tiptap/README.ko.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-tiptap +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-tiptap)](https://www.npmjs.com/package/@devslab/editor-ruler-tiptap) **[문서 & 라이브 데모](https://devslab-kr.github.io/editor-ruler/)** · [English](README.md) diff --git a/packages/editor-ruler-tiptap/README.md b/packages/editor-ruler-tiptap/README.md index e44e1df..c008816 100644 --- a/packages/editor-ruler-tiptap/README.md +++ b/packages/editor-ruler-tiptap/README.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler-tiptap +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler-tiptap)](https://www.npmjs.com/package/@devslab/editor-ruler-tiptap) **[Docs & live demo](https://devslab-kr.github.io/editor-ruler/)** · [한국어](README.ko.md) diff --git a/packages/editor-ruler/README.ko.md b/packages/editor-ruler/README.ko.md index 1d171b2..b2cc2bd 100644 --- a/packages/editor-ruler/README.ko.md +++ b/packages/editor-ruler/README.ko.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler +

+ editor-ruler — DevsLab 오픈소스 +

+ +**DevsLab 오픈소스** · [OSS 브랜드 가이드](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler)](https://www.npmjs.com/package/@devslab/editor-ruler) **[문서 & 라이브 데모](https://devslab-kr.github.io/editor-ruler/)** · [English](README.md) diff --git a/packages/editor-ruler/README.md b/packages/editor-ruler/README.md index 7155aa6..d3c2029 100644 --- a/packages/editor-ruler/README.md +++ b/packages/editor-ruler/README.md @@ -1,5 +1,11 @@ # @devslab/editor-ruler +

+ editor-ruler — Open source by DevsLab +

+ +**Open source by [DevsLab](https://devslab.kr/)** · [OSS brand guide](https://devslab.kr/brand/open-source/) · Registry O01 + [![npm](https://img.shields.io/npm/v/%40devslab%2Feditor-ruler)](https://www.npmjs.com/package/@devslab/editor-ruler) **[Docs & live demo](https://devslab-kr.github.io/editor-ruler/)** · [한국어](README.ko.md) diff --git a/scripts/check-brand-assets.mjs b/scripts/check-brand-assets.mjs new file mode 100644 index 0000000..9694d2c --- /dev/null +++ b/scripts/check-brand-assets.mjs @@ -0,0 +1,163 @@ +import { createHash } from 'node:crypto'; +import { access, readFile } from 'node:fs/promises'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); +const readmes = [ + 'README.md', + 'README.ko.md', + 'packages/editor-ruler/README.md', + 'packages/editor-ruler/README.ko.md', + 'packages/editor-ruler-froala/README.md', + 'packages/editor-ruler-froala/README.ko.md', + 'packages/editor-ruler-tiptap/README.md', + 'packages/editor-ruler-tiptap/README.ko.md', + 'packages/editor-ruler-ckeditor5/README.md', + 'packages/editor-ruler-ckeditor5/README.ko.md', + 'packages/editor-ruler-summernote/README.md', + 'packages/editor-ruler-summernote/README.ko.md', +]; + +const assets = { + 'docs/assets/brand/readme-header.png': '4b419a0cb464d95071cccb27717bcadb52bf459408765a8f9c8a025c2b9f6eba', + 'docs/assets/brand/project-mark.svg': 'eeb3d9429f8219263e3c0f7350cbf57600899e5fc43e6f1e2fb197613536fc00', + 'docs/assets/brand/project-lockup.svg': 'd420a6505a8952a382089ff549cd2643420cf8bdaa277cd3d3d244f72df88d9b', + 'site/favicon.svg': 'eeb3d9429f8219263e3c0f7350cbf57600899e5fc43e6f1e2fb197613536fc00', + 'site/favicon.ico': '3cdcb500a12f6508cf9c6b7523e50f462247bac39403d2920d76ba12bd96fc17', + 'site/apple-touch-icon.png': 'b5cd4f6bcbf19029e53f2482f2201bfc59fd9f1bbb3294b43be194f21ee43f31', + 'site/og.png': '31ee7408b3db5ba4c89d1c53d0728c520b1f6f2faca46a1b43fa4b425e08e0da', +}; + +const expectedSource = 'https://github.com/devslab-kr/oss-brand/releases/tag/v0.1.1'; +const expectedGuide = 'https://devslab.kr/brand/open-source/'; + +function fail(message) { + console.error(`Brand check failed: ${message}`); + process.exitCode = 1; +} + +async function sha256(relativePath) { + const data = await readFile(path.join(root, relativePath)); + return createHash('sha256').update(data).digest('hex'); +} + +try { + const packageJson = JSON.parse(await readFile(path.join(root, 'package.json'), 'utf8')); + const verify = packageJson.scripts?.verify ?? ''; + const checkBrand = packageJson.scripts?.['check:brand'] ?? ''; + if (!verify.includes('pnpm check:brand')) { + fail('package.json verify must run pnpm check:brand as a standard quality gate'); + } + if (!checkBrand.includes('scripts/check-brand-assets.mjs')) { + fail('package.json check:brand must run the brand checker directly'); + } + if (checkBrand.includes('pnpm verify') || checkBrand.includes('npm run verify')) { + fail('package.json check:brand must not recurse into verify'); + } +} catch { + fail('missing or invalid package.json verification contract'); +} + +const manifestPath = 'docs/assets/brand/oss-brand.json'; +try { + const manifest = JSON.parse(await readFile(path.join(root, manifestPath), 'utf8')); + if (manifest.registryId !== 'O01' || manifest.project !== 'editor-ruler') { + fail(`${manifestPath} must identify editor-ruler as O01`); + } + if (manifest.release !== 'v0.1.1' || manifest.source !== expectedSource || manifest.guide !== expectedGuide) { + fail(`${manifestPath} must pin oss-brand v0.1.1 and the canonical guide`); + } +} catch { + fail(`missing or invalid ${manifestPath}`); +} + +for (const [relativePath, expectedHash] of Object.entries(assets)) { + try { + await access(path.join(root, relativePath)); + const actualHash = await sha256(relativePath); + if (actualHash !== expectedHash) fail(`${relativePath} checksum does not match oss-brand v0.1.1`); + } catch { + fail(`missing ${relativePath}`); + } +} + +let html = ''; +try { + html = await readFile(path.join(root, 'site/index.html'), 'utf8'); + for (const marker of [ + 'data-i18n="brand.oss"', + expectedGuide, + 'data-atmosphere="project"', + 'hero-atmosphere__glow', + '@media (max-width: 260px)', + '.top-inner { flex-wrap: wrap; }', + 'og:image:alt', + ]) { + if (!html.includes(marker)) fail(`site/index.html is missing ${marker}`); + } +} catch { + fail('missing site/index.html'); +} + +if (!/\.tabs\s*\{[^}]*flex-wrap:\s*wrap;/.test(html)) { + fail('site/index.html must wrap demo tabs at narrow widths'); +} + +if (!html.includes('html, body { overflow-x: clip; }')) { + fail('site/index.html must clip off-canvas editor menus at 260px'); +} + +function mediaBlock(source, query) { + const start = source.indexOf(query); + if (start === -1) return ''; + const braceStart = source.indexOf('{', start); + if (braceStart === -1) return ''; + let depth = 0; + for (let index = braceStart; index < source.length; index += 1) { + if (source[index] === '{') depth += 1; + if (source[index] === '}') { + depth -= 1; + if (depth === 0) return source.slice(braceStart + 1, index); + } + } + return ''; +} + +const darkMode = mediaBlock(html, '@media (prefers-color-scheme: dark)'); +if (!darkMode) { + fail('site/index.html must provide a prefers-color-scheme: dark contract'); +} else { + for (const token of [ + '--bg: #0f1216', + '--ink: #f4f7fb', + '--muted: #b8c2d1', + '--line: #415064', + '--panel: #171d26', + '--accent: #8aacf8', + '--oss-accent: #22d3ee', + '--project-accent: #8aacf8', + '--action-accent: #1d4ed8', + '--demo-surface: #111821', + ]) { + if (!darkMode.includes(token)) fail(`site/index.html dark contract is missing ${token}`); + } + if (!darkMode.includes('rgb(34 211 238 / .10)')) { + fail('site/index.html dark hero glow must be capped at 10% alpha'); + } +} + +for (const relativePath of readmes) { + try { + const readme = await readFile(path.join(root, relativePath), 'utf8'); + if (!readme.includes(expectedGuide)) fail(`${relativePath} is missing the canonical OSS brand guide`); + if (!readme.includes('Open source by DevsLab') && !readme.includes('DevsLab 오픈소스')) { + fail(`${relativePath} is missing a DevsLab OSS endorsement`); + } + if (!readme.includes('readme-header.png')) fail(`${relativePath} is missing the O01 README header`); + } catch { + fail(`missing ${relativePath}`); + } +} + +if (!process.exitCode) console.log('Brand check passed: editor-ruler O01 assets and endorsements match oss-brand v0.1.1.'); diff --git a/site/apple-touch-icon.png b/site/apple-touch-icon.png index ed9b238..fc28078 100644 Binary files a/site/apple-touch-icon.png and b/site/apple-touch-icon.png differ diff --git a/site/favicon.ico b/site/favicon.ico index e7d580b..4b530a0 100644 Binary files a/site/favicon.ico and b/site/favicon.ico differ diff --git a/site/favicon.svg b/site/favicon.svg index 0254902..200cac1 100644 --- a/site/favicon.svg +++ b/site/favicon.svg @@ -1,12 +1 @@ - - - - - - - - - - +editor-ruler \ No newline at end of file diff --git a/site/index.html b/site/index.html index e58c00e..cba9c1e 100644 --- a/site/index.html +++ b/site/index.html @@ -4,6 +4,7 @@ editor-ruler — 웹 에디터를 위한 Word 스타일 줄자 + - + - + + +
- editor-ruler + + + editor-ruler + v__PACKAGE_VERSION__
-
-

웹 에디터에는 줄자가 없었습니다.
이제 어디에나 달 수 있습니다.

-

- Froala·TinyMCE·CKEditor 5·Quill — 어떤 범용 WYSIWYG 에디터도 Word처럼 여백과 - 들여쓰기를 끌어서 조절하는 줄자를 제공하지 않습니다. editor-ruler는 - 에디터에 종속되지 않는 코어와 얇은 어댑터로 그 공백을 채우는 오픈소스입니다. -

-
- 의존성 0 - TypeScript - cm · in · px - 가이드선 + 스냅 - 세로 줄자 - Froala · Tiptap · CKEditor 5 - Apache-2.0 -
-
- 라이브 데모 보기 - 시작하기 +
+ +
+

DevsLab 오픈소스 · OSS 브랜드 가이드 · Registry O01

+

웹 에디터에는 줄자가 없었습니다.
이제 어디에나 달 수 있습니다.

+

+ Froala·TinyMCE·CKEditor 5·Quill — 어떤 범용 WYSIWYG 에디터도 Word처럼 여백과 + 들여쓰기를 끌어서 조절하는 줄자를 제공하지 않습니다. editor-ruler는 + 에디터에 종속되지 않는 코어와 얇은 어댑터로 그 공백을 채우는 오픈소스입니다. +

+
+ 의존성 0 + TypeScript + cm · in · px + 가이드선 + 스냅 + 세로 줄자 + Froala · Tiptap · CKEditor 5 + Apache-2.0 +
+
+ 라이브 데모 보기 + 시작하기 +
+

+ 📄 왜 만들었나 — + Every web rich-text editor is missing a ruler + (영문) +

-

- 📄 왜 만들었나 — - Every web rich-text editor is missing a ruler - (영문) -

-
+
@@ -512,6 +591,7 @@

자주 묻는 것

// is the English overlay. A missing key falls back to the Korean, so an // incomplete translation degrades to readable rather than blank. const EN = { + 'brand.oss': 'Open source by DevsLab · OSS brand guide · Registry O01', 'hero.h1': 'Web editors never had a ruler.
Now any of them can.', 'hero.lead': 'Froala, TinyMCE, CKEditor 5, Quill — no general-purpose WYSIWYG editor gives you Word’s ruler for dragging margins and indents. editor-ruler is an open-source fix for that: an editor-agnostic core plus thin per-editor adapters.', diff --git a/site/og.png b/site/og.png index b4418a2..1c58e4f 100644 Binary files a/site/og.png and b/site/og.png differ