@ciderjs/vitest-plugin-gas-mock 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 luth
+
+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,96 @@
+# @ciderjs/vitest-plugin-gas-mock
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/@ciderjs/vitest-plugin-gas-mock.svg)](https://www.npmjs.com/package/@ciderjs/vitest-plugin-gas-mock)
+[![NPM Downloads](https://img.shields.io/npm/dw/@ciderjs/vitest-plugin-gas-mock)](https://www.npmjs.com/package/@ciderjs/vitest-plugin-gas-mock)
+[![GitHub issues](https://img.shields.io/github/issues/luthpg/vitest-plugin-gas-mock.svg)](https://github.com/luthpg/vitest-plugin-gas-mock/issues)
+
+Vitest plugin to mock Google Apps Script (GAS) environment.
+
+## Features
+
+- **Automatic Mocking**: Dynamically generates mocks based on official `@types/google-apps-script`.
+- **Method Chaining**: Supports GAS fluent APIs (e.g., `SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Sheet1')`).
+- **Global Injection**: Automatically injects mocks into the global scope in tests.
+- **`mockChain` Helper**: Easily override return values for complex method paths.
+
+## Installation
+
+```bash
+pnpm add -D @ciderjs/vitest-plugin-gas-mock
+```
+
+## Setup
+
+Add the plugin to your `vitest.config.ts`:
+
+```typescript
+import { defineConfig } from 'vitest/config';
+import { mockGas } from '@ciderjs/vitest-plugin-gas-mock';
+
+export default defineConfig({
+  plugins: [mockGas()],
+  test: {
+    globals: true, // Required for global injection
+  },
+});
+```
+
+## Usage
+
+### Basic Usage
+
+Once configured, GAS services like `SpreadsheetApp`, `DriveApp`, etc., are available globally in your tests.
+
+```typescript
+import { it, expect } from 'vitest';
+
+it('should mock SpreadsheetApp', () => {
+  const ss = SpreadsheetApp.getActiveSpreadsheet();
+  expect(ss).toBeDefined();
+  
+  const sheet = ss.getSheetByName('MySheet');
+  expect(sheet).toBeDefined();
+});
+```
+
+### Overriding Return Values with `mockChain`
+
+Use `mockChain` to set return values for specific method call paths.
+
+```typescript
+import { it, expect } from 'vitest';
+import { mockChain } from '@ciderjs/vitest-plugin-gas-mock';
+
+it('should return specific value for a chain', () => {
+  const mockValue = "Hello from mock";
+  
+  // Set the override
+  mockChain(
+    SpreadsheetApp, 
+    'SpreadsheetApp.getActiveSpreadsheet.getName', 
+    mockValue
+  );
+
+  const name = SpreadsheetApp.getActiveSpreadsheet().getName();
+  expect(name).toBe(mockValue);
+});
+```
+
+## How it works
+
+The plugin performs the following steps:
+
+1. **Analyze**: Parses GAS type definitions to build a map of classes, methods, and return types.
+2. **Generate**: Creates a runtime map that identifies which methods are "chainable" (i.e., return another GAS class).
+3. **Inject**: Uses a Proxy-based factory to create spies (`vi.fn()`) that automatically return new proxies for chainable methods.
+
+## Scripts
+
+- `pnpm generate`: Refreshes the internal GAS API map (runs automatically before build/test).
+- `pnpm build`: Builds the plugin.
+- `pnpm test`: Runs integration and unit tests.
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+const node_path = require('node:path');
+const node_url = require('node:url');
+const helpers = require('./shared/vitest-plugin-gas-mock.DyNb5Y_N.cjs');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+const __dirname$1 = node_path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+function mockGas() {
+  const setupFilePath = node_path.resolve(__dirname$1, "setup");
+  return {
+    name: "vite-plugin-gasmock",
+    config: (config) => {
+      const setupFiles = config.test?.setupFiles || [];
+      const newSetupFiles = Array.isArray(setupFiles) ? [...setupFiles, setupFilePath] : [setupFiles, setupFilePath];
+      return {
+        test: {
+          setupFiles: newSetupFiles
+        }
+      };
+    }
+  };
+}
+
+exports.mockChain = helpers.mockChain;
+exports.mockGas = mockGas;

package/dist/index.d.cts

@@ -0,0 +1,13 @@
+import { Plugin } from 'vitest/config';
+
+declare function mockGas(): Plugin;
+
+/**
+ * 特定のメソッドチェーンの戻り値を指定した値に設定する
+ * @param root モックのルートオブジェクト（現在は使用していませんが、API互換性のために残しています）
+ * @param path 文字列によるパス記法 (例: "SpreadsheetApp.getActiveSpreadsheet.getSheetByName")
+ * @param value 返すべき値
+ */
+declare function mockChain(_root: any, path: string, value: any): void;
+
+export { mockChain, mockGas };

package/dist/index.d.mts

@@ -0,0 +1,13 @@
+import { Plugin } from 'vitest/config';
+
+declare function mockGas(): Plugin;
+
+/**
+ * 特定のメソッドチェーンの戻り値を指定した値に設定する
+ * @param root モックのルートオブジェクト（現在は使用していませんが、API互換性のために残しています）
+ * @param path 文字列によるパス記法 (例: "SpreadsheetApp.getActiveSpreadsheet.getSheetByName")
+ * @param value 返すべき値
+ */
+declare function mockChain(_root: any, path: string, value: any): void;
+
+export { mockChain, mockGas };

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from 'vitest/config';
+
+declare function mockGas(): Plugin;
+
+/**
+ * 特定のメソッドチェーンの戻り値を指定した値に設定する
+ * @param root モックのルートオブジェクト（現在は使用していませんが、API互換性のために残しています）
+ * @param path 文字列によるパス記法 (例: "SpreadsheetApp.getActiveSpreadsheet.getSheetByName")
+ * @param value 返すべき値
+ */
+declare function mockChain(_root: any, path: string, value: any): void;
+
+export { mockChain, mockGas };

package/dist/index.mjs

@@ -0,0 +1,22 @@
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+export { m as mockChain } from './shared/vitest-plugin-gas-mock.DDSZt7OP.mjs';
+
+const __dirname$1 = dirname(fileURLToPath(import.meta.url));
+function mockGas() {
+  const setupFilePath = resolve(__dirname$1, "setup");
+  return {
+    name: "vite-plugin-gasmock",
+    config: (config) => {
+      const setupFiles = config.test?.setupFiles || [];
+      const newSetupFiles = Array.isArray(setupFiles) ? [...setupFiles, setupFilePath] : [setupFiles, setupFilePath];
+      return {
+        test: {
+          setupFiles: newSetupFiles
+        }
+      };
+    }
+  };
+}
+
+export { mockGas };