@get-skipper/nightwatch 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skipper Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# @get-skipper/nightwatch
+
+Skipper plugin for [Nightwatch.js](https://nightwatchjs.org/) — enable/disable tests from a Google Spreadsheet.
+
+## Installation
+
+```bash
+pnpm add -D @get-skipper/nightwatch
+# or
+npm install --save-dev @get-skipper/nightwatch
+```
+
+## Setup
+
+Update `nightwatch.conf.js` — this is the **only change required**:
+
+```js
+const { createSkipperPlugin } = require('@get-skipper/nightwatch');
+
+module.exports = {
+  globals: createSkipperPlugin({
+    spreadsheetId: process.env.SKIPPER_SPREADSHEET_ID,
+    credentials: { credentialsBase64: process.env.GOOGLE_CREDS_B64 },
+    // Or for local dev:
+    // credentials: { credentialsFile: './service-account.json' },
+  }),
+  // ... rest of your config
+};
+```
+
+No changes to test files are required. Tests with a future `disabledUntil` date are automatically skipped via `beforeEach`.
+
+## Test ID Format
+
+```
+{module path} > {test name}
+```
+
+If Nightwatch exposes nested describe blocks via `titlePath`, the full path is used:
+```
+tests/auth/login.js > login > should log in with valid credentials
+```
+
+## Modes
+
+- **`read-only`** (default): reads the spreadsheet, skips disabled tests. No writes.
+- **`sync`** (`SKIPPER_MODE=sync`): same as read-only + reconciles the spreadsheet after the run.
+
+See the [root README](../../README.md) for full setup instructions.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,28 @@
+import { SkipperConfig } from '@get-skipper/core';
+export { SkipperConfig } from '@get-skipper/core';
+
+/**
+ * Creates a Nightwatch globals object that integrates Skipper.
+ *
+ * - `before`: initializes the resolver (reads the spreadsheet)
+ * - `beforeEach`: skips the test if disabledUntil is in the future
+ * - `after`: in sync mode, reconciles the spreadsheet with discovered tests
+ *
+ * Usage in nightwatch.conf.js:
+ * ```js
+ * const { createSkipperPlugin } = require('@get-skipper/nightwatch');
+ * module.exports = {
+ *   globals: createSkipperPlugin({ spreadsheetId: '...', credentials: { ... } }),
+ * };
+ * ```
+ */
+declare function createSkipperPlugin(config: SkipperConfig): {
+    before(): Promise<void>;
+    beforeEach(browser: NightwatchBrowser, done: () => void): void;
+    after(): Promise<void>;
+};
+interface NightwatchBrowser {
+    skip(): void;
+}
+
+export { createSkipperPlugin };

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { SkipperConfig } from '@get-skipper/core';
+export { SkipperConfig } from '@get-skipper/core';
+
+/**
+ * Creates a Nightwatch globals object that integrates Skipper.
+ *
+ * - `before`: initializes the resolver (reads the spreadsheet)
+ * - `beforeEach`: skips the test if disabledUntil is in the future
+ * - `after`: in sync mode, reconciles the spreadsheet with discovered tests
+ *
+ * Usage in nightwatch.conf.js:
+ * ```js
+ * const { createSkipperPlugin } = require('@get-skipper/nightwatch');
+ * module.exports = {
+ *   globals: createSkipperPlugin({ spreadsheetId: '...', credentials: { ... } }),
+ * };
+ * ```
+ */
+declare function createSkipperPlugin(config: SkipperConfig): {
+    before(): Promise<void>;
+    beforeEach(browser: NightwatchBrowser, done: () => void): void;
+    after(): Promise<void>;
+};
+interface NightwatchBrowser {
+    skip(): void;
+}
+
+export { createSkipperPlugin };

package/dist/index.js

@@ -0,0 +1,73 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createSkipperPlugin: () => createSkipperPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/globals.ts
+var import_core = require("@get-skipper/core");
+function createSkipperPlugin(config) {
+  let resolver;
+  const discoveredIds = [];
+  return {
+    async before() {
+      resolver = new import_core.SkipperResolver(config);
+      await resolver.initialize();
+      (0, import_core.log)("[skipper] Spreadsheet loaded.");
+    },
+    beforeEach(browser, done) {
+      if (!resolver) {
+        done();
+        return;
+      }
+      const currentTest = browser.currentTest;
+      if (!currentTest) {
+        done();
+        return;
+      }
+      const titlePath = currentTest.titlePath ?? [currentTest.name].filter(Boolean);
+      const filePath = currentTest.module ?? "";
+      const testId = (0, import_core.buildTestId)(filePath, titlePath);
+      discoveredIds.push(testId);
+      if (!resolver.isTestEnabled(testId)) {
+        browser.skip();
+      }
+      done();
+    },
+    async after() {
+      if (process.env.SKIPPER_MODE !== "sync") return;
+      if (discoveredIds.length === 0) {
+        (0, import_core.log)("[skipper] No tests discovered \u2014 skipping spreadsheet sync.");
+        return;
+      }
+      (0, import_core.log)(`[skipper] Syncing ${discoveredIds.length} test(s) to spreadsheet\u2026`);
+      const writer = new import_core.SheetsWriter(config);
+      await writer.sync(discoveredIds);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSkipperPlugin
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/globals.ts"],"sourcesContent":["export { createSkipperPlugin } from './globals';\nexport type { SkipperConfig } from '@get-skipper/core';\n","import { SkipperResolver, SheetsWriter, buildTestId, log } from '@get-skipper/core';\nimport type { SkipperConfig } from '@get-skipper/core';\n\n/**\n * Creates a Nightwatch globals object that integrates Skipper.\n *\n * - `before`: initializes the resolver (reads the spreadsheet)\n * - `beforeEach`: skips the test if disabledUntil is in the future\n * - `after`: in sync mode, reconciles the spreadsheet with discovered tests\n *\n * Usage in nightwatch.conf.js:\n * ```js\n * const { createSkipperPlugin } = require('@get-skipper/nightwatch');\n * module.exports = {\n *   globals: createSkipperPlugin({ spreadsheetId: '...', credentials: { ... } }),\n * };\n * ```\n */\nexport function createSkipperPlugin(config: SkipperConfig) {\n  let resolver: SkipperResolver;\n  const discoveredIds: string[] = [];\n\n  return {\n    async before(): Promise<void> {\n      resolver = new SkipperResolver(config);\n      await resolver.initialize();\n      log('[skipper] Spreadsheet loaded.');\n    },\n\n    beforeEach(browser: NightwatchBrowser, done: () => void): void {\n      if (!resolver) {\n        done();\n        return;\n      }\n\n      const currentTest = (browser as unknown as { currentTest: NightwatchCurrentTest }).currentTest;\n      if (!currentTest) {\n        done();\n        return;\n      }\n\n      // Build the title path: Nightwatch may expose titlePath or just module + name\n      const titlePath: string[] =\n        (currentTest as unknown as { titlePath?: string[] }).titlePath ??\n        [currentTest.name].filter(Boolean);\n\n      const filePath = currentTest.module ?? '';\n      const testId = buildTestId(filePath, titlePath);\n      discoveredIds.push(testId);\n\n      if (!resolver.isTestEnabled(testId)) {\n        browser.skip();\n      }\n\n      done();\n    },\n\n    async after(): Promise<void> {\n      if (process.env.SKIPPER_MODE !== 'sync') return;\n      if (discoveredIds.length === 0) {\n        log('[skipper] No tests discovered — skipping spreadsheet sync.');\n        return;\n      }\n\n      log(`[skipper] Syncing ${discoveredIds.length} test(s) to spreadsheet…`);\n      const writer = new SheetsWriter(config);\n      await writer.sync(discoveredIds);\n    },\n  };\n}\n\n// Minimal type stubs for Nightwatch globals context (avoid requiring nightwatch types as a dep)\ninterface NightwatchCurrentTest {\n  name: string;\n  module: string;\n}\n\ninterface NightwatchBrowser {\n  skip(): void;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAAgE;AAkBzD,SAAS,oBAAoB,QAAuB;AACzD,MAAI;AACJ,QAAM,gBAA0B,CAAC;AAEjC,SAAO;AAAA,IACL,MAAM,SAAwB;AAC5B,iBAAW,IAAI,4BAAgB,MAAM;AACrC,YAAM,SAAS,WAAW;AAC1B,2BAAI,+BAA+B;AAAA,IACrC;AAAA,IAEA,WAAW,SAA4B,MAAwB;AAC7D,UAAI,CAAC,UAAU;AACb,aAAK;AACL;AAAA,MACF;AAEA,YAAM,cAAe,QAA8D;AACnF,UAAI,CAAC,aAAa;AAChB,aAAK;AACL;AAAA,MACF;AAGA,YAAM,YACH,YAAoD,aACrD,CAAC,YAAY,IAAI,EAAE,OAAO,OAAO;AAEnC,YAAM,WAAW,YAAY,UAAU;AACvC,YAAM,aAAS,yBAAY,UAAU,SAAS;AAC9C,oBAAc,KAAK,MAAM;AAEzB,UAAI,CAAC,SAAS,cAAc,MAAM,GAAG;AACnC,gBAAQ,KAAK;AAAA,MACf;AAEA,WAAK;AAAA,IACP;AAAA,IAEA,MAAM,QAAuB;AAC3B,UAAI,QAAQ,IAAI,iBAAiB,OAAQ;AACzC,UAAI,cAAc,WAAW,GAAG;AAC9B,6BAAI,iEAA4D;AAChE;AAAA,MACF;AAEA,2BAAI,qBAAqB,cAAc,MAAM,+BAA0B;AACvE,YAAM,SAAS,IAAI,yBAAa,MAAM;AACtC,YAAM,OAAO,KAAK,aAAa;AAAA,IACjC;AAAA,EACF;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,46 @@
+// src/globals.ts
+import { SkipperResolver, SheetsWriter, buildTestId, log } from "@get-skipper/core";
+function createSkipperPlugin(config) {
+  let resolver;
+  const discoveredIds = [];
+  return {
+    async before() {
+      resolver = new SkipperResolver(config);
+      await resolver.initialize();
+      log("[skipper] Spreadsheet loaded.");
+    },
+    beforeEach(browser, done) {
+      if (!resolver) {
+        done();
+        return;
+      }
+      const currentTest = browser.currentTest;
+      if (!currentTest) {
+        done();
+        return;
+      }
+      const titlePath = currentTest.titlePath ?? [currentTest.name].filter(Boolean);
+      const filePath = currentTest.module ?? "";
+      const testId = buildTestId(filePath, titlePath);
+      discoveredIds.push(testId);
+      if (!resolver.isTestEnabled(testId)) {
+        browser.skip();
+      }
+      done();
+    },
+    async after() {
+      if (process.env.SKIPPER_MODE !== "sync") return;
+      if (discoveredIds.length === 0) {
+        log("[skipper] No tests discovered \u2014 skipping spreadsheet sync.");
+        return;
+      }
+      log(`[skipper] Syncing ${discoveredIds.length} test(s) to spreadsheet\u2026`);
+      const writer = new SheetsWriter(config);
+      await writer.sync(discoveredIds);
+    }
+  };
+}
+export {
+  createSkipperPlugin
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/globals.ts"],"sourcesContent":["import { SkipperResolver, SheetsWriter, buildTestId, log } from '@get-skipper/core';\nimport type { SkipperConfig } from '@get-skipper/core';\n\n/**\n * Creates a Nightwatch globals object that integrates Skipper.\n *\n * - `before`: initializes the resolver (reads the spreadsheet)\n * - `beforeEach`: skips the test if disabledUntil is in the future\n * - `after`: in sync mode, reconciles the spreadsheet with discovered tests\n *\n * Usage in nightwatch.conf.js:\n * ```js\n * const { createSkipperPlugin } = require('@get-skipper/nightwatch');\n * module.exports = {\n *   globals: createSkipperPlugin({ spreadsheetId: '...', credentials: { ... } }),\n * };\n * ```\n */\nexport function createSkipperPlugin(config: SkipperConfig) {\n  let resolver: SkipperResolver;\n  const discoveredIds: string[] = [];\n\n  return {\n    async before(): Promise<void> {\n      resolver = new SkipperResolver(config);\n      await resolver.initialize();\n      log('[skipper] Spreadsheet loaded.');\n    },\n\n    beforeEach(browser: NightwatchBrowser, done: () => void): void {\n      if (!resolver) {\n        done();\n        return;\n      }\n\n      const currentTest = (browser as unknown as { currentTest: NightwatchCurrentTest }).currentTest;\n      if (!currentTest) {\n        done();\n        return;\n      }\n\n      // Build the title path: Nightwatch may expose titlePath or just module + name\n      const titlePath: string[] =\n        (currentTest as unknown as { titlePath?: string[] }).titlePath ??\n        [currentTest.name].filter(Boolean);\n\n      const filePath = currentTest.module ?? '';\n      const testId = buildTestId(filePath, titlePath);\n      discoveredIds.push(testId);\n\n      if (!resolver.isTestEnabled(testId)) {\n        browser.skip();\n      }\n\n      done();\n    },\n\n    async after(): Promise<void> {\n      if (process.env.SKIPPER_MODE !== 'sync') return;\n      if (discoveredIds.length === 0) {\n        log('[skipper] No tests discovered — skipping spreadsheet sync.');\n        return;\n      }\n\n      log(`[skipper] Syncing ${discoveredIds.length} test(s) to spreadsheet…`);\n      const writer = new SheetsWriter(config);\n      await writer.sync(discoveredIds);\n    },\n  };\n}\n\n// Minimal type stubs for Nightwatch globals context (avoid requiring nightwatch types as a dep)\ninterface NightwatchCurrentTest {\n  name: string;\n  module: string;\n}\n\ninterface NightwatchBrowser {\n  skip(): void;\n}\n"],"mappings":";AAAA,SAAS,iBAAiB,cAAc,aAAa,WAAW;AAkBzD,SAAS,oBAAoB,QAAuB;AACzD,MAAI;AACJ,QAAM,gBAA0B,CAAC;AAEjC,SAAO;AAAA,IACL,MAAM,SAAwB;AAC5B,iBAAW,IAAI,gBAAgB,MAAM;AACrC,YAAM,SAAS,WAAW;AAC1B,UAAI,+BAA+B;AAAA,IACrC;AAAA,IAEA,WAAW,SAA4B,MAAwB;AAC7D,UAAI,CAAC,UAAU;AACb,aAAK;AACL;AAAA,MACF;AAEA,YAAM,cAAe,QAA8D;AACnF,UAAI,CAAC,aAAa;AAChB,aAAK;AACL;AAAA,MACF;AAGA,YAAM,YACH,YAAoD,aACrD,CAAC,YAAY,IAAI,EAAE,OAAO,OAAO;AAEnC,YAAM,WAAW,YAAY,UAAU;AACvC,YAAM,SAAS,YAAY,UAAU,SAAS;AAC9C,oBAAc,KAAK,MAAM;AAEzB,UAAI,CAAC,SAAS,cAAc,MAAM,GAAG;AACnC,gBAAQ,KAAK;AAAA,MACf;AAEA,WAAK;AAAA,IACP;AAAA,IAEA,MAAM,QAAuB;AAC3B,UAAI,QAAQ,IAAI,iBAAiB,OAAQ;AACzC,UAAI,cAAc,WAAW,GAAG;AAC9B,YAAI,iEAA4D;AAChE;AAAA,MACF;AAEA,UAAI,qBAAqB,cAAc,MAAM,+BAA0B;AACvE,YAAM,SAAS,IAAI,aAAa,MAAM;AACtC,YAAM,OAAO,KAAK,aAAa;AAAA,IACjC;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@get-skipper/nightwatch",
+  "version": "1.0.0",
+  "description": "Skipper plugin for Nightwatch.js — enable/disable tests from a Google Spreadsheet",
+  "keywords": [
+    "skipper",
+    "nightwatch",
+    "testing",
+    "google-sheets",
+    "test-gating"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@get-skipper/core": "1.0.0"
+  },
+  "peerDependencies": {
+    "nightwatch": ">=3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "jest --config ../../jest.config.js --testPathPattern=packages/nightwatch/"
+  }
+}