sfcc-metadata-cli 0.0.1 → 1.0.0

package/.github/workflows/check.yml

@@ -0,0 +1,80 @@
+name: Check
+
+on:
+  push:
+  pull_request:
+  release:
+    types: [published]
+
+permissions:
+    id-token: write
+    contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    container: node:24-slim
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Biome check
+        run: npm run check
+
+  test:
+    runs-on: ubuntu-latest
+    container: node:${{ matrix.node-version }}-slim
+
+    strategy:
+      matrix:
+        node-version: [18, 20, 22, 24]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+  audit:
+    runs-on: ubuntu-latest
+    container: node:24-slim
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run npm audit
+        run: npm audit --audit-level=high
+
+  publish:
+    runs-on: ubuntu-latest
+    container: node:24-slim
+    needs: [check, test, audit]
+    if: github.event_name == 'release'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Checkout code
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish to npm
+        run: npm publish

package/AGENTS.md

@@ -0,0 +1,82 @@
+# Agent Instructions
+
+## Project Overview
+
+This is a CLI tool for creating SFCC (Salesforce Commerce Cloud) B2C migrations. It generates XML metadata files for custom objects, site preferences, and system object extensions.
+
+## Code Principles
+
+### DRY (Don't Repeat Yourself)
+
+- Extract shared logic into `lib/` utilities
+- Reuse XML generation functions from `lib/templates.js`
+- Shared constants (attribute types, system objects) should be defined once
+
+### KISS (Keep It Simple, Stupid)
+
+- Prefer simple, readable code over clever solutions
+- Each function should do one thing well
+- Avoid unnecessary abstractions
+- Use clear, descriptive variable and function names
+
+### YAGNI (You Aren't Gonna Need It)
+
+- Don't add features "just in case"
+- Implement only what's needed for the current requirement
+- Remove unused code rather than commenting it out
+
+### LoB (Locality of Behavior)
+
+- Keep related code close together
+- Command-specific logic stays in its command file
+- Avoid spreading a single behavior across multiple files
+- Prefer inline handlers over distant callbacks when reasonable
+
+### Functional Style
+
+- Prefer pure functions without side effects
+- Use `map`, `filter`, `reduce` over imperative loops
+- Avoid mutating function arguments
+- Return new objects/arrays instead of modifying existing ones
+- Keep I/O (file operations, console output) at the edges
+
+## Project Structure
+
+```
+├── index.js           # CLI entry point
+├── commands/          # Command handlers (one file per command)
+│   ├── create-migration.js
+│   ├── custom-object.js
+│   ├── site-preference.js
+│   └── system-object.js
+└── lib/               # Shared utilities
+    ├── merge.js       # XML merging logic
+    ├── templates.js   # XML generation templates
+    └── utils.js       # File system and naming utilities
+```
+
+## Coding Guidelines
+
+- Use `const` by default, `let` only when reassignment is needed
+- Use template literals for XML generation
+- Handle errors with try/catch and provide helpful messages
+- Use `chalk` for colored console output
+- Use `inquirer` for interactive prompts
+- Use `yargs` for CLI argument parsing
+
+## XML Generation
+
+- Always use the `METADATA_NAMESPACE` constant
+- Escape XML special characters with `escapeXml()`
+- Generate well-formatted, indented XML
+- Keep XML templates readable with multi-line template literals
+
+## Before Finishing
+
+Always run the linter before committing or finishing work:
+
+```bash
+npm run check
+```
+
+Ensure there are no errors. Use `npm run check:write` to auto-fix issues when possible.