android-pro-max-cli - npm Package Compare versions

Comparing version

1.0.0

1.0.1

+1

-1

package.json

		{
		"name": "android-pro-max-cli",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "CLI scaffold to install Android Pro Max skill for AI coding assistants",
		@@ -5,0 +5,0 @@ "type": "module",

+231

-4

README.md

		@@ -1,12 +0,239 @@
		# Android Pro Max CLI
		# ⚡ Android Pro Max

		CLI scaffold for installing Android Pro Max into AI assistant workspaces.
		Expert architectural intelligence for building robust, scalable, and modern Android applications.

		## Usage
		[![npm version](https://img.shields.io/npm/v/android-pro-max-cli.svg)](https://www.npmjs.com/package/android-pro-max-cli)
		[![Downloads](https://img.shields.io/npm/dm/android-pro-max-cli.svg)](https://www.npmjs.com/package/android-pro-max-cli)
		[![Android](https://img.shields.io/badge/Android-3DDC84?logo=android&logoColor=white)](https://developer.android.com)
		[![Kotlin](https://img.shields.io/badge/Kotlin-7F52FF?logo=kotlin&logoColor=white)](https://kotlinlang.org)
		[![Jetpack Compose](https://img.shields.io/badge/Jetpack_Compose-4285F4?logo=jetpackcompose&logoColor=white)](https://developer.android.com/jetpack/compose)
		[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
		[![Python 3.10+](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://www.python.org/)

		[Overview](#-overview) \| [Features](#-features) \| [Installation](#-installation) \| [Usage](#-usage) \| [Supported Assistants](#-supported-ai-assistants)

		---

		## 🌟 Overview

		Android Pro Max là một lớp AI Intelligence chuyên sâu dành cho phát triển Android hiện đại, tập trung vào Kotlin, Jetpack Compose, Clean Architecture, MVI/MVVM, Coroutines, Flow, Room, WorkManager, Hilt, KSP, Gradle, và tiêu chuẩn Play Store.

		Dù bạn đang xây dựng một ứng dụng Fintech phức tạp, một mạng xã hội quy mô lớn hay một SaaS Dashboard trên mobile, skill này đảm bảo AI partner của bạn sẽ đưa ra các khuyến nghị cấp độ chuyên gia dựa trên các tiêu chuẩn công nghiệp mới nhất và Google's Best Practices.

		---

		## 🧠 Architecture: Rules (Brain) + Skill (Hands)

		Android Pro Max tách biệt rõ ràng logic ra quyết định (Decision Logic) và công cụ thực thi (Execution Tools):

		\| Layer \| Vai trò \| Nội dung \|
		\|-------\|---------\|----------\|
		\| 🧠 Rules (Brain) \| System prompt, persona, constraints \| 19 modular rule files — định nghĩa cách suy nghĩ, giới hạn an toàn, luồng quyết định \|
		\| 🤲 Skill (Hands) \| Tools, search, data access \| Search commands, 18 domain data files, design system generator \|

		### 🧠 19 Modular Rules — Comprehensive Guidebook

		Hệ thống được thiết kế với 19 module rules chuyên biệt, bao quát toàn diện mọi khía cạnh từ Code Quality đến Product Release. Mỗi file tích hợp sẵn tính năng tự động kích hoạt thông qua format tương thích với hầu hết các AI Agent hiện đại.

		Tier 1: Foundation Rules (Bắt buộc)
		```
		├── 01_skill_usage # Bắt buộc: Tự động filter & áp dụng skill
		├── 02_code_quality # Tiêu chuẩn God files & logic leakage vào UI
		├── 03_interaction_flow # Luồng Tương tác "ABCR" (Audit-Block-Refactor-Explain)
		├── 04_app_consistency # Design tokens & UX consistency
		└── 05_error_handling # Result pattern & Sealed classes for errors
		```

		Tier 2: Code Quality Rules
		```
		├── 06_testing # JUnit, Mocking, Compose UI testing
		├── 07_performance # Recomposition, Memory, Coroutine dispatchers
		├── 08_security # CryptoDataStore, Permissions, Data Protection
		├── 09_state_management # MVI/MVVM, StateFlow/SharedFlow hierarchy
		└── 10_naming_conventions # Kotlin/Compose conventions, package structure
		```

		Tier 3: UX & Resilience Rules
		```
		├── 11_accessibility # Semantics labels, Touch targets 48dp, Font scaling
		├── 12_network_resiliency # Exponential Backoff, Offline caching
		├── 13_offline_first # Room caching, WorkManager background sync
		├── 14_ui_graceful_degradation # Shimmer effects, Error fallbacks
		└── 15_state_lifecycle # ViewModel survival, Config changes, SaveStateHandle
		```

		Tier 4: Play Store & Product Rules
		```
		├── 16_google_play_aso # ASO: Keywords, Description optimization
		├── 17_google_play_compliance # Privacy Policy, Data Safety, Content rating
		├── 18_google_play_visuals # Screenshots story, Feature graphics, Adaptive icons
		└── 19_architecture_decision_matrix # Greenfield vs Legacy migration strategies
		```

		> 📖 Reference: [Android Developers](https://developer.android.com)

		---

		## 🚀 Features

		Hệ thống kiến thức được xây dựng trên dữ liệu có cấu trúc bao quát hơn 18 domains:

		- 🎨 Intelligent Design System Generator: Tự động sinh complete design system (colors, typography, spacing, patterns) dựa trên app category với reasoning engine hỗ trợ Kotlin/Compose.
		- 🏗️ Architecture Excellence: Clean Architecture, Feature-First, Modularization, Repository Pattern, và Use-Case boundaries.
		- 📱 Premium UI/UX Patterns: 100+ design patterns có sẵn code snippets cho Glassmorphism, Material You, Modern SaaS, và eCommerce.
		- 📦 Smart Library Selection: Hướng dẫn sử dụng 100+ libraries phổ biến (Retrofit, Hilt, Room, Compose) với best practices và tránh over-engineering.
		- ⚡ Performance Optimization: Tối ưu Render (recomposition), Memory management, Coroutine dispatching, và App Startup.
		- ♿ Mobile Accessibility: Các patterns cho semantics, touch targets, contrast, focus management trên Android.
		- 🧠 UI Reasoning: 35+ app categories với decision rules cho style, color, typography phù hợp với người dùng Android.
		- 🛡️ Security & Integrity: Tiêu chuẩn bảo mật API, lưu trữ dữ liệu an toàn (EncryptedSharedPreferences/Room) và xử lý Integrity.
		- 📈 Data Visualization: Khuyến nghị chart types và library (MPAndroidChart vs Custom Compose) cho mobile dashboards.

		---

		## 📦 Installation

		### The Quick Way (Recommended)

		```bash
		npx android-pro-max-cli
		```

		### Global Installation

		```bash
		# Cài đặt global
		npm install -g android-pro-max-cli

		# Khởi tạo trong bất kỳ project nào
		android-pro-max init

		# Cài đặt cho AI assistant cụ thể
		android-pro-max init --ai claude
		android-pro-max init --ai cursor
		android-pro-max init --ai copilot
		```

		This folder mirrors the Flutter skill layout and can be expanded with the full installer flow later.
		### Other Commands

		```bash
		# Xem các phiên bản có sẵn
		android-pro-max versions

		# Cập nhật lên phiên bản mới nhất
		android-pro-max update
		```

		---

		## 🤖 Supported AI Assistants

		Triển khai Android Pro Max vào toàn diện workflow phát triển của bạn (16 platforms):

		\| Assistant \| Install Type \| Structure \| Rules File \|
		\|-----------\|--------------\|-----------\|------------\|
		\| Claude Code \| Full \| `.claude/skills/android-pro-max/` \| `CLAUDE.md` (append) \|
		\| Cursor \| Reference \| `.cursor/commands/` + `.shared/` \| `.cursor/rules/` \|
		\| Windsurf \| Reference \| `.windsurf/skills/` + `.shared/` \| `.windsurf/rules/` \|
		\| GitHub Copilot \| Reference \| `.github/prompts/` + `.shared/` \| `copilot-instructions.md` \|
		\| Gemini CLI \| Full \| `.gemini/skills/android-pro-max/` \| `.gemini/rules/` \|
		\| Continue \| Full \| `.continue/skills/android-pro-max/` \| `.continue/rules/` \|
		\| Trae \| Full \| `.trae/skills/android-pro-max/` \| `.trae/rules/` \|
		\| VS Code \| Full \| `.vscode/skills/android-pro-max/` \| `.vscode/rules/` \|
		\| Codex \| Full \| `.codex/skills/android-pro-max/` \| `.codex/rules/` \|
		\| OpenCode \| Full \| `.opencode/skills/android-pro-max/` \| `.opencode/rules/` \|
		\| CodeBuddy \| Full \| `.codebuddy/skills/android-pro-max/` \| `.codebuddy/rules/` \|
		\| Junie \| Full \| `.junie/skills/android-pro-max/` \| `.junie/rules/` \|
		\| Kiro \| Reference \| `.kiro/steering/` + `.shared/` \| `.kiro/rules/` \|
		\| Qoder \| Reference \| `.qoder/skills/` + `.shared/` \| `.qoder/rules/` \|
		\| Roo Code \| Reference \| `.roo/commands/` + `.shared/` \| `.roo/rules/` \|

		---

		## 🏗 Architecture

		```text
		src/android-pro-max/
		├── data/ # 18 domain-tagged CSV files
		├── scripts/ # Search engine, BM25, Design System Generator
		└── templates/
		├── base/ # Rules, Skill Content, Quick Reference
		└── platforms/ # 16 platform configuration JSONs
		```

		The search engine uses BM25 algorithm for keyword-heavy retrieval, ensuring matching is based on technical context rather than just exact string matches.

		---

		## 📊 Data Sources

		\| Domain \| Entries \| Description \|
		\|--------\|---------\|-------------\|
		\| `view` \| 65 \| Android UI components and Jetpack Compose guidance \|
		\| `package` \| 68 \| Kotlin/Android libraries and pairings \|
		\| `pattern` \| 82 \| Compose, MVVM, state, and UI patterns \|
		\| `architect` \| 20+ \| Clean Architecture and modular boundaries \|
		\| `performance` \| 21 \| Compose, coroutine, and runtime performance patterns \|
		\| `accessibility` \| 18 \| Semantics, touch targets, font scaling \|
		\| `ui-reasoning` \| 19 \| App category decisions and UI direction \|
		\| `color` \| 51 \| Color palette guidance \|
		\| `typography` \| 47 \| Font pairing guidance \|
		\| `style` \| 51 \| UI style recommendations \|
		\| `ux` \| 51 \| UX best practices \|
		\| `icon` \| 50 \| Material Icons and usage guidance \|
		\| `landing` \| 29 \| Onboarding and landing patterns \|
		\| `naming` \| 18 \| Kotlin and Android naming conventions \|
		\| `product` \| 56 \| Product-specific UI considerations \|
		\| `prompt` \| 33 \| Prompt templates for Android tasks \|
		\| `play-store` \| 10 \| ASO, listing, compliance, and visual guidance \|
		\| `chart` \| 22 \| Chart recommendations for mobile dashboards \|

		---

		## 🛠 Usage

		### Skill Mode (Auto-activate)

		Skill tự động kích hoạt khi bạn yêu cầu các task liên quan đến Android. Just chat naturally:

		```text
		Tạo màn hình Login với Kotlin, Clean Architecture, Hilt, ViewModel, StateFlow và Jetpack Compose
		```

		### Search Script (Advanced)

		```bash
		# Tìm kiếm widgets/components
		python3 scripts/search.py "bottom navigation bar" --domain view

		# Tìm kiếm patterns với code snippet
		python3 scripts/search.py "mvi effect flow" --domain pattern

		# Tìm kiếm thư viện
		python3 scripts/search.py "room database" --domain package

		# Generate Design System cho app cụ thể
		python3 scripts/search.py "fintech banking app" --design-system -p "VietBank"
		```

		---

		## 📐 Technical Standards


		---

		## 🛠 Usage

		### Skill Mode

		```
		Tạo màn hình login với Kotlin, Clean Architecture, Hilt, ViewModel, StateFlow, và Jetpack Compose
		```

		### Search Script

		```bash
		python3 src/android-pro-max/scripts/search.py "compose lazy list" --top 5
		python3 src/android-pro-max/scripts/search.py "navigation flow" --domain pattern --top 5
		python3 src/android-pro-max/scripts/search.py "play store listing" --domain play-store --top 5
		```

android-pro-max-cli - npm Package Compare versions

Improved metrics