npm - @nanawan/rattail - Versions diffs - 2.0.9 - Mend

@nanawan/rattail 2.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2024 puijs
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,52 @@
+<div align="center">
+  <a href="https://rattail.puijs.org">
+    <img src="https://rattail.puijs.org/logo.svg" width="150">
+  </a>
+  <h1>Rattail</h1>
+  <p>A Vite+ oriented, AI Agent friendly front-end toolchain</p>
+  <p>
+    <a href="https://rattail.puijs.org">Documentation</a> |
+    <a href="https://github.com/puijs/rattail/blob/main/README.zh-CN.md">中文介绍</a>
+  </p>
+  <p>
+    <img src="https://img.shields.io/npm/v/rattail?style=flat-square" alt="version">
+    <img src="https://img.shields.io/github/stars/puijs/rattail" alt="stars">
+    <img src="https://img.shields.io/npm/l/rattail.svg" alt="license">
+    <img src="https://img.shields.io/codecov/c/github/puijs/rattail" alt="coverage">
+  </p>
+</div>
+---
+### Features
+- ⚙️ &nbsp; Out-of-the-box [Vite+](https://viteplus.dev) presets covering linting, formatting, staged linting, git hooks, and more.
+- 🔧 &nbsp; CLI toolkit for release, changelog, git hooks, commit lint, and API codegen.
+- 🧰 &nbsp; 140+ utility functions for general, string, number, array, object, math, and more.
+- 🚀 &nbsp; Progressive HTTP client based on axios, with Vue Composition API support.
+- 📏 &nbsp; Chainable validation rule factory that adapts to any UI framework.
+- 🏷️ &nbsp; Type-safe enum utility.
+- 🤖 &nbsp; Provides [Agent Skills](https://github.com/puijs/rattail/tree/main/skills) for AI coding assistants to understand and use Rattail.
+- 🌲 &nbsp; Tree-shakable, lightweight, and fully typed with TypeScript.
+- 💪 &nbsp; 90%+ unit test coverage.
+- 📄 &nbsp; MIT licensed.
+### Installation
+```shell
+# npm
+npm i rattail -S
+# yarn
+yarn add rattail
+# pnpm
+pnpm add rattail
+```
+### Official Docs
+- [Documentation Home](https://rattail.puijs.org)
+- [Getting Started](https://rattail.puijs.org/getting-started)
+- [Why Rattail](https://rattail.puijs.org/why-rattail)
+- [Vite+ Presets / CLI Getting Started](https://rattail.puijs.org/cli/getting-started)
+- [Axle Getting Started](https://rattail.puijs.org/axle/getting-started)
+- [Ruler Factory](https://rattail.puijs.org/ruler/ruler-factory)

package/README.zh-CN.md ADDED Viewed

@@ -0,0 +1,52 @@
+<div align="center">
+  <a href="https://rattail.puijs.org/zh">
+    <img src="https://rattail.puijs.org/logo.svg" width="150">
+  </a>
+  <h1>Rattail</h1>
+  <p>面向 Vite+、AI Agent 友好的前端工具链</p>
+  <p>
+    <a href="https://rattail.puijs.org/zh">文档</a> |
+    <a href="https://github.com/puijs/rattail/blob/main/README.md">ENGLISH README</a>
+  </p>
+  <p>
+    <img src="https://img.shields.io/npm/v/rattail?style=flat-square" alt="version">
+    <img src="https://img.shields.io/github/stars/puijs/rattail" alt="stars">
+    <img src="https://img.shields.io/npm/l/rattail.svg" alt="license">
+    <img src="https://img.shields.io/codecov/c/github/puijs/rattail" alt="coverage">
+  </p>
+</div>
+---
+### 特性
+- ⚙️ &nbsp; 面向 [Vite+](https://viteplus.dev) 的开箱即用配置预设，覆盖代码检查、格式化、暂存区检查和 Git Hooks 等。
+- 🔧 &nbsp; CLI 工具链，支持发布、日志、Git Hooks、Commit Lint、API 生成。
+- 🧰 &nbsp; 140+ 工具函数，覆盖通用、字符串、数字、数组、对象、数学等场景。
+- 🚀 &nbsp; 基于 axios 的渐进式请求工具，支持 Vue 组合式 API。
+- 📏 &nbsp; 链式校验规则工厂，适配任意 UI 框架。
+- 🏷️ &nbsp; 类型安全的枚举工具。
+- 🤖 &nbsp; 提供 [Agent Skills](https://github.com/puijs/rattail/tree/main/skills)，帮助 AI 编程助手理解和使用 Rattail。
+- 🌲 &nbsp; 可 Tree-shake，轻量，TypeScript 完整类型支持。
+- 💪 &nbsp; 90%+ 单元测试覆盖率。
+- 📄 &nbsp; MIT 开源协议。
+### 安装
+```shell
+# npm
+npm i rattail -S
+# yarn
+yarn add rattail
+# pnpm
+pnpm add rattail
+```
+### 官方文档
+- [文档首页](https://rattail.puijs.org/zh)
+- [快速开始](https://rattail.puijs.org/zh/getting-started)
+- [为什么选择 Rattail](https://rattail.puijs.org/zh/why-rattail)
+- [Vite+ 预设 / CLI 快速开始](https://rattail.puijs.org/zh/cli/getting-started)
+- [Axle 快速开始](https://rattail.puijs.org/zh/axle/getting-started)
+- [Ruler Factory](https://rattail.puijs.org/zh/ruler/ruler-factory)

package/package.json ADDED Viewed

@@ -0,0 +1,152 @@
+{
+  "name": "@nanawan/rattail",
+  "version": "2.0.9",
+  "description": "A Vite+ oriented, AI Agent friendly front-end toolchain",
+  "keywords": [
+    "ai-agent",
+    "cli",
+    "presets",
+    "toolchain",
+    "typescript",
+    "utilities",
+    "vite-plus"
+  ],
+  "bugs": {
+    "url": "https://github.com/puijs/rattail/issues"
+  },
+  "license": "MIT",
+  "author": "haoziqaq <357229046@qq.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/puijs/rattail.git"
+  },
+  "bin": {
+    "rt": "dist/cli/bin.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "typesVersions": {
+    "*": {
+      "vite-plus": [
+        "dist/vite-plus/index.d.mts"
+      ],
+      "axle": [
+        "dist/axle/index.d.mts"
+      ],
+      "axle/use": [
+        "dist/axle/use.d.mts"
+      ],
+      "axle/api": [
+        "dist/axle/api.d.mts"
+      ],
+      "ruler": [
+        "dist/ruler-factory/index.d.mts"
+      ],
+      "ruler-factory": [
+        "dist/ruler-factory/index.d.mts"
+      ],
+      "cli": [
+        "dist/cli/index.d.mts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./vite-plus": {
+      "types": "./dist/vite-plus/index.d.mts",
+      "import": "./dist/vite-plus/index.mjs"
+    },
+    "./axle": {
+      "types": "./dist/axle/index.d.mts",
+      "import": "./dist/axle/index.mjs"
+    },
+    "./axle/use": {
+      "types": "./dist/axle/use.d.mts",
+      "import": "./dist/axle/use.mjs"
+    },
+    "./axle/api": {
+      "types": "./dist/axle/api.d.mts",
+      "import": "./dist/axle/api.mjs"
+    },
+    "./ruler": {
+      "types": "./dist/ruler-factory/index.d.mts",
+      "import": "./dist/ruler-factory/index.mjs"
+    },
+    "./ruler-factory": {
+      "types": "./dist/ruler-factory/index.d.mts",
+      "import": "./dist/ruler-factory/index.mjs"
+    },
+    "./cli": {
+      "types": "./dist/cli/index.d.mts",
+      "import": "./dist/cli/index.mjs"
+    }
+  },
+  "scripts": {
+    "dev": "vp pack --watch",
+    "build": "vp pack",
+    "clean": "tsx src/cli/bin.ts clean",
+    "docs:build": "vitepress build docs",
+    "docs:dev": "vitepress dev docs",
+    "docs:preview": "vitepress preview docs",
+    "format": "vp fmt",
+    "lint": "vp lint --fix",
+    "release": "pnpm build && tsx src/cli/bin.ts release",
+    "test:watch": "vp test watch",
+    "test": "vp test run --coverage"
+  },
+  "dependencies": {
+    "@configurajs/vite-plus": "0.2.6",
+    "@nanawan/axle": "1.0.2",
+    "@nanawan/release": "^2.2.1",
+    "api-farmer": "0.1.5",
+    "commander": "^13.0.0",
+    "js-cookie": "3.0.5",
+    "mitt": "3.0.1",
+    "rimraf": "^6.0.1",
+    "ruler-factory": "0.0.14",
+    "unconfig": "^7.5.0",
+    "uuid": "13.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.8.1",
+    "@vitest/coverage-istanbul": "^4.1.0",
+    "jsdom": "^25.0.1",
+    "oxc-minify": "^0.124.0",
+    "tsx": "^4.21.0",
+    "typescript": "5.3.3",
+    "vite-plus": "0.1.19",
+    "vitepress": "2.0.0-alpha.17",
+    "vitest": "$vitest"
+  },
+  "peerDependencies": {
+    "@voidzero-dev/vite-plus-core": ">=0.1.16",
+    "vite-plus": ">=0.1.16"
+  },
+  "peerDependenciesMeta": {
+    "@voidzero-dev/vite-plus-core": {
+      "optional": true
+    },
+    "vite-plus": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "pnpm": ">=10.0.0"
+  },
+  "packageManager": "pnpm@10.0.0",
+  "pnpm": {
+    "overrides": {
+      "vite": "npm:@voidzero-dev/vite-plus-core@0.1.19",
+      "vitest": "npm:@voidzero-dev/vite-plus-test@0.1.19"
+    }
+  }
+}