@lsst/pik-core 0.6.5 → 0.6.7

package/README.md

@@ -22,11 +22,11 @@ const env = 'LOCAL';     // @pik:option LOCAL
 `;
 
 // Parse content
-const parser = Parser.forExtension('ts');
+const parser = Parser.forFilePath('config.ts');
 const { selectors } = parser.parse(content);
 
 // Switch option
-const switcher = SingleSwitcher.forExtension('ts');
+const switcher = SingleSwitcher.forFilePath('config.ts');
 const newContent = switcher.switch(content, selectors[0], 'DEV');
 ```
 
@@ -84,8 +84,8 @@ export function myPlugin(config: MyPluginConfig): PikPlugin {
 ### Parser
 
 ```typescript
-// Create parser for file extension
-const parser = Parser.forExtension('ts');
+// Create parser for file path
+const parser = Parser.forFilePath('src/config.ts');
 
 // Parse content
 const result = parser.parse(content);
@@ -96,8 +96,8 @@ const result = parser.parse(content);
 ### SingleSwitcher
 
 ```typescript
-// Create switcher for file extension
-const switcher = SingleSwitcher.forExtension('ts');
+// Create switcher for file path
+const switcher = SingleSwitcher.forFilePath('src/config.ts');
 
 // Switch to option (deactivates all others)
 const newContent = switcher.switch(content, selector, 'optionName');
@@ -108,8 +108,8 @@ const newContent = switcher.switch(content, selector, 'optionName');
 ```typescript
 import { CommentStyle } from '@lsst/pik-core';
 
-// Get comment style for extension
-const style = CommentStyle.fromExtension('py'); // { lineComment: '#' }
+// Get comment style for file path
+const style = CommentStyle.fromFilePath('script.py'); // { lineComment: '#' }
 
 // Register custom style
 CommentStyle.register('custom', new CommentStyle(';;'));

package/dist/index.js

@@ -40,11 +40,21 @@ class CommentStyle {
     return !!(this.blockOpen && this.blockClose);
   }
   /**
-   * Get comment style for a file extension
+   * Get comment style for a file path.
+   *
+   * Handles dotfiles like `.env`, `.env.local`, `.env.development` correctly.
    */
-  static fromExtension(extension) {
-    const ext = extension.replace(/^\./, "").toLowerCase();
-    return CommentStyle.styles[ext] ?? CommentStyle.defaultStyle;
+  static fromFilePath(filePath) {
+    const basename = filePath.split(/[/\\]/).pop() ?? "";
+    if (basename === ".env" || basename.startsWith(".env.")) {
+      return CommentStyle.styles["env"] ?? CommentStyle.defaultStyle;
+    }
+    const lastDot = basename.lastIndexOf(".");
+    if (lastDot > 0) {
+      const ext = basename.slice(lastDot + 1).toLowerCase();
+      return CommentStyle.styles[ext] ?? CommentStyle.defaultStyle;
+    }
+    return CommentStyle.defaultStyle;
   }
   /**
    * Register a custom comment style for an extension
@@ -88,10 +98,10 @@ class Parser {
   static SELECT_REGEX = /@pik:select\s+(\S+)/;
   static OPTION_REGEX = /@pik:option\s+(\S+)/;
   /**
-   * Create a parser for a specific file extension
+   * Create a parser for a file path
    */
-  static forExtension(extension) {
-    return new Parser(CommentStyle.fromExtension(extension));
+  static forFilePath(filePath) {
+    return new Parser(CommentStyle.fromFilePath(filePath));
   }
   /**
    * Parse content string for pik selectors and options
@@ -213,6 +223,13 @@ class CommentManipulator {
     const { blockOpen, blockClose } = this.commentStyle;
     return trimmed.startsWith(blockOpen) && trimmed.includes(blockClose);
   }
+  /**
+   * Check if a line is a line comment (not a block comment)
+   */
+  isLineComment(line) {
+    const trimmed = line.trimStart();
+    return trimmed.startsWith(this.commentStyle.lineComment);
+  }
   /**
    * Comment out a line if not already commented.
    * Uses the same comment style as the original if block-commented,
@@ -234,30 +251,48 @@ class CommentManipulator {
     return `${indent}${this.commentStyle.lineComment} ${trimmed}`;
   }
   /**
-   * Uncomment a line if commented (handles both line and block comments)
+   * Uncomment a block comment
+   * @throws Error if the line is not a block comment
    */
-  uncommentLine(line) {
+  uncommentBlockComment(line) {
+    if (!this.isBlockCommented(line)) {
+      throw new Error("Expected line to be a block comment");
+    }
     const trimmed = line.trimStart();
     const indent = line.slice(0, line.length - trimmed.length);
-    if (this.commentStyle.hasBlockComments) {
-      const { blockOpen, blockClose } = this.commentStyle;
-      if (trimmed.startsWith(blockOpen)) {
-        const afterOpen = trimmed.slice(blockOpen.length);
-        const closeIndex = afterOpen.indexOf(blockClose);
-        if (closeIndex !== -1) {
-          const content2 = afterOpen.slice(0, closeIndex).trim();
-          const rest = afterOpen.slice(closeIndex + blockClose.length);
-          return `${indent}${content2}${rest}`;
-        }
-      }
-    }
-    if (!trimmed.startsWith(this.commentStyle.lineComment)) {
-      return line;
+    const { blockOpen, blockClose } = this.commentStyle;
+    const afterOpen = trimmed.slice(blockOpen.length);
+    const closeIndex = afterOpen.indexOf(blockClose);
+    const content = afterOpen.slice(0, closeIndex).trim();
+    const rest = afterOpen.slice(closeIndex + blockClose.length);
+    return `${indent}${content}${rest}`;
+  }
+  /**
+   * Uncomment a line comment
+   * @throws Error if the line is not a line comment
+   */
+  uncommentLineComment(line) {
+    if (!this.isLineComment(line)) {
+      throw new Error("Expected line to be a line comment");
     }
+    const trimmed = line.trimStart();
+    const indent = line.slice(0, line.length - trimmed.length);
     const withoutComment = trimmed.slice(this.commentStyle.lineComment.length);
     const content = withoutComment.startsWith(" ") ? withoutComment.slice(1) : withoutComment;
     return `${indent}${content}`;
   }
+  /**
+   * Uncomment a line if commented (handles both line and block comments)
+   */
+  uncommentLine(line) {
+    if (this.isBlockCommented(line)) {
+      return this.uncommentBlockComment(line);
+    }
+    if (this.isLineComment(line)) {
+      return this.uncommentLineComment(line);
+    }
+    return line;
+  }
 }
 class Switcher extends CommentManipulator {
   /**
@@ -274,10 +309,10 @@ class Switcher extends CommentManipulator {
 }
 class SingleSwitcher extends Switcher {
   /**
-   * Create a switcher for a specific file extension
+   * Create a switcher for a file path
    */
-  static forExtension(extension) {
-    return new SingleSwitcher(CommentStyle.fromExtension(extension));
+  static forFilePath(filePath) {
+    return new SingleSwitcher(CommentStyle.fromFilePath(filePath));
   }
   /**
    * Switch to a specific option, deactivating all others

package/dist/lib/comment-manipulator.d.ts

@@ -13,12 +13,26 @@ export declare abstract class CommentManipulator {
      * Check if a line uses block comment style
      */
     protected isBlockCommented(line: string): boolean;
+    /**
+     * Check if a line is a line comment (not a block comment)
+     */
+    private isLineComment;
     /**
      * Comment out a line if not already commented.
      * Uses the same comment style as the original if block-commented,
      * otherwise uses line comment style.
      */
     protected commentLine(line: string, useBlockStyle?: boolean): string;
+    /**
+     * Uncomment a block comment
+     * @throws Error if the line is not a block comment
+     */
+    private uncommentBlockComment;
+    /**
+     * Uncomment a line comment
+     * @throws Error if the line is not a line comment
+     */
+    private uncommentLineComment;
     /**
      * Uncomment a line if commented (handles both line and block comments)
      */

package/dist/lib/comment-manipulator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"comment-manipulator.d.ts","sourceRoot":"","sources":["../../src/lib/comment-manipulator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,8BAAsB,kBAAkB;IAC1B,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY;gBAA1B,YAAY,EAAE,YAAY;IAEzD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAmBhD;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAUjD;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,MAAM;IAwBlE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAkC9C"}
+{"version":3,"file":"comment-manipulator.d.ts","sourceRoot":"","sources":["../../src/lib/comment-manipulator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,8BAAsB,kBAAkB;IAC1B,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY;gBAA1B,YAAY,EAAE,YAAY;IAEzD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAmBhD;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAUjD;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,MAAM;IAwBlE;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAiB5B;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAa9C"}

package/dist/lib/parser.d.ts

@@ -9,9 +9,9 @@ export declare class Parser {
     private static readonly OPTION_REGEX;
     constructor(commentStyle: CommentStyle);
     /**
-     * Create a parser for a specific file extension
+     * Create a parser for a file path
      */
-    static forExtension(extension: string): Parser;
+    static forFilePath(filePath: string): Parser;
     /**
      * Parse content string for pik selectors and options
      */

package/dist/lib/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/lib/parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,WAAW,EAAY,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,qBAAa,MAAM;IAIL,OAAO,CAAC,QAAQ,CAAC,YAAY;IAHzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;gBAEhC,YAAY,EAAE,YAAY;IAEvD;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI9C;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW;IAuDnC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,eAAe;CAkBxB"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/lib/parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,WAAW,EAAY,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,qBAAa,MAAM;IAIL,OAAO,CAAC,QAAQ,CAAC,YAAY;IAHzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;gBAEhC,YAAY,EAAE,YAAY;IAEvD;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW;IAuDnC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,eAAe;CAkBxB"}

package/dist/lib/single-switcher.d.ts

@@ -5,9 +5,9 @@ import { Switcher } from './switcher.js';
  */
 export declare class SingleSwitcher extends Switcher {
     /**
-     * Create a switcher for a specific file extension
+     * Create a switcher for a file path
      */
-    static forExtension(extension: string): SingleSwitcher;
+    static forFilePath(filePath: string): SingleSwitcher;
     /**
      * Switch to a specific option, deactivating all others
      */

package/dist/lib/single-switcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"single-switcher.d.ts","sourceRoot":"","sources":["../../src/lib/single-switcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IAC1C;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc;IAItD;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;CAyBxE"}
+{"version":3,"file":"single-switcher.d.ts","sourceRoot":"","sources":["../../src/lib/single-switcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IAC1C;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc;IAIpD;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;CAyBxE"}

package/dist/lib/types/comment-style.d.ts

@@ -18,9 +18,11 @@ export declare class CommentStyle {
      */
     get hasBlockComments(): boolean;
     /**
-     * Get comment style for a file extension
+     * Get comment style for a file path.
+     *
+     * Handles dotfiles like `.env`, `.env.local`, `.env.development` correctly.
      */
-    static fromExtension(extension: string): CommentStyle;
+    static fromFilePath(filePath: string): CommentStyle;
     /**
      * Register a custom comment style for an extension
      */

package/dist/lib/types/comment-style.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"comment-style.d.ts","sourceRoot":"","sources":["../../../src/lib/types/comment-style.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,YAAY;IAiCrB,4CAA4C;aAC5B,WAAW,EAAE,MAAM;IAjCrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAsB5B;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAA0B;IAE9D,2CAA2C;IAC3C,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;;IAGlC,4CAA4C;IAC5B,WAAW,EAAE,MAAM,EACnC,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM;IAMrB;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;IAKrD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;CAI9D"}
+{"version":3,"file":"comment-style.d.ts","sourceRoot":"","sources":["../../../src/lib/types/comment-style.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,YAAY;IAiCrB,4CAA4C;aAC5B,WAAW,EAAE,MAAM;IAjCrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAsB5B;IAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAA0B;IAE9D,2CAA2C;IAC3C,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;;IAGlC,4CAA4C;IAC5B,WAAW,EAAE,MAAM,EACnC,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM;IAMrB;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY;IAkBnD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;CAI9D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lsst/pik-core",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "Core library for parsing and switching @pik config markers",
   "type": "module",
   "license": "MIT",