gasup 0.2.1 → 0.3.1

package/README.md

@@ -0,0 +1,121 @@
+# Gasup
+
+Gasup is a command-line interface (CLI) tool designed to simplify the process.
+
+- building
+- bundling
+- pushing
+- deploying
+- change development, staging, production
+
+It offers an easy way to automate tasks and manage your deployments without the need to manually interact with the Apps Script dashboard.
+
+## Installation
+
+To get started with gasup, you need clasp first.
+
+Then you can install gasup like below.
+
+```
+npm i -g gasup
+```
+
+## Usage
+
+### Build
+
+Simple build.
+
+```
+gasup --build
+```
+
+This command compiles your code with tsc.
+
+### Bundle
+
+Bundle with esbuild into one file. This allows you to use libraries that are not natively available in Google Apps Script.
+
+```
+gasup --bundle
+```
+
+### Push
+
+Simply push using "clasp push".
+
+```
+gasup --push
+```
+
+### Deploy
+
+Deploy to the latest deployment. If no previous deployments exist, a new deployment will be created.
+
+```
+gasup --deploy
+```
+
+### Change Environment
+
+If you need to switch between different environments (e.g., development, staging, production), you can use the --env flag to modify the appsscript.json file accordingly.
+
+```
+gasup --env <target>
+```
+
+Target options:
+
+- dev : Development environment
+- stag : Staging environment
+- prod : Production environment
+
+Default environment files:
+
+.env, .env.staging, .env.production
+
+Environment file details:
+
+```env
+GASUP_SCRIPT_ID=xxx
+GASUP_PARENT_ID=yyy,zzz
+```
+
+### Chain
+
+Chan command is available like below.
+
+```
+gasup --env dev --build --push --deploy
+```
+
+### Config
+
+The config file will below.
+
+```ts
+// gasup.config.ts
+import { Config } from 'gasup';
+
+const config:Config = {
+  srcDir: './src';
+}
+
+export default config;
+```
+
+```ts
+export interface Config {
+  envPaths?: Record<Env, string>;
+  claspJsonPath?: string;
+  appsScriptJsonPath?: string;
+  bundleEntries?: string[];
+  bundleOutfile?: string;
+  srcDir?: string;
+  distDir?: string;
+}
+```
+
+## License
+
+MIT

package/dist/Config.d.ts

@@ -1,13 +1,15 @@
-export type Env = 'dev' | 'stag' | 'prod';
-export interface Config {
-    envPaths?: Record<Env, string>;
+import { Config } from './types.js';
+export declare const config: {
+    envPaths: {
+        dev: string;
+        stag: string;
+        prod: string;
+    };
     claspJsonPath?: string;
     appsScriptJsonPath?: string;
     bundleEntries?: string[];
     bundleOutfile?: string;
     srcDir?: string;
     distDir?: string;
-}
+};
 export declare const defaultConfig: Config;
-export declare function initConfig(): void;
-export declare function getConfig(): Config;

package/dist/Config.js

@@ -1,7 +1,8 @@
-import { readFileSync } from 'fs';
 import fs from 'fs-extra';
 import path from 'path';
-const configPath = 'gasup.json';
+import tsnode from 'ts-node';
+const configFileName = 'gasup.config.ts';
+export const config = loadConfigWithDefault();
 export const defaultConfig = {
     envPaths: {
         dev: '.env',
@@ -15,21 +16,28 @@ export const defaultConfig = {
     srcDir: 'src',
     distDir: 'dist',
 };
-export function initConfig() {
-    const config = getConfig();
-    fs.writeFileSync(path.join(process.cwd(), configPath), JSON.stringify(config, null, 2));
+function loadConfigWithDefault() {
+    const configPath = path.join(process.cwd(), configFileName);
+    const config = loadConfig(configPath);
+    return {
+        ...defaultConfig,
+        ...config,
+        envPaths: { ...defaultConfig.envPaths, ...(config.envPaths ?? {}) },
+    };
 }
-export function getConfig() {
+function loadConfig(configPath) {
     try {
-        const res = readFileSync(path.join(process.cwd(), configPath));
-        const data = JSON.parse(res.toString());
-        return {
-            ...defaultConfig,
-            ...data,
-            envPaths: { ...defaultConfig.envPaths, ...(data.envPaths ?? {}) },
-        };
+        const configString = fs.readFileSync(configPath, 'utf-8');
+        const compiledPath = path.join(__dirname, '__config_compiled.js');
+        const compiledCode = tsnode
+            .create()
+            .compile(configString, 'config_dummy.ts');
+        fs.writeFileSync(compiledPath, compiledCode);
+        const data = require(compiledPath);
+        fs.unlinkSync(compiledPath);
+        return data.default;
     }
-    catch (e) {
-        return defaultConfig;
+    catch (err) {
+        return {};
     }
 }

package/dist/appsScript.js

@@ -1,13 +1,11 @@
 import { copyFileSync } from 'fs';
-import { getConfig } from './config.js';
 import fs from 'fs-extra';
 import path from 'path';
+import { config } from './config.js';
 export function getAppsScript() {
-    const config = getConfig();
     const json = fs.readFileSync(config.appsScriptJsonPath, 'utf-8');
     return JSON.parse(json ?? '{}');
 }
 export function copyAppsScript() {
-    const config = getConfig();
     copyFileSync(config.appsScriptJsonPath, path.join(config.distDir, 'appsscript.json'));
 }

package/dist/bin/gasup.js

@@ -1,7 +1,7 @@
 import { program } from 'commander';
 import { build } from '../build.js';
 import { bundle } from '../bundle.js';
-import { changeEnv } from '../changeEnv.js';
+import { changeEnv } from '../envFile/changeEnv.js';
 import { init } from '../init.js';
 import inquirer from 'inquirer';
 import { execSync } from 'child_process';

package/dist/build.js

@@ -1,9 +1,8 @@
 import { execSync } from 'child_process';
 import { copyFileSync } from 'fs';
 import path from 'path';
-import { getConfig } from './config.js';
+import { config } from './config.js';
 export function build() {
     execSync('tsc', { stdio: 'inherit' });
-    const config = getConfig();
     copyFileSync(config.appsScriptJsonPath, path.join(config.distDir, 'appsscript.json'));
 }

package/dist/bundle.js

@@ -1,10 +1,9 @@
-import { getConfig } from './config.js';
 import esbuild from 'esbuild';
 import { GasPlugin } from 'esbuild-gas-plugin';
 import fs from 'fs-extra';
 import path from 'path';
+import { config } from './config.js';
 export async function bundle() {
-    const config = getConfig();
     await esbuild.build({
         entryPoints: config.bundleEntries,
         bundle: true,

package/dist/changeEnv.js

@@ -1,6 +1,6 @@
-import dotenv from 'dotenv';
 import fs from 'fs-extra';
 import { getConfig } from './config.js';
+import { getEnvData } from './envFile/envFile.js';
 export function changeEnv(env = 'dev') {
     const config = getConfig();
     const envPath = config.envPaths[env];
@@ -13,14 +13,15 @@ export function changeEnv(env = 'dev') {
             throw new Error(`${path} not found`);
         }
     }
-    dotenv.config({ path: envPath });
-    const scriptId = process.env.GASUP_SCRIPT_ID;
+    const envData = getEnvData(envPath);
+    const scriptId = envData.GASUP_SCRIPT_ID;
     if (!scriptId) {
         throw new Error(`GASUP_SCRIPT_ID not found on ${envPath}`);
     }
     const data = {
         scriptId,
         rootDir: config.distDir,
+        parentId: envData.GASUP_PARENT_ID,
     };
     fs.writeFileSync(claspJsonPath, JSON.stringify(data, null, 2));
 }

package/dist/claspJson.d.ts

@@ -1 +1,6 @@
-export declare function getClaspJson(): any;
+export interface ClaspJson {
+    scriptId?: string;
+    rootDir?: string;
+    parentId?: string[];
+}
+export declare function getClaspJson(): ClaspJson;

package/dist/claspJson.js

@@ -1,7 +1,6 @@
-import { getConfig } from './config.js';
 import fs from 'fs-extra';
+import { config } from './config.js';
 export function getClaspJson() {
-    const config = getConfig();
     const json = fs.readFileSync(config.claspJsonPath, 'utf-8');
     return JSON.parse(json ?? '{}');
 }

package/dist/envFile/addToEnvString.d.ts

@@ -0,0 +1 @@
+export declare function addToEnvString(envString: string, _items: Record<string, string>): string;

package/dist/envFile/addToEnvString.js

@@ -0,0 +1,39 @@
+// 環境変数を変更する
+export function addToEnvString(envString, _items) {
+    const items = { ..._items };
+    const newLines = [];
+    for (const line of envString.split('\n')) {
+        if (isCommentLine(line)) {
+            newLines.push(line);
+        }
+        else {
+            const { key, value } = parseLine(line);
+            if (key) {
+                if (items[key]) {
+                    newLines.push(`${key}=${items[key]}`);
+                    delete items[key];
+                }
+                else {
+                    newLines.push(`${key}=${value}`);
+                }
+            }
+            else {
+                newLines.push('');
+            }
+        }
+    }
+    newLines.push('');
+    for (const [key, value] of Object.entries(items)) {
+        if (!key)
+            continue;
+        newLines.push(`${key}=${value}`);
+    }
+    return newLines.join('\n');
+}
+function isCommentLine(line) {
+    return line.startsWith('#');
+}
+function parseLine(line) {
+    const [key, ...values] = line.split('=');
+    return { key, value: values.join('=') };
+}

package/dist/envFile/addToEnvString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/envFile/addToEnvString.test.js

@@ -0,0 +1,56 @@
+import { addToEnvString } from './addToEnvString.js';
+import { describe, it, expect } from 'vitest';
+describe('addToEnvString', () => {
+    const mockEnvString = `
+# This is a comment
+KEY1=value1
+KEY2=value2
+`.trim();
+    it('should add new keys to the env string and overwrite existing ones', () => {
+        const itemsToAdd = {
+            KEY3: 'value3',
+            KEY1: 'newValue1', // 既存のKEY1を上書きしない
+        };
+        const result = addToEnvString(mockEnvString, itemsToAdd);
+        // 新しい環境変数を含んだ結果を確認
+        const expectedContent = `
+# This is a comment
+KEY1=value1
+KEY2=value2
+
+KEY3=value3
+`.trim();
+        console.log({ mockEnvString, result, expectedContent });
+        expect(result).toBe(expectedContent);
+    });
+    it('should add only new keys if not already in the string', () => {
+        const itemsToAdd = {
+            KEY3: 'value3',
+            KEY4: 'value4',
+        };
+        const result = addToEnvString(mockEnvString, itemsToAdd);
+        // 新しい環境変数を含んだ結果を確認
+        const expectedContent = `
+# This is a comment
+KEY1=value1
+KEY2=value2
+
+KEY3=value3
+KEY4=value4
+`.trim();
+        expect(result).toBe(expectedContent);
+    });
+    it('should handle an empty env string', () => {
+        const itemsToAdd = {
+            KEY1: 'value1',
+            KEY2: 'value2',
+        };
+        const result = addToEnvString('', itemsToAdd);
+        // 空の環境変数文字列に対して追加された内容を確認
+        const expectedContent = `
+KEY1=value1
+KEY2=value2
+`.trim();
+        expect(result.trim()).toBe(expectedContent);
+    });
+});

package/dist/envFile/changeEnv.d.ts

@@ -0,0 +1,2 @@
+import { Env } from '../types.js';
+export declare function changeEnv(env?: Env): void;

package/dist/envFile/changeEnv.js

@@ -0,0 +1,26 @@
+import fs from 'fs-extra';
+import { config } from '../config.js';
+import { getEnvData } from './envFile.js';
+export function changeEnv(env = 'dev') {
+    const envPath = config.envPaths[env];
+    if (!envPath) {
+        throw new Error(`envPath not found on ${envPath}`);
+    }
+    const claspJsonPath = config.claspJsonPath;
+    for (const path of [envPath, claspJsonPath]) {
+        if (!fs.existsSync(path)) {
+            throw new Error(`${path} not found`);
+        }
+    }
+    const envData = getEnvData(envPath);
+    const scriptId = envData.GASUP_SCRIPT_ID;
+    if (!scriptId) {
+        throw new Error(`GASUP_SCRIPT_ID not found on ${envPath}`);
+    }
+    const data = {
+        scriptId,
+        rootDir: config.distDir,
+        parentId: envData.GASUP_PARENT_ID,
+    };
+    fs.writeFileSync(claspJsonPath, JSON.stringify(data, null, 2));
+}

package/dist/envFile/envFile.d.ts

@@ -0,0 +1,4 @@
+import { EnvObject } from '../types.js';
+export declare function initEnvFiles(): void;
+export declare function getEnvData(envPath: string): EnvObject;
+export declare function addToEnvFile(envPath: string, _items: Record<string, string>): void;

package/dist/envFile/envFile.js

@@ -0,0 +1,36 @@
+import dotenv from 'dotenv';
+import fs from 'fs-extra';
+import { config } from '../config.js';
+import { getClaspJson } from './../claspJson.js';
+import { addToEnvString } from './addToEnvString.js';
+export function initEnvFiles() {
+    const claspJson = getClaspJson();
+    const envPath = config.envPaths['dev'];
+    console.log({ claspJson });
+    addToEnvFile(envPath, {
+        GASUP_SCRIPT_ID: claspJson.scriptId,
+        GASUP_PARENT_ID: claspJson.parentId?.join(','),
+    });
+}
+export function getEnvData(envPath) {
+    try {
+        const envString = fs.readFileSync(envPath, 'utf-8');
+        const data = dotenv.parse(envString);
+        return {
+            GASUP_SCRIPT_ID: data.GASUP_SCRIPT_ID,
+            GASUP_PARENT_ID: data.GASUP_PARENT_ID?.split(','),
+        };
+    }
+    catch (err) {
+        return {};
+    }
+}
+export function addToEnvFile(envPath, _items) {
+    let envString = '';
+    try {
+        envString = fs.readFileSync(envPath, 'utf-8');
+    }
+    catch (e) { }
+    const newEnvString = addToEnvString(envString.trim(), _items);
+    fs.writeFileSync(envPath, newEnvString);
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './bundle.js';
-export * from './changeEnv.js';
+export * from './envFile/changeEnv.js';
 export * from './config.js';
+export * from './types.js';

package/dist/index.js

@@ -1,3 +1,4 @@
 export * from './bundle.js';
-export * from './changeEnv.js';
+export * from './envFile/changeEnv.js';
 export * from './config.js';
+export * from './types.js';

package/dist/init.js

@@ -1,8 +1,6 @@
-import { initConfig } from './config.js';
-import { initEnvFiles } from './envFile.js';
+import { initEnvFiles } from './envFile/envFile.js';
 import { addGitIgnores } from './gitignore.js';
 export function init() {
-    initConfig();
     initEnvFiles();
     addGitIgnores();
 }

package/dist/types.d.ts

@@ -0,0 +1,14 @@
+export type Env = 'dev' | 'stag' | 'prod';
+export interface Config {
+    envPaths?: Record<Env, string>;
+    claspJsonPath?: string;
+    appsScriptJsonPath?: string;
+    bundleEntries?: string[];
+    bundleOutfile?: string;
+    srcDir?: string;
+    distDir?: string;
+}
+export interface EnvObject {
+    GASUP_SCRIPT_ID?: string;
+    GASUP_PARENT_ID?: string[];
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gasup",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "type": "module",
   "bin": {
     "gasup": "./dist/bin/gasup.js"