mirror of
https://github.com/samiyev/puaros.git
synced 2025-12-27 23:06:54 +05:00
chore(guardian): rename package to @samiyev/guardian
Rename package from @puaros/guardian to @samiyev/guardian for npm publication. Update all references in documentation.
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
All notable changes to @puaros/guardian will be documented in this file.
|
All notable changes to @samiyev/guardian will be documented in this file.
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
**🎉 Initial Release of @puaros/guardian**
|
**🎉 Initial Release of @samiyev/guardian**
|
||||||
|
|
||||||
Code quality guardian for vibe coders and enterprise teams - your AI coding companion that keeps code clean while you move fast.
|
Code quality guardian for vibe coders and enterprise teams - your AI coding companion that keeps code clean while you move fast.
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
|
|||||||
- Size: ~58 KB compressed
|
- Size: ~58 KB compressed
|
||||||
- Unpacked: ~239 KB
|
- Unpacked: ~239 KB
|
||||||
- 172 files included
|
- 172 files included
|
||||||
- Public npm package (`@puaros/guardian`)
|
- Public npm package (`@samiyev/guardian`)
|
||||||
- CLI binary: `guardian`
|
- CLI binary: `guardian`
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
@@ -227,7 +227,7 @@ Before releasing a new version:
|
|||||||
**Links:**
|
**Links:**
|
||||||
- [Official Website](https://puaros.ailabs.uz)
|
- [Official Website](https://puaros.ailabs.uz)
|
||||||
- [GitHub Repository](https://github.com/samiyev/puaros)
|
- [GitHub Repository](https://github.com/samiyev/puaros)
|
||||||
- [npm Package](https://www.npmjs.com/package/@puaros/guardian)
|
- [npm Package](https://www.npmjs.com/package/@samiyev/guardian)
|
||||||
- [Documentation](https://github.com/samiyev/puaros/packages/guardian#readme)
|
- [Documentation](https://github.com/samiyev/puaros/packages/guardian#readme)
|
||||||
- [Roadmap](./ROADMAP.md)
|
- [Roadmap](./ROADMAP.md)
|
||||||
- [Issues](https://github.com/samiyev/puaros/issues)
|
- [Issues](https://github.com/samiyev/puaros/issues)
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
# @puaros/guardian 🛡️
|
# @samiyev/guardian 🛡️
|
||||||
|
|
||||||
**Your AI Coding Companion - Keep the Vibe, Ditch the Tech Debt**
|
**Your AI Coding Companion - Keep the Vibe, Ditch the Tech Debt**
|
||||||
|
|
||||||
Code quality guardian for vibe coders and enterprise teams - because AI writes fast, Guardian keeps it clean.
|
Code quality guardian for vibe coders and enterprise teams - because AI writes fast, Guardian keeps it clean.
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/@puaros/guardian)
|
[](https://www.npmjs.com/package/@samiyev/guardian)
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
> **Perfect for:**
|
> **Perfect for:**
|
||||||
@@ -70,7 +70,7 @@ Code quality guardian for vibe coders and enterprise teams - because AI writes f
|
|||||||
1. 🤖 Ask Claude/GPT: "Build me a user authentication service"
|
1. 🤖 Ask Claude/GPT: "Build me a user authentication service"
|
||||||
→ AI generates 200 lines in 10 seconds
|
→ AI generates 200 lines in 10 seconds
|
||||||
|
|
||||||
2. 🛡️ Run Guardian: npx @puaros/guardian check ./src
|
2. 🛡️ Run Guardian: npx @samiyev/guardian check ./src
|
||||||
→ Finds: hardcoded JWT secret, magic timeouts, circular deps
|
→ Finds: hardcoded JWT secret, magic timeouts, circular deps
|
||||||
|
|
||||||
3. 🔄 Feed Guardian's output back to AI: "Fix these 5 issues"
|
3. 🔄 Feed Guardian's output back to AI: "Fix these 5 issues"
|
||||||
@@ -196,7 +196,7 @@ Think of Guardian as a senior developer reviewing AI's pull requests:
|
|||||||
# GitHub Actions / GitLab CI / Jenkins
|
# GitHub Actions / GitLab CI / Jenkins
|
||||||
- name: Guardian Quality Gate
|
- name: Guardian Quality Gate
|
||||||
run: |
|
run: |
|
||||||
npm install -g @puaros/guardian
|
npm install -g @samiyev/guardian
|
||||||
guardian check ./src --format json > guardian-report.json
|
guardian check ./src --format json > guardian-report.json
|
||||||
|
|
||||||
# Fail build if critical violations found
|
# Fail build if critical violations found
|
||||||
@@ -226,7 +226,7 @@ Think of Guardian as a senior developer reviewing AI's pull requests:
|
|||||||
**Metrics Dashboard**
|
**Metrics Dashboard**
|
||||||
```typescript
|
```typescript
|
||||||
// Track quality metrics across sprints
|
// Track quality metrics across sprints
|
||||||
import { analyzeProject } from "@puaros/guardian"
|
import { analyzeProject } from "@samiyev/guardian"
|
||||||
|
|
||||||
const metrics = await analyzeProject({ projectPath: "./src" })
|
const metrics = await analyzeProject({ projectPath: "./src" })
|
||||||
|
|
||||||
@@ -264,11 +264,11 @@ await reportMetrics({
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @puaros/guardian
|
npm install @samiyev/guardian
|
||||||
# or
|
# or
|
||||||
pnpm add @puaros/guardian
|
pnpm add @samiyev/guardian
|
||||||
# or
|
# or
|
||||||
yarn add @puaros/guardian
|
yarn add @samiyev/guardian
|
||||||
```
|
```
|
||||||
|
|
||||||
## Quick Start for Vibe Coders
|
## Quick Start for Vibe Coders
|
||||||
@@ -277,7 +277,7 @@ yarn add @puaros/guardian
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Install globally for instant use
|
# 1. Install globally for instant use
|
||||||
npm install -g @puaros/guardian
|
npm install -g @samiyev/guardian
|
||||||
|
|
||||||
# 2. Run on your AI-generated code
|
# 2. Run on your AI-generated code
|
||||||
cd your-project
|
cd your-project
|
||||||
@@ -310,7 +310,7 @@ module.exports = {
|
|||||||
## API Quick Start
|
## API Quick Start
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { analyzeProject } from "@puaros/guardian"
|
import { analyzeProject } from "@samiyev/guardian"
|
||||||
|
|
||||||
const result = await analyzeProject({
|
const result = await analyzeProject({
|
||||||
projectPath: "./src",
|
projectPath: "./src",
|
||||||
@@ -334,23 +334,23 @@ Guardian can also be used as a command-line tool:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check your project
|
# Check your project
|
||||||
npx @puaros/guardian check ./src
|
npx @samiyev/guardian check ./src
|
||||||
|
|
||||||
# With custom excludes
|
# With custom excludes
|
||||||
npx @puaros/guardian check ./src --exclude node_modules dist build
|
npx @samiyev/guardian check ./src --exclude node_modules dist build
|
||||||
|
|
||||||
# Verbose output
|
# Verbose output
|
||||||
npx @puaros/guardian check ./src --verbose
|
npx @samiyev/guardian check ./src --verbose
|
||||||
|
|
||||||
# Skip specific checks
|
# Skip specific checks
|
||||||
npx @puaros/guardian check ./src --no-hardcode # Skip hardcode detection
|
npx @samiyev/guardian check ./src --no-hardcode # Skip hardcode detection
|
||||||
npx @puaros/guardian check ./src --no-architecture # Skip architecture checks
|
npx @samiyev/guardian check ./src --no-architecture # Skip architecture checks
|
||||||
|
|
||||||
# Show help
|
# Show help
|
||||||
npx @puaros/guardian --help
|
npx @samiyev/guardian --help
|
||||||
|
|
||||||
# Show version
|
# Show version
|
||||||
npx @puaros/guardian --version
|
npx @samiyev/guardian --version
|
||||||
```
|
```
|
||||||
|
|
||||||
**Example output:**
|
**Example output:**
|
||||||
@@ -630,7 +630,7 @@ const url = "http://localhost"
|
|||||||
### CI/CD Integration
|
### CI/CD Integration
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { analyzeProject } from "@puaros/guardian"
|
import { analyzeProject } from "@samiyev/guardian"
|
||||||
|
|
||||||
const result = await analyzeProject({ projectPath: "./src" })
|
const result = await analyzeProject({ projectPath: "./src" })
|
||||||
|
|
||||||
@@ -655,7 +655,7 @@ if (result.hardcodeViolations.length > 0) {
|
|||||||
### Custom Analyzer
|
### Custom Analyzer
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { HardcodeDetector } from "@puaros/guardian"
|
import { HardcodeDetector } from "@samiyev/guardian"
|
||||||
|
|
||||||
const detector = new HardcodeDetector()
|
const detector = new HardcodeDetector()
|
||||||
const code = `const timeout = 5000`
|
const code = `const timeout = 5000`
|
||||||
@@ -675,13 +675,13 @@ Use Guardian's output to guide your AI assistant:
|
|||||||
# (Ask Claude: "Create a REST API with user authentication")
|
# (Ask Claude: "Create a REST API with user authentication")
|
||||||
|
|
||||||
# 2. Run Guardian
|
# 2. Run Guardian
|
||||||
npx @puaros/guardian check ./src > guardian-report.txt
|
npx @samiyev/guardian check ./src > guardian-report.txt
|
||||||
|
|
||||||
# 3. Feed back to AI
|
# 3. Feed back to AI
|
||||||
# (Show Claude the report: "Fix these issues Guardian found")
|
# (Show Claude the report: "Fix these issues Guardian found")
|
||||||
|
|
||||||
# 4. Verify fixes
|
# 4. Verify fixes
|
||||||
npx @puaros/guardian check ./src
|
npx @samiyev/guardian check ./src
|
||||||
```
|
```
|
||||||
|
|
||||||
### Pattern 2: Pre-Commit Quality Gate
|
### Pattern 2: Pre-Commit Quality Gate
|
||||||
@@ -691,7 +691,7 @@ Catch issues before they hit your repo:
|
|||||||
```bash
|
```bash
|
||||||
# .husky/pre-commit
|
# .husky/pre-commit
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
npx @puaros/guardian check ./src
|
npx @samiyev/guardian check ./src
|
||||||
|
|
||||||
if [ $? -ne 0 ]; then
|
if [ $? -ne 0 ]; then
|
||||||
echo "❌ Guardian found issues. Fix them or commit with --no-verify"
|
echo "❌ Guardian found issues. Fix them or commit with --no-verify"
|
||||||
@@ -715,7 +715,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v3
|
- uses: actions/setup-node@v3
|
||||||
- run: npm install -g @puaros/guardian
|
- run: npm install -g @samiyev/guardian
|
||||||
- run: guardian check ./src
|
- run: guardian check ./src
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -730,7 +730,7 @@ Watch mode for real-time feedback as AI generates code:
|
|||||||
# Terminal 2: Guardian watches for changes
|
# Terminal 2: Guardian watches for changes
|
||||||
while true; do
|
while true; do
|
||||||
clear
|
clear
|
||||||
npx @puaros/guardian check ./src --no-exit
|
npx @samiyev/guardian check ./src --no-exit
|
||||||
sleep 2
|
sleep 2
|
||||||
done
|
done
|
||||||
```
|
```
|
||||||
@@ -763,7 +763,7 @@ import {
|
|||||||
FileScanner,
|
FileScanner,
|
||||||
CodeParser,
|
CodeParser,
|
||||||
HardcodeDetector,
|
HardcodeDetector,
|
||||||
} from "@puaros/guardian"
|
} from "@samiyev/guardian"
|
||||||
|
|
||||||
// Scan files
|
// Scan files
|
||||||
const scanner = new FileScanner()
|
const scanner = new FileScanner()
|
||||||
@@ -787,7 +787,7 @@ const violations = detector.detectAll(code, "file.ts")
|
|||||||
Guardian follows Clean Architecture principles:
|
Guardian follows Clean Architecture principles:
|
||||||
|
|
||||||
```
|
```
|
||||||
@puaros/guardian/
|
@samiyev/guardian/
|
||||||
├── domain/ # Business logic & interfaces
|
├── domain/ # Business logic & interfaces
|
||||||
│ ├── entities/ # BaseEntity, SourceFile
|
│ ├── entities/ # BaseEntity, SourceFile
|
||||||
│ ├── value-objects/# HardcodedValue, ProjectPath
|
│ ├── value-objects/# HardcodedValue, ProjectPath
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "@puaros/guardian",
|
"name": "@samiyev/guardian",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "Code quality guardian for vibe coders and enterprise teams - catch hardcodes, architecture violations, and circular deps. Enforce Clean Architecture at scale. Works with Claude, GPT, Copilot.",
|
"description": "Code quality guardian for vibe coders and enterprise teams - catch hardcodes, architecture violations, and circular deps. Enforce Clean Architecture at scale. Works with Claude, GPT, Copilot.",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
|||||||
Reference in New Issue
Block a user