Files
jsonPrism/README.vi.md
T
poli0981andClaude Opus 4.8 8bbecd14bd docs(android): add System Requirements (WebView/Android/RAM/storage) (#95)
Add a "System requirements" table to the README Android section (EN + VI):
Android 12+ (API 31), Android System WebView Chromium 111+, supported ABIs,
RAM, storage, and offline/no-network note — with guidance to update WebView
if the UI looks broken. Refresh the now-stale Android testing note in
docs/pc_spec.md (EN + VI) to reflect emulator-based build + smoke testing.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-16 14:57:37 +07:00

13 KiB
Raw Permalink Blame History

JSONPrism

Tán sắc JSON ra nhiều định dạng.

Một JSON đầu vào. Đa định dạng đích. Chạy hoàn toàn trong trình duyệt.

CI Deploy License: Apache 2.0

Bản demo · English · Lộ trình


JSONPrism là công cụ "tán sắc" cho developer. Nhận một JSON đầu vào và phân tách ra nhiều định dạng đích — như ánh sáng trắng đi qua lăng kính. Mọi thứ chạy client-side, dữ liệu của bạn không bao giờ rời khỏi máy.

Định dạng hỗ trợ

Định dạng Phần mở rộng Trạng thái Đảo (→ JSON)
JSONL .jsonl ✅ Phase 1 ✅
CSV .csv ✅ Phase 1 ✅
TSV .tsv ✅ Phase 1 ✅
YAML .yaml ✅ Phase 1 ✅
XML .xml ✅ Phase 2 —
TOML .toml ✅ Phase 2 ✅
Bảng Markdown .md ✅ Phase 2 —
SQL INSERT .sql ✅ Phase 2 —
RESX (.NET) .resx ✅ Phase 3 ✅
BSON .bson ✅ Phase 4 —
CBOR .cbor ✅ Phase 4 —
MessagePack .msgpack ✅ Phase 4 —

Tính năng

  • Chạy hoàn toàn client-side — không server, không telemetry, không upload. JSON của bạn ở lại trong trình duyệt.
  • Khởi động nhanh — route và editor CodeMirror được lazy-load, mã vendor/parser tách thành nhiều chunk nhỏ theo tính năng, nên trình duyệt chỉ tải đúng phần bạn dùng.
  • Xử lý batch — tới 500 file cùng lúc (Phase 2).
  • Phát hiện shape thông minh — nhận diện flat object, mảng object, scalar; gợi ý format đích phù hợp.
  • Tuỳ chọn theo từng format — pretty-print, indentation, dialect (SQL), alignment (Markdown), v.v.
  • Theme sáng/tối — bảng màu Prism Spectrum với violet / cyan / amber / rose.
  • Responsive — tối ưu cho viewport ≥ 360 × 640. Màn hình nhỏ hơn vẫn dùng được nhưng có thể chật; trên mobile, Input và Output dùng Tabs UI để mỗi panel có toàn bộ chiều cao. Xem docs/tested-viewports.md cho ma trận thiết bị đã kiểm thử.
  • Đa ngôn ngữ EN + VI — sẵn sàng từ ngày đầu. Hoan nghênh thêm ngôn ngữ khác.
  • Bản desktop Tauri — drag-and-drop file, hoạt động offline (mốc Phase 2).

Tech stack

  • Vite 8 + React 19 + TypeScript 5.7
  • Tailwind CSS v4 + shadcn/ui (style New York, base neutral)
  • CodeMirror 6 cho editor đầu vào (Phase 1 polish)
  • PapaParse, js-yaml, smol-toml, fast-xml-parser để parse/serialize
  • i18next cho dịch thuật, Zustand cho state, Sonner cho toast
  • Tauri 2 wrapper (Phase 2)

Bắt đầu nhanh

Yêu cầu: Node.js 22 LTS trở lên.

git clone https://github.com/poli0981/jsonPrism.git
cd jsonprism
npm install
npm run dev          # http://localhost:5173

Bản desktop (Tauri 2)

JSONPrism cũng có bản desktop native qua Tauri 2. App dùng cùng React UI, với dialog OS native và drag-drop tích hợp vào batch flow hiện có.

Yêu cầu thêm:

  • Rust toolchain (rustup) với channel stable
  • Build deps theo platform:
    • Windows: Visual Studio Build Tools (workload C++) + WebView2 (cài sẵn trên Windows 11)
    • macOS: Xcode Command Line Tools (xcode-select --install)
    • Linux: libwebkit2gtk-4.1-dev, libappindicator3-dev, librsvg2-dev, patchelf, libssl-dev

Generate icon một lần (dùng Tauri CLI render SVG ra PNG/ICO/ICNS):

npm run tauri:icon

Chạy dev mode (Vite + Tauri window có hot reload):

npm run tauri:dev

Build bundle native:

npm run tauri:build

Output:

  • Windows → src-tauri/target/release/bundle/msi/*.msi + nsis/*-setup.exe
  • macOS → src-tauri/target/release/bundle/dmg/*.dmg + macos/*.app
  • Linux → src-tauri/target/release/bundle/appimage/*.AppImage + deb/*.deb

Release tự động: push tag v* sẽ trigger .github/workflows/release.yml, build cho tất cả platform song song và tạo draft GitHub release.

Bản Android (Tauri 2)

JSONPrism còn có bản Android để bạn sideload từ file .apk. Cùng React UI; chọn file qua dialog native. Yêu cầu Android 12 (API 31) trở lên — máy cũ hơn sẽ bị hệ điều hành chặn cài.

Yêu cầu hệ thống

Yêu cầu Chi tiết
Phiên bản Android 12 (API 31) trở lên — máy cũ hơn bị chặn ngay khi cài (INSTALL_FAILED_OLDER_SDK)
System WebView Chromium 111+ (Android System WebView / Chrome). Đa số máy được Play Store cập nhật sẵn; WebView quá cũ sẽ render giao diện sai — nếu UI bị vỡ, hãy cập nhật "Android System WebView" và Chrome trong Play Store.
CPU / ABI arm64-v8a, armeabi-v7a, x86 hoặc x86_64 — một file APK universal chạy được trên tất cả (máy hiện đại là arm64-v8a)
RAM Tối thiểu 2 GB; khuyến nghị 4 GB cho file lớn hoặc xử lý hàng loạt (tối đa 500 file)
Dung lượng ~27 MB để tải; nên có ~100 MB trống (cài đặt + file tạm khi làm việc)
Mạng Không cần — app chạy hoàn toàn offline, không gửi gì ra ngoài

Cài đặt (người dùng)

  1. Tải JSONPrism-<version>-android-universal.apk từ trang Releases.
  2. Mở file; Android sẽ hỏi cho phép "cài app không rõ nguồn" cho trình duyệt/trình quản lý file — bật lên rồi cài.
  3. Cần Android 12+. App chạy hoàn toàn offline.

Build (lập trình viên)

Yêu cầu thêm (ngoài Rust toolchain của bản desktop):

  • Android Studio với SDK Platform 31+, Build-Tools, Platform-Tools, Command-line Tools và một bản NDK
  • JDK — dùng JBR đi kèm Android Studio là được
  • Biến môi trường: JAVA_HOME, ANDROID_HOME, NDK_HOME (xem docs/TAURI-NOTES.md)
  • Rust Android targets: rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android

Project Gradle nằm ở src-tauri/gen/android/ và đã được commit. Bạn không cần chạy tauri android init cho build thường.

Chạy trên thiết bị/emulator (Android 12+):

npm run tauri:android:dev

Build APK release universal:

npm run tauri:android:build

Output: src-tauri/gen/android/app/build/outputs/apk/universal/release/app-universal-release.apk. Thông tin ký lấy từ src-tauri/gen/android/keystore.properties (gitignored); thiếu file này thì APK build ra chưa ký. Xem docs/TAURI-NOTES.md để biết cách tạo keystore và các secret ký trong CI.

Release tự động: cùng tag v* cũng chạy job android trong release.yml, ký APK bằng keystore từ repository secrets và đính vào draft release.

Các script

Script Chức năng
npm run dev Chạy Vite dev server với HMR
npm run build Build production vào dist/
npm run preview Xem trước bản build trên máy local
npm run lint Chạy ESLint
npm run lint:fix Chạy ESLint với autofix
npm run typecheck Type-check TypeScript, không emit
npm run format Format bằng Prettier
npm run format:check Kiểm tra format (CI dùng cái này)

Components shadcn/ui

components.json đã được cấu hình sẵn. Thêm component theo nhu cầu:

npx shadcn@latest add button input textarea tabs select card dialog sheet \
  dropdown-menu switch badge progress tooltip sonner resizable

Kiến trúc

src/
├── app/                 # Router + providers
├── components/
│   ├── ui/              # shadcn components (thêm theo nhu cầu)
│   ├── layout/          # Header, Footer, ThemeToggle
│   ├── converter/       # Workspace, panels, format picker
│   └── common/          # ErrorBoundary, LanguageSwitcher
├── converters/          # Một module cho mỗi định dạng đích
│   ├── types.ts         # Interface Converter
│   ├── registry.ts      # Bảng tra cứu
│   └── *.ts             # Cài đặt theo từng format
├── hooks/               # Custom hooks
├── i18n/                # Dịch thuật (en, vi)
├── lib/                 # detect, theme, utils, sample
├── pages/               # Home, About
├── styles/              # globals.css (Tailwind + theme tokens)
└── main.tsx

Thêm định dạng mới

Mỗi format là một module độc lập, cài đặt interface Converter:

import type { Converter } from './types';

interface MyFormatOptions {
  indent: 2 | 4;
}

export const myFormatConverter: Converter<MyFormatOptions> = {
  meta: {
    id: 'myformat',
    labelKey: 'formats.myformat',
    extension: 'myf',
    mimeType: 'application/x-myformat',
    phase: 1,
    ready: true,
  },
  defaultOptions: { indent: 2 },
  convert({ data }, options) {
    try {
      const output = serialize(data, options);
      return { ok: true, output };
    } catch (err) {
      return { ok: false, error: (err as Error).message };
    }
  },
};

Sau đó đăng ký nó trong src/converters/registry.ts và thêm label key vào src/i18n/locales/*.json.

Xem docs/ROADMAP.md để biết kế hoạch phase đầy đủ.

Đóng góp

Welcome pull request — vui lòng đọc CONTRIBUTING.md trước. PR thuộc nhóm auto-ignored (code đáng ngờ, lan man không vào vấn đề, không mô tả…) sẽ bị đóng không review.

Báo bug hoặc đề xuất tính năng tại GitHub Issues. Vấn đề bảo mật vui lòng dùng Security Advisory riêng tư.

Tài liệu project

Doc Nội dung
PRIVACY.md Offline-first, chỉ localStorage, không telemetry.
TERMS.md ToS / EULA — acceptable use, kế thừa giấy phép, quyền sở hữu dữ liệu.
SECURITY.md Cách report vulnerability, SLA.
DISCLAIMER.md Project 1 người + AI-assisted, không bảo hành.
THIRD-PARTY.md Mỗi dependency: version, giấy phép, link.
MAINTAINERS.md Ai chịu trách nhiệm gì.
CODE_OF_CONDUCT.md Contributor Covenant v2.1.
docs/ROADMAP.md Phase plan, trạng thái hiện tại.
docs/i18n/vi/pc_spec.md · docs/i18n/vi/dev_env.md Phần cứng + toolchain của maintainer.
docs/TAURI-NOTES.md Ghi chú Tauri build / process.
docs/RESX-MIGRATION.md Hướng dẫn i18next JSON → .NET RESX.

Cộng đồng

Trò chuyện, hỏi đáp, hoặc theo dõi cập nhật:

Ghi nhận

Phần lớn code, test, bản dịch và tài liệu của JSONPrism được draft với Claude Chat và Claude Code (Opus 4.7, 1M context). Xem DISCLAIMER.md để biết chi tiết về AI-assist. Chất lượng bản dịch ngôn ngữ ngoài tiếng Anh là best-effort — rất hoan nghênh đóng góp từ người bản ngữ.

Tài trợ

Nếu JSONPrism hữu ích cho bạn, hãy cân nhắc tài trợ maintainer qua một trong các kên trong .github/FUNDING.yml: GitHub Sponsors, Ko-fi, Buy Me a Coffee, Patreon hoặc PayPal.

Giấy phép

Apache License 2.0 — © 2026 Kokone (@poli0981).