@lsst/pik-plugin-select 0.5.3 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -45,6 +45,28 @@ pik select set <name> <option> # Set directly
45
45
  - `@pik:select <name>` - Defines a selector group
46
46
  - `@pik:option <name>` - Marks an option within a selector
47
47
 
48
+ ### Inline Style
49
+
50
+ Marker on the same line as content:
51
+
52
+ ```typescript
53
+ // @pik:select Environment
54
+ const API_URL = "https://dev.example.com"; // @pik:option DEV
55
+ // const API_URL = "https://example.com"; // @pik:option PROD
56
+ ```
57
+
58
+ ### Standalone Style
59
+
60
+ Marker on its own line, content on the next line (useful for HTML):
61
+
62
+ ```html
63
+ <!-- @pik:select Viewer -->
64
+ <!-- @pik:option Develop -->
65
+ <script src="https://dev.example.com/viewer.js"></script>
66
+ <!-- @pik:option Local -->
67
+ <!-- <script src="http://localhost:3000/viewer.js"></script> -->
68
+ ```
69
+
48
70
  ## Supported File Types
49
71
 
50
72
  | Extensions | Comment Style |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lsst/pik-plugin-select",
3
- "version": "0.5.3",
3
+ "version": "0.6.1",
4
4
  "description": "Config selector plugin for pik CLI",
5
5
  "type": "module",
6
6
  "license": "MIT",