# Sxzz

> Kevin Deng (@sxzz)'s opinionated tooling and conventions for TypeScript projects. Use when setting up new projects, configuring ESLint/Prettier, or when the user mentions sxzz's preferences.

- **Type:** Skill
- **Install:** `agentstack add skill-sxzz-skills-sxzz`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [sxzz](https://agentstack.voostack.com/s/sxzz)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [sxzz](https://github.com/sxzz)
- **Source:** https://github.com/sxzz/skills/tree/main/skills/sxzz

## Install

```sh
agentstack add skill-sxzz-skills-sxzz
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

## Coding Practices

### Code Organization

- **Single responsibility**: Each source file should have a clear, focused scope/purpose
- **Split large files**: Break files when they become large or handle too many concerns
- **Co-locate types**: Keep types and interfaces in the same file where they are used to preserve context
- **Co-locate constants**: Keep constants in the same file where they are used. Only extract to a dedicated file when shared across multiple files

### Runtime Environment

- **Prefer isomorphic code**: Write runtime-agnostic code that works in Node, browser, and workers whenever possible

### TypeScript

- **Explicit return types**: Declare return types explicitly when possible
- **Avoid complex inline types**: Extract complex types into dedicated `type` or `interface` declarations

### Comments

- **Avoid unnecessary comments**: Code should be self-explanatory
- **Explain "why" not "how"**: Comments should describe the reasoning or intent, not what the code does

### Testing (Vitest)

- Test files: `foo.ts` → `foo.test.ts` (same directory)
- Use `describe`/`it` API (not `test`)
- Use `toMatchSnapshot` for complex outputs
- Use `toMatchFileSnapshot` with explicit path for language-specific snapshots

---

## Tooling Choices

### @antfu/ni Commands

| Command                    | Description                                |
| -------------------------- | ------------------------------------------ |
| `ni`                       | Install dependencies                       |
| `ni ` / `ni -D ` | Add dependency / dev dependency            |
| `nr `              | Run script                                 |
| `nu`                       | Upgrade dependencies                       |
| `nun `                | Uninstall dependency                       |
| `nci`                      | Clean install (`pnpm i --frozen-lockfile`) |
| `nlx `                | Execute package (`npx`)                    |

### ESLint + Prettier Setup

ESLint with `@sxzz/eslint-config`:

```js
// eslint.config.js
// @ts-check
import { sxzz } from '@sxzz/eslint-config'

export default sxzz()
```

Prettier with `@sxzz/prettier-config`:

```json
{
  "prettier": "@sxzz/prettier-config"
}
```

### Pre-commit Checklist

Projects typically do **not** use git hooks or lint-staged. Before committing, always run these manually:

```bash
pnpm run lint --fix  # ESLint auto-fix
pnpm run format      # Prettier formatting
pnpm run typecheck   # Type checking (tsgo --noEmit)
```

### Standard Scripts

| Script           | Description                        |
| ---------------- | ---------------------------------- |
| `lint`           | ESLint check                       |
| `lint:fix`       | ESLint auto-fix                    |
| `format`         | Prettier formatting                |
| `test`           | Run tests (Vitest)                 |
| `typecheck`      | Type check (`tsgo --noEmit`)       |
| `release`        | Version bump and publish (`bumpp`) |
| `prepublishOnly` | Auto-build before publish          |

`build` and `dev` scripts vary by project — check `package.json` for the actual commands.

---

## References

| Topic               | Description                                         | Reference                                                |
| ------------------- | --------------------------------------------------- | -------------------------------------------------------- |
| Project Setup       | .gitignore, GitHub Actions workflows                | [setting-up](references/setting-up.md)                   |
| Library Development | tsdown bundling with tsdown-preset-sxzz, publishing | [library-development](references/library-development.md) |

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [sxzz](https://github.com/sxzz)
- **Source:** [sxzz/skills](https://github.com/sxzz/skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-sxzz-skills-sxzz
- Seller: https://agentstack.voostack.com/s/sxzz
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.