@lsst/pik-plugin-select 0.4.2 → 0.5.1

package/README.md

@@ -1,11 +1,58 @@
-# plugin-select
+# @lsst/pik-plugin-select
 
-This library was generated with [Nx](https://nx.dev).
+Select plugin for pik - switch config options in source files using `@pik` markers.
 
-## Building
+## Installation
 
-Run `nx build plugin-select` to build the library.
+This plugin is included with `@lsst/pik` by default.
 
-## Running unit tests
+```bash
+npm install -g @lsst/pik
+```
 
-Run `nx test plugin-select` to execute the unit tests via [Vitest](https://vitest.dev/).
+## Usage
+
+### 1. Add markers to your files
+
+```typescript
+// @pik:select Environment
+const API_URL = "https://dev.example.com"; // @pik:option DEV
+// const API_URL = "https://example.com"; // @pik:option PROD
+```
+
+### 2. Configure in `pik.config.ts`
+
+```typescript
+import { defineConfig } from '@lsst/pik';
+
+export default defineConfig({
+  select: {
+    include: ['src/**/*.ts', '.env'],
+  },
+});
+```
+
+### 3. Run commands
+
+```bash
+pik select              # Interactive mode
+pik select list         # List all selectors
+pik select set <name> <option>  # Set directly
+```
+
+## Marker Syntax
+
+- `@pik:select <name>` - Defines a selector group
+- `@pik:option <name>` - Marks an option within a selector
+
+## Supported File Types
+
+| Extensions | Comment Style |
+|------------|---------------|
+| `.ts`, `.js`, `.tsx`, `.jsx`, `.mts`, `.mjs` | `//` |
+| `.html`, `.htm` | `<!-- -->` |
+| `.sh`, `.bash`, `.zsh`, `.py`, `.yaml`, `.yml`, `.env` | `#` |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lsst/pik-plugin-select",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "description": "Config selector plugin for pik CLI",
   "type": "module",
   "license": "MIT",