new-repo-setup

Files (1)

• SKILL.md

SKILL.md (first lines)

# New Repo Setup

Standardize a newly created project repository with consistent tooling and configuration.

## Step 1 — Determine repo type

Before doing anything else, ask the user:

> Is this a **personal** project or a **Silvermine** (non-personal/team) project?

Branch based on their answer.

---

## Personal Project Setup

### 1. AIX configuration

Set up AI tooling configuration so the repo inherits shared rules, skills, and prompts.

1. Run `npx @a1st/aix install github:yokuze/aix-config#main`
2. Verify that `ai.json` was created and contains an `extends` referencing
   `github:yokuze/aix-config#main`
3. If an `ai.json` already exists, ensure the `extends` field is present rather than
   overwriting other configuration

### 2. Package.json — `dev` script

Ensure `package.json` has a `dev` script so `npm run dev` starts the development server.

- Inspect the project to determine the correct dev command. For example:
  - **Vite / React / Vue / Svelte**: `vite` or `vite dev`
  - **Next.js**: `next dev`
  - **Nuxt**: `nuxt dev`
  - **Astro**: `astro dev`
  - **Tauri**: `cargo tauri dev` or the appropriate tauri CLI command
  - **Plain TypeScript**: `tsc --watch` or `tsx watch src/index.ts`
- If unsure, ask the user what the dev command should be
- If a `dev` script already exists and looks correct, leave it alone

### 3. Linting and formatting — oxlint + oxfmt

Install and configure oxlint with oxfmt for linting and formatting.

#### Install dependencies

```bash
npm install --save-dev --save-exact oxlint @stylistic/eslint-plugin
```

#### Create `oxlint.json` in the project root

Use this base configuration and adapt the `overrides` section based on which frameworks
the project uses:

```json
{
   "$schema": "./node_modules/oxlint/configuration_schema.json",
   "jsPlugins": ["@stylistic/eslint-plugin"],
   "categories": {
      "correctness": "error",
      "perf": "error",
      "suspicious": "error"
   },
   "rules": {
      "curly": "error",
      "@stylistic/brace-style": ["error", "1tbs", { "allowSingleLine": false }],
      "@stylistic/indent": ["error", 3, { "VariableDeclarator": "first" }],
      "@stylistic/padding-line-between-statements": [
         "error",
         { "blankLine": "always", "prev": ["const", "let"], "next": "*" },
         { "blankLine": "any", "prev": ["const", "let"], "next": ["const", "let"] }
      ],
      "@stylistic/quotes": ["error", "single", { "avoidEscape": true }],
      "@stylistic/semi": ["error", "always"],
      "no-unused-vars": [
         "error",
         { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_", "caughtErrorsIgnorePattern": "^_" }
      ],
      "max-depth": ["warn", { "max": 4 }],
      "max-nested-callbacks": ["warn", { "max": 3 }],
      "max-lines-per-function": [
         "warn",
         { "max": 300, "skipBlankLines": true, "skipComments": true }
      ],
      "max-params": ["warn", { "max": 4 }]
   },
   "overrides": [],
   "ignorePatterns": [
      "**/dist/**",
      "**/node_modules/**",
      "**/*.js",
      "**/*.cjs",
      "**/*.mjs",
      "**/.aix/**"
   ]
}
```

#### Adapt overrides for the project

Inspect the project to determine which frameworks are in use, then add relevant overrides.
Common overrides:

- **Test files** (`**/*.test.ts`, `**/__tests__/**/*.ts`): Turn off `max-lines-per-function`
- **Astro files** (`**/*.astro`): Turn off `@stylistic/indent`, `@stylistic/semi`,
  `@stylistic/brace-style`, `@stylistic/padding-line-between-statements`, and
  `max-lines-per-function` (Astro's template syntax conflicts with these rules)
- **Vue SFCs** (`**/*.vue`): Consider turning off indent and brace-style rules if the
  template section conflicts
- **Config files** (`*.config.ts`, `*.config.js`): Consider turning off
  `max-lines-per-function` if configs are lengthy

#### Adapt ignorePatterns for the project

Add any project-specific build output directories or generated files to `ignorePatterns`.
Common additions:

- `**/.nuxt/**`, `**/.next/**`, `**/.astro/**` for framework build caches

From yokuze/aix-config, MIT.

More from yokuze/aix-config