@konomi-app/k2 0.9.0 → 0.10.0

package/dist/commands/dev/index.js

@@ -0,0 +1,54 @@
+import { program } from 'commander';
+import fs from 'fs-extra';
+import path from 'path';
+import { CONFIG_FILE_NAME, DEFAULT_PORT, DEVELOPMENT_DIRECTORY, WORKSPACE_DIRECTORY, } from '../../lib/constants.js';
+import base from '../dev-base-esbuild.js';
+import { importK2Config } from '../../lib/import.js';
+import { watchCss } from './tailwind.js';
+export default function command() {
+    program
+        .command('dev')
+        .description('Start development server.')
+        .option('-i, --input <input>', 'Input directory', 'src/apps')
+        .option('-o, --outdir <outdir>', 'Output directory.', DEVELOPMENT_DIRECTORY)
+        .option('-c, --certdir <certdir>', 'Certificate directory', WORKSPACE_DIRECTORY)
+        .option('-p, --port <port>', 'Port number')
+        .action(action);
+}
+export async function action(options) {
+    const { certdir, outdir, port: specifiedPort, input } = options;
+    console.group('🍳 Start development server');
+    try {
+        console.log(`📂 Output directory: ${outdir}`);
+        console.log(`🔑 Certificate directory: ${certdir}`);
+        let k2Config = null;
+        try {
+            k2Config = await importK2Config();
+        }
+        catch (error) {
+            console.log(`⚙ ${CONFIG_FILE_NAME} not found. use default settings.`);
+        }
+        const port = Number(specifiedPort ?? k2Config?.server?.port ?? DEFAULT_PORT);
+        await Promise.all([build({ certdir, outdir, port, input }), watchCss(k2Config?.plugin ?? {})]);
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}
+const build = async (params) => {
+    const { outdir, certdir, port, input } = params;
+    const srcDir = path.resolve(input);
+    const dirs = fs.readdirSync(srcDir);
+    const entryPoints = dirs.reduce((acc, dir) => {
+        for (const filename of ['index.ts', 'index.js', 'index.mjs']) {
+            if (fs.existsSync(path.join(srcDir, dir, filename))) {
+                return [...acc, { in: path.join(srcDir, dir, filename), out: dir }];
+            }
+        }
+        return acc;
+    }, []);
+    return base({ port, entryPoints, certDir: certdir, staticDir: outdir });
+};

package/dist/commands/dev/tailwind.js

@@ -0,0 +1,29 @@
+import path from 'path';
+import { PLUGIN_DEVELOPMENT_DIRECTORY } from '../../lib/constants.js';
+import chalk from 'chalk';
+import { getTailwindConfigFromK2Config, watchTailwindCSS } from '../../lib/tailwind.js';
+async function buildTailwindCSS(params) {
+    const { inputFile, outputFileName, config } = params;
+    const inputPath = path.resolve(inputFile);
+    const outputPath = path.join(PLUGIN_DEVELOPMENT_DIRECTORY, outputFileName);
+    return watchTailwindCSS({
+        input: inputPath,
+        output: outputPath,
+        config,
+        onChanges: ({ input, output, type }) => {
+            const outputFileName = path.basename(output);
+            console.log(chalk.hex('#e5e7eb')(`${new Date().toLocaleTimeString()} `) +
+                chalk.cyan(`[css] `) +
+                outputFileName +
+                (type === 'init' ? ' init' : ` rebuilt`));
+        },
+    });
+}
+export const watchCss = async (k2Config) => {
+    if (!k2Config.tailwind?.css || !k2Config.tailwind?.config) {
+        return;
+    }
+    const tailwindConfig = await getTailwindConfigFromK2Config(k2Config.tailwind);
+    const inputFile = path.resolve(k2Config.tailwind.css);
+    return buildTailwindCSS({ inputFile, outputFileName: 'styles.css', config: tailwindConfig });
+};

package/dist/commands/plugin-build.js

@@ -18,6 +18,7 @@ export async function action() {
         const config = await importPluginConfig();
         if (config?.lint?.build) {
             await lint();
+            console.log('✨ Lint success.');
         }
         if (!fs.existsSync(PLUGIN_CONTENTS_DIRECTORY)) {
             await fs.mkdir(PLUGIN_CONTENTS_DIRECTORY, { recursive: true });

package/dist/commands/plugin-dev/index.js

@@ -1,11 +1,12 @@
 import { program } from 'commander';
-import { importPluginConfig } from '../../lib/import.js';
+import fs from 'fs-extra';
 import path from 'path';
 import { DEFAULT_PORT, PLUGIN_DEVELOPMENT_DIRECTORY, PLUGIN_WORKSPACE_DIRECTORY, } from '../../lib/constants.js';
+import { importPluginConfig } from '../../lib/import.js';
 import base from '../dev-base-esbuild.js';
 import { getManifest } from './create-manifest.js';
-import { watchContentsAndUploadZip } from './upload.js';
 import { watchCss } from './tailwind.js';
+import { watchContentsAndUploadZip } from './upload.js';
 export default function command() {
     program
         .command('dev')
@@ -18,6 +19,9 @@ export async function action(options) {
     try {
         const { ppk: ppkPath } = options;
         const config = await importPluginConfig();
+        if (!fs.existsSync(PLUGIN_DEVELOPMENT_DIRECTORY)) {
+            await fs.mkdir(PLUGIN_DEVELOPMENT_DIRECTORY, { recursive: true });
+        }
         const port = config.server?.port ?? DEFAULT_PORT;
         const manifest = await getManifest({ config, port });
         console.log(`📝 manifest.json generated`);

package/dist/commands/plugin-dev/tailwind.js

@@ -1,43 +1,23 @@
 import path from 'path';
 import { PLUGIN_DEVELOPMENT_DIRECTORY } from '../../lib/constants.js';
-import chokidar from 'chokidar';
 import chalk from 'chalk';
-import { getTailwindConfig, outputCss } from '../../lib/tailwind.js';
+import { getTailwindConfig, watchTailwindCSS } from '../../lib/tailwind.js';
 async function buildTailwindCSS(params) {
     const { inputFile, outputFileName, config } = params;
     const inputPath = path.resolve(inputFile);
     const outputPath = path.join(PLUGIN_DEVELOPMENT_DIRECTORY, outputFileName);
-    const watcher = chokidar.watch([...(config.content ?? ['./src/**/*.{ts,tsx}']), inputPath], {
-        ignored: /node_modules/,
-        persistent: true,
-        awaitWriteFinish: {
-            stabilityThreshold: 2000,
-            pollInterval: 100,
-        },
-    });
-    let initialScanComplete = false;
-    const listener = async (type, path) => {
-        try {
-            if (type === 'add' && !initialScanComplete) {
-                return;
-            }
-            await outputCss({ inputPath, outputPath, config });
+    return watchTailwindCSS({
+        input: inputPath,
+        output: outputPath,
+        config,
+        onChanges: ({ output, type }) => {
+            const outputFileName = path.basename(output);
             console.log(chalk.hex('#e5e7eb')(`${new Date().toLocaleTimeString()} `) +
                 chalk.cyan(`[css] `) +
                 outputFileName +
                 (type === 'init' ? ' init' : ` rebuilt`));
-        }
-        catch (error) {
-            console.error('Error building Tailwind CSS:', error);
-        }
-    };
-    watcher.on('ready', async () => {
-        initialScanComplete = true;
-        await listener('init');
+        },
     });
-    watcher.on('change', (path) => listener('change', path));
-    watcher.on('add', (path) => listener('add', path));
-    watcher.on('unlink', () => listener('unlink'));
 }
 export const watchCss = async (pluginConfig) => {
     if (!pluginConfig.tailwind?.css || !pluginConfig.tailwind?.config) {

package/dist/index.js

@@ -2,7 +2,7 @@
 import { program } from 'commander';
 import build from './commands/build.js';
 import viteBuild from './commands/build-vite.js';
-import dev from './commands/dev.js';
+import dev from './commands/dev/index.js';
 import viteDev from './commands/dev-vite.js';
 import genkey from './commands/genkey.js';
 import esbuildBuild from './commands/build-esbuild.js';

package/dist/lib/constants.js

@@ -1,6 +1,8 @@
 import path from 'path';
 export const WORKSPACE_DIRECTORY = '.k2';
 export const DEVELOPMENT_DIRECTORY = path.join(WORKSPACE_DIRECTORY, 'dev');
+export const CONFIG_FILE_NAME = 'k2.config.mjs';
+export const PLUGIN_CONFIG_FILE_NAME = 'plugin.config.mjs';
 /** kintoneプラグインの一時ファイルを管理するフォルダ */
 export const PLUGIN_WORKSPACE_DIRECTORY = '.plugin';
 /** kintoneプラグインのcontents.zipに格納するファイルを管理するフォルダ */

package/dist/lib/import.js

@@ -1,4 +1,5 @@
 import { pathToFileURL } from 'url';
+import { CONFIG_FILE_NAME, PLUGIN_CONFIG_FILE_NAME } from './constants.js';
 export const esmImport = (path) => {
     if (process.platform === 'win32') {
         return import(pathToFileURL(path).toString());
@@ -7,6 +8,9 @@ export const esmImport = (path) => {
         return import(path);
     }
 };
-export const importPluginConfig = async () => {
-    return (await esmImport('plugin.config.mjs')).default;
+export const importK2Config = async (configFileName) => {
+    return (await esmImport(configFileName ?? CONFIG_FILE_NAME)).default;
+};
+export const importPluginConfig = async (configFileName) => {
+    return (await esmImport(configFileName ?? PLUGIN_CONFIG_FILE_NAME)).default;
 };

package/dist/lib/tailwind.js

@@ -5,6 +5,12 @@ import postcss from 'postcss';
 import tailwindcss from 'tailwindcss';
 import invariant from 'tiny-invariant';
 import { esmImport } from './import.js';
+import chokidar from 'chokidar';
+export const getTailwindConfigFromK2Config = async (k2Config) => {
+    invariant(k2Config?.config, 'tailwind.config is required');
+    const config = (await esmImport(path.resolve(k2Config?.config))).default;
+    return config;
+};
 export const getTailwindConfig = async (config) => {
     invariant(config?.config, 'tailwind.config is required');
     const { config: configPath } = config;
@@ -26,3 +32,36 @@ export const outputCss = async (params) => {
         await fs.writeFile(`${outputPath}.map`, result.map.toString());
     }
 };
+export const watchTailwindCSS = async (params) => {
+    const { input, output, config } = params;
+    const watcher = chokidar.watch([...(config.content ?? ['./src/**/*.{ts,tsx}']), input], {
+        ignored: /node_modules/,
+        persistent: true,
+        awaitWriteFinish: {
+            stabilityThreshold: 2000,
+            pollInterval: 100,
+        },
+    });
+    let initialScanComplete = false;
+    const listener = async (type, path) => {
+        try {
+            if (type === 'add' && !initialScanComplete) {
+                return;
+            }
+            await outputCss({ inputPath: input, outputPath: output, config });
+            if (params.onChanges) {
+                params.onChanges({ input, output, type });
+            }
+        }
+        catch (error) {
+            console.error('Error building Tailwind CSS:', error);
+        }
+    };
+    watcher.on('ready', async () => {
+        initialScanComplete = true;
+        await listener('init');
+    });
+    watcher.on('change', (path) => listener('change', path));
+    watcher.on('add', (path) => listener('add', path));
+    watcher.on('unlink', () => listener('unlink'));
+};

package/dist/lib/zip.js

@@ -1,6 +1,7 @@
 import archiver from 'archiver';
 import fs from 'fs-extra';
 import path from 'path';
+import invariant from 'tiny-invariant';
 import { PLUGIN_CONTENTS_DIRECTORY, PLUGIN_WORKSPACE_DIRECTORY } from './constants.js';
 export const outputContentsZip = async (manifest) => {
     const archive = archiver('zip', { zlib: { level: 9 } });
@@ -9,13 +10,9 @@ export const outputContentsZip = async (manifest) => {
     const filterLocalContent = (file) => {
         return !/^https?:\/\//.test(file);
     };
-    archive.file(path.join(PLUGIN_CONTENTS_DIRECTORY, 'manifest.json'), {
-        name: 'manifest.json',
-    });
-    if (!manifest.config) {
-        throw new Error('manifest.config is required');
-    }
+    invariant(manifest.config?.html, 'manifest.config.html is required');
     const targetFiles = [
+        'manifest.json',
         ...new Set([
             manifest.icon,
             manifest.config.html,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konomi-app/k2",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "kintone sdk",
   "main": "./dist/index.js",
   "type": "module",
@@ -66,4 +66,4 @@
     "@types/html-minifier": "^4",
     "typescript": "*"
   }
-}
+}

package/dist/commands/dev-base.js

@@ -1,35 +0,0 @@
-import express from 'express';
-import fs from 'fs-extra';
-import { createServer } from 'https';
-import path from 'path';
-import { generateCert } from '../lib/cert.js';
-import { buildWithEsbuild } from '../lib/esbuild.js';
-export default function action(params) {
-    const { entryPoints, staticDir, certDir, port } = params;
-    return Promise.all([build({ entryPoints, staticDir }), server({ port, certDir, staticDir })]);
-}
-async function build(params) {
-    const { entryPoints, staticDir: outdir } = params;
-    return buildWithEsbuild({ entryPoints, outdir, watch: true });
-}
-async function server(params) {
-    const { certDir, port, staticDir } = params;
-    const app = express();
-    app.use(express.static(staticDir));
-    const privateKeyPath = path.join(certDir, 'localhost-key.pem');
-    const certificatePath = path.join(certDir, 'localhost-cert.pem');
-    if (!fs.existsSync(privateKeyPath) || !fs.existsSync(certificatePath)) {
-        await generateCert(certDir);
-        console.log('🔑 Certificate generated');
-    }
-    const privateKey = fs.readFileSync(privateKeyPath);
-    const certificate = fs.readFileSync(certificatePath);
-    const server = createServer({ key: privateKey, cert: certificate }, app);
-    const res = server.listen(port);
-    res.on('error', (error) => {
-        console.error(error);
-    });
-    res.on('listening', () => {
-        console.log(`🚀 Server started! https://localhost:${port}`);
-    });
-}

package/dist/commands/dev.js

@@ -1,45 +0,0 @@
-import { program } from 'commander';
-import fs from 'fs-extra';
-import path from 'path';
-import { DEFAULT_PORT, DEVELOPMENT_DIRECTORY, WORKSPACE_DIRECTORY } from '../lib/constants.js';
-import base from './dev-base-esbuild.js';
-export default function command() {
-    program
-        .command('dev')
-        .description('Start development server.')
-        .option('-i, --input <input>', 'Input directory', 'src/apps')
-        .option('-o, --outdir <outdir>', 'Output directory.', DEVELOPMENT_DIRECTORY)
-        .option('-c, --certdir <certdir>', 'Certificate directory', WORKSPACE_DIRECTORY)
-        .option('-p, --port <port>', 'Port number', DEFAULT_PORT.toString())
-        .action(action);
-}
-export async function action(options) {
-    const { certdir, outdir, port, input } = options;
-    console.group('🍳 Start development server');
-    try {
-        console.log(`📂 Output directory: ${outdir}`);
-        console.log(`🔑 Certificate directory: ${certdir}`);
-        const srcDir = path.resolve(input);
-        const dirs = fs.readdirSync(srcDir);
-        const entryPoints = dirs.reduce((acc, dir) => {
-            for (const filename of ['index.ts', 'index.js', 'index.mjs']) {
-                if (fs.existsSync(path.join(srcDir, dir, filename))) {
-                    return [...acc, { in: path.join(srcDir, dir, filename), out: dir }];
-                }
-            }
-            return acc;
-        }, []);
-        await base({
-            port: Number(port),
-            entryPoints,
-            certDir: certdir,
-            staticDir: outdir,
-        });
-    }
-    catch (error) {
-        throw error;
-    }
-    finally {
-        console.groupEnd();
-    }
-}