@lsst/pik-core 0.8.1 → 0.9.0

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export type { Option, BlockOption, ParseResult, PikPlugin } from './lib/types/in
 export { BaseSelector, Selector, BlockSelector } from './lib/types/index.js';
 export { CommentStyle } from './lib/types/index.js';
 export { defineConfig, loadConfig, findLocalConfig, isValidPlugin, type PikConfig, } from './lib/config.js';
+export { defineGlobalConfig, loadGlobalConfig, expandHome, globalConfigDir, type GlobalConfig, type GlobalProjectEntry, } from './lib/global-config.js';
 export { Parser } from './lib/parser.js';
 export { Switcher } from './lib/switcher.js';
 export { SingleSwitcher } from './lib/single-switcher.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD,OAAO,EACL,YAAY,EACZ,UAAU,EACV,eAAe,EACf,aAAa,EACb,KAAK,SAAS,GACf,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD,OAAO,EACL,YAAY,EACZ,UAAU,EACV,eAAe,EACf,aAAa,EACb,KAAK,SAAS,GACf,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,KAAK,YAAY,EACjB,KAAK,kBAAkB,GACxB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/index.js

@@ -1,9 +1,19 @@
 import { cosmiconfig } from "cosmiconfig";
+import { existsSync } from "fs";
+import { readFile } from "fs/promises";
+import { homedir } from "os";
+import { join } from "path";
+import { pathToFileURL } from "url";
 class BaseSelector {
   constructor(name, line) {
     this.name = name;
     this.line = line;
   }
+  /**
+   * Whether this selector is annotated with `@pik:global` and should be
+   * exposed across projects via the global config. Set by the parser.
+   */
+  isGlobal = false;
   /**
    * Get the name of the currently active option, or null if none is active
    */
@@ -318,11 +328,63 @@ function isValidPlugin(obj) {
   const plugin = obj;
   return typeof plugin.name === "string" && typeof plugin.description === "string" && typeof plugin.command === "string" && typeof plugin.register === "function";
 }
+function defineGlobalConfig(config) {
+  return config;
+}
+function expandHome(filePath) {
+  if (filePath === "~") {
+    return homedir();
+  }
+  if (filePath.startsWith("~/")) {
+    return join(homedir(), filePath.slice(2));
+  }
+  return filePath;
+}
+function globalConfigDir() {
+  const base = process.env.XDG_CONFIG_HOME || join(homedir(), ".config");
+  return join(base, "pik");
+}
+const CONFIG_FILES = [
+  "config.js",
+  "config.mjs",
+  "config.cjs",
+  "config.json",
+  "config.ts",
+  "config.mts"
+];
+async function loadGlobalConfig() {
+  const dir = globalConfigDir();
+  for (const file of CONFIG_FILES) {
+    const filePath = join(dir, file);
+    if (!existsSync(filePath)) {
+      continue;
+    }
+    let raw;
+    if (file.endsWith(".json")) {
+      raw = JSON.parse(await readFile(filePath, "utf-8"));
+    } else {
+      const mod = await import(pathToFileURL(filePath).href);
+      raw = mod.default ?? mod;
+    }
+    return normalize(raw);
+  }
+  return null;
+}
+function normalize(raw) {
+  if (!raw || typeof raw !== "object") {
+    return null;
+  }
+  const obj = raw;
+  const source = obj.global ?? obj;
+  const projects = Array.isArray(source.projects) ? source.projects : [];
+  return { projects };
+}
 class Parser {
   constructor(commentStyle) {
     this.commentStyle = commentStyle;
   }
   static SELECT_REGEX = /@pik:select\s+(\S+)/;
+  static GLOBAL_REGEX = /@pik:global\b/;
   static OPTION_REGEX = /@pik:option\s+(\S+)/;
   static BLOCK_START_REGEX = /@pik:block-start\s+(\S+)/;
   static BLOCK_END_REGEX = /@pik:block-end/;
@@ -346,7 +408,11 @@ class Parser {
       const lineNumber = i + 1;
       const selectMatch = line.match(Parser.SELECT_REGEX);
       if (selectMatch) {
-        pendingSelector = { name: selectMatch[1], line: lineNumber };
+        pendingSelector = {
+          name: selectMatch[1],
+          line: lineNumber,
+          isGlobal: Parser.GLOBAL_REGEX.test(line)
+        };
         currentSelector = null;
         continue;
       }
@@ -354,6 +420,7 @@ class Parser {
       if (blockStartMatch && (pendingSelector || currentSelector instanceof BlockSelector)) {
         if (!currentSelector && pendingSelector) {
           currentSelector = new BlockSelector(pendingSelector.name, pendingSelector.line);
+          currentSelector.isGlobal = pendingSelector.isGlobal;
           selectors.push(currentSelector);
           pendingSelector = null;
         }
@@ -386,6 +453,7 @@ class Parser {
       if (optionMatch && (pendingSelector || currentSelector instanceof Selector)) {
         if (!currentSelector && pendingSelector) {
           currentSelector = new Selector(pendingSelector.name, pendingSelector.line);
+          currentSelector.isGlobal = pendingSelector.isGlobal;
           selectors.push(currentSelector);
           pendingSelector = null;
         }
@@ -469,7 +537,11 @@ export {
   SingleSwitcher,
   Switcher,
   defineConfig,
+  defineGlobalConfig,
+  expandHome,
   findLocalConfig,
+  globalConfigDir,
   isValidPlugin,
-  loadConfig
+  loadConfig,
+  loadGlobalConfig
 };

package/dist/lib/global-config.d.ts

@@ -0,0 +1,45 @@
+/**
+ * A project opted into cross-project ("global") switch visibility.
+ *
+ * - A bare string is a path to the project root; every selector in it becomes global.
+ * - An object form can restrict which selectors surface and override the display label.
+ */
+export type GlobalProjectEntry = string | {
+    /** Absolute or `~`-relative path to the project root. */
+    path: string;
+    /** Label used to namespace this project's selectors. Defaults to the directory name. */
+    name?: string;
+    /**
+     * Restrict which selectors surface globally. When omitted, every selector in the
+     * project is global. When provided, only the named selectors are — plus any
+     * selector carrying an in-file `@pik:global` annotation (the two opt-ins compose).
+     */
+    selectors?: string[];
+};
+/**
+ * User-level global pik config, loaded from `~/.config/pik/config.*`.
+ */
+export interface GlobalConfig {
+    /** Projects whose switches may be listed and set from any directory. */
+    projects?: GlobalProjectEntry[];
+}
+/**
+ * Helper for type-safe global config definition.
+ */
+export declare function defineGlobalConfig(config: GlobalConfig): GlobalConfig;
+/**
+ * Expand a leading `~` / `~/` to the user's home directory.
+ */
+export declare function expandHome(filePath: string): string;
+/**
+ * Directory holding the global config, honoring `$XDG_CONFIG_HOME` (default `~/.config/pik`).
+ */
+export declare function globalConfigDir(): string;
+/**
+ * Load the user-level global pik config (`~/.config/pik/config.*`).
+ *
+ * Accepts either a bare `{ projects: [...] }` or a wrapped `{ global: { projects: [...] } }`
+ * shape. Returns `null` when no global config exists.
+ */
+export declare function loadGlobalConfig(): Promise<GlobalConfig | null>;
+//# sourceMappingURL=global-config.d.ts.map

package/dist/lib/global-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-config.d.ts","sourceRoot":"","sources":["../../src/lib/global-config.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN;IACE,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wEAAwE;IACxE,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAErE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAGxC;AAWD;;;;;GAKG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAuBrE"}

package/dist/lib/parser.d.ts

@@ -6,6 +6,7 @@ import { CommentStyle } from './types/index.js';
 export declare class Parser {
     private readonly commentStyle;
     private static readonly SELECT_REGEX;
+    private static readonly GLOBAL_REGEX;
     private static readonly OPTION_REGEX;
     private static readonly BLOCK_START_REGEX;
     private static readonly BLOCK_END_REGEX;

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,EAAuB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEzE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAOhD;;GAEG;AACH,qBAAa,MAAM;IAML,OAAO,CAAC,QAAQ,CAAC,YAAY;IALzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAA8B;IACvE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAoB;gBAE9B,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;IA0GnC;;;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,EAAuB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEzE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAQhD;;GAEG;AACH,qBAAa,MAAM;IAOL,OAAO,CAAC,QAAQ,CAAC,YAAY;IANzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAmB;IACvD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAyB;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAA8B;IACvE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAoB;gBAE9B,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;IAkHnC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,eAAe;CAkBxB"}

package/dist/lib/selector/base-selector.d.ts

@@ -9,6 +9,11 @@ export declare abstract class BaseSelector {
     readonly line: number;
     /** Options for this selector */
     abstract readonly options: BaseOption[];
+    /**
+     * Whether this selector is annotated with `@pik:global` and should be
+     * exposed across projects via the global config. Set by the parser.
+     */
+    isGlobal: boolean;
     constructor(
     /** Selector name (e.g., "Environment") */
     name: string, 

package/dist/lib/selector/base-selector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-selector.d.ts","sourceRoot":"","sources":["../../../src/lib/selector/base-selector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,8BAAsB,YAAY;IAK9B,0CAA0C;aAC1B,IAAI,EAAE,MAAM;IAC5B,0DAA0D;aAC1C,IAAI,EAAE,MAAM;IAP9B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;;IAGtC,0CAA0C;IAC1B,IAAI,EAAE,MAAM;IAC5B,0DAA0D;IAC1C,IAAI,EAAE,MAAM;IAG9B;;OAEG;IACH,mBAAmB,IAAI,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;CACjF"}
+{"version":3,"file":"base-selector.d.ts","sourceRoot":"","sources":["../../../src/lib/selector/base-selector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,8BAAsB,YAAY;IAW9B,0CAA0C;aAC1B,IAAI,EAAE,MAAM;IAC5B,0DAA0D;aAC1C,IAAI,EAAE,MAAM;IAb9B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;IAExC;;;OAGG;IACH,QAAQ,UAAS;;IAGf,0CAA0C;IAC1B,IAAI,EAAE,MAAM;IAC5B,0DAA0D;IAC1C,IAAI,EAAE,MAAM;IAG9B;;OAEG;IACH,mBAAmB,IAAI,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;CACjF"}

package/package.json

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