@gjsify/esbuild-plugin-gjsify 0.0.2 → 0.0.4

package/dist/types/lib/index.d.ts

@@ -1,2 +1 @@
-export * from './cjs.js';
-export * from './esm.js';
+export * from './lib.js';

package/dist/types/lib/{cjs.d.ts → lib.d.ts}

@@ -1,3 +1,3 @@
 import type { PluginBuild } from "esbuild";
 import type { PluginOptions } from '../types/plugin-options.js';
-export declare const setupCjsLib: (build: PluginBuild, pluginOptions: PluginOptions) => Promise<void>;
+export declare const setupLib: (build: PluginBuild, pluginOptions: PluginOptions) => Promise<void>;

package/dist/types/types/plugin-options.d.ts

@@ -7,7 +7,7 @@ export interface PluginOptions extends DeepkitPluginOptions {
     /** An array of glob patterns to exclude matches and aliases */
     exclude?: string[];
     jsExtension?: string;
-    /** Override the format, only be considered if the target app platform is `'node'`, otherwise it is always `'esm'` */
+    /** Override the format */
     format?: 'esm' | 'cjs';
     /**
      * Library Mode

package/dist/types/utils/extension.d.ts

@@ -1,4 +1,4 @@
-export declare const getJsExtensions: (allowExt: string) => {
+export declare const getJsExtensions: (allowExt?: string) => {
     '.js': string;
     '.ts': string;
     '.mts': string;

package/esbuild.mjs

@@ -17,6 +17,7 @@ const baseConfig = {
     entryPoints: ['src/index.ts'],
     bundle: true,
     minify: false,
+    platform: "node",
     external: [
         ...EXTERNALS_NODE,
         'typescript',
@@ -35,7 +36,6 @@ if (pkg.main) {
         outdir: dirname(pkg.main),
         format: 'cjs',
         outExtension: {'.js': extname(pkg.main)},
-        platform: "node",
     });    
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjsify/esbuild-plugin-gjsify",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Deepkit type compiler plugin for esbuild",
   "type": "module",
   "main": "dist/cjs/index.cjs",
@@ -12,7 +12,7 @@
     "test": "yarn print:name && echo 'nothing to do'",
     "build": "yarn print:name && yarn build:js && yarn build:types",
     "build:js": "node esbuild.mjs",
-    "build:types": "tsc --emitDeclarationOnly || exit 0"
+    "build:types": "tsc --project ./tsconfig.json"
   },
   "keywords": [
     "gjs",
@@ -20,27 +20,15 @@
     "esbuild"
   ],
   "dependencies": {
-    "@gjsify/esbuild-plugin-deepkit": "^0.0.2",
-    "@gjsify/esbuild-plugin-deno-loader": "^0.0.2",
-    "@gjsify/esbuild-plugin-transform-ext": "^0.0.2",
-    "assert": "^2.0.0",
-    "constants-browserify": "^1.0.0",
-    "core-js": "^3.31.0",
-    "crypto-browserify": "^3.12.0",
-    "esm": "^3.2.25",
-    "fast-glob": "^3.2.12",
-    "lodash": "^4.17.21",
-    "micromatch": "^4.0.5",
-    "path-browserify": "^1.0.1",
-    "punycode": "^2.3.0",
-    "stream-browserify": "^3.0.0",
-    "string_decoder": "^1.3.0",
-    "test": "^3.3.0"
+    "@gjsify/esbuild-plugin-alias": "^0.0.4",
+    "@gjsify/esbuild-plugin-deepkit": "^0.0.4",
+    "@gjsify/esbuild-plugin-deno-loader": "^0.0.4",
+    "@gjsify/esbuild-plugin-transform-ext": "^0.0.4",
+    "fast-glob": "^3.3.2",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@types/lodash": "^4.14.195",
-    "@types/micromatch": "^4.0.2",
-    "esbuild": "^0.18.2",
-    "typescript": "^5.1.3"
+    "esbuild": "^0.19.10",
+    "typescript": "^5.3.3"
   }
 }

package/src/app/browser.ts

@@ -1,4 +1,4 @@
-import { aliasPlugin } from '../alias-plugin.js';
+import { aliasPlugin } from '@gjsify/esbuild-plugin-alias';
 import { denoPlugin } from '@gjsify/esbuild-plugin-deno-loader';
 import * as deepkitPlugin from '@gjsify/esbuild-plugin-deepkit';
 import { merge } from "lodash";

package/src/app/deno.ts

@@ -1,4 +1,4 @@
-import { aliasPlugin } from '../alias-plugin.js';
+import { aliasPlugin } from '@gjsify/esbuild-plugin-alias';
 import { denoPlugin } from '@gjsify/esbuild-plugin-deno-loader';
 import * as deepkitPlugin from '@gjsify/esbuild-plugin-deepkit';
 import { merge } from "lodash";
@@ -11,13 +11,16 @@ import { getAliasesForDeno, globToEntryPoints } from "../utils/index.js";
 export const setupForDeno = async (build: PluginBuild, pluginOptions: PluginOptions) => {
 
     const external = [];
+    const format = pluginOptions.format || 'esm';
+
+    if(format !== 'esm') throw new TypeError('Only ESM format is supported for Deno');
 
     pluginOptions.aliases ||= {};
     pluginOptions.exclude ||= [];
 
     // Set default options
     const esbuildOptions: BuildOptions = {
-        format: 'esm',
+        format, // Only 'esm' is supported for Deno
         bundle: true,
         minify: false,
         sourcemap: false,

package/src/app/gjs.ts

@@ -1,4 +1,4 @@
-import { aliasPlugin } from '../alias-plugin.js';
+import { aliasPlugin } from '@gjsify/esbuild-plugin-alias';
 import { denoPlugin } from '@gjsify/esbuild-plugin-deno-loader';
 import * as deepkitPlugin from '@gjsify/esbuild-plugin-deepkit';
 import { merge } from "lodash";
@@ -11,15 +11,16 @@ import type { PluginOptions } from '../types/plugin-options.js';
 export const setupForGjs = async (build: PluginBuild, pluginOptions: PluginOptions) => {
 
     const external = ['gi://*', 'cairo', 'gettext', 'system'];
+    const format = pluginOptions.format || 'esm';
 
     pluginOptions.aliases ||= {};
     pluginOptions.exclude ||= [];
 
     // Set default options
     const esbuildOptions: BuildOptions = {
-        format: 'esm', // On Gjs we only support esm
+        format, 
         bundle: true,
-        metafile: true,
+        metafile: false,
         minify: false,
         sourcemap: false,
         treeShaking: true,
@@ -30,10 +31,10 @@ export const setupForGjs = async (build: PluginBuild, pluginOptions: PluginOptio
         // firefox91  // Since GJS 1.71.1
         // firefox102 // Since GJS 1.73.2
         target: [ "firefox102" ],
-        platform: "neutral",
-        mainFields: ['module', 'main'],
+        platform: 'neutral',
+        mainFields: format === 'esm' ? ['module', 'main'] : ['main', 'module'],
         // https://esbuild.github.io/api/#conditions
-        conditions: ['module','import'],
+        conditions: format === 'esm' ? ['import', 'require'] : ['require', 'import'],
         external,
         loader: {
             '.ts': 'ts',

package/src/app/node.ts

@@ -1,5 +1,4 @@
-
-import { aliasPlugin } from '../alias-plugin.js';
+import { aliasPlugin } from '@gjsify/esbuild-plugin-alias';
 import { denoPlugin } from '@gjsify/esbuild-plugin-deno-loader';
 import * as deepkitPlugin from '@gjsify/esbuild-plugin-deepkit';
 import { merge } from "lodash";
@@ -13,12 +12,11 @@ import type { PluginOptions } from '../types/plugin-options.js';
 export const setupForNode = async (build: PluginBuild, pluginOptions: PluginOptions) => {
 
     const external = [...EXTERNALS_NODE, 'gi://*'];
+    const format = pluginOptions.format || 'esm';
 
     pluginOptions.aliases ||= {};
     pluginOptions.exclude ||= [];
 
-    const format = pluginOptions.format || 'esm';
-
     // Set default options
     const esbuildOptions: BuildOptions = {
         format,
@@ -29,7 +27,7 @@ export const setupForNode = async (build: PluginBuild, pluginOptions: PluginOpti
         preserveSymlinks: false, // false means follow symlinks
         target: [ "node18" ],
         platform: "node",
-        mainFields: format === 'esm' ? ['module', 'main'] : ['main', 'module', 'browser'],
+        mainFields: format === 'esm' ? ['module', 'main', 'browser'] : ['main', 'module', 'browser'],
         conditions: format === 'esm' ? ['module', 'import'] : ['require'],
         external,
         loader: {

package/src/lib/index.ts

@@ -1,2 +1 @@
-export * from './cjs.js';
-export * from './esm.js';
+export * from './lib.js';

package/src/lib/{esm.ts → lib.ts}

@@ -1,4 +1,4 @@
-import { aliasPlugin } from '../alias-plugin.js';
+import { aliasPlugin } from '@gjsify/esbuild-plugin-alias';
 import { transformExtPlugin } from '@gjsify/esbuild-plugin-transform-ext';
 import { merge } from "lodash";
 import { getJsExtensions, globToEntryPoints } from "../utils/index.js";
@@ -7,16 +7,19 @@ import { getJsExtensions, globToEntryPoints } from "../utils/index.js";
 import type { PluginBuild, BuildOptions } from "esbuild";
 import type { PluginOptions } from '../types/plugin-options.js';
 
-export const setupEsmLib = async (build: PluginBuild, pluginOptions: PluginOptions) => {
+export const setupLib = async (build: PluginBuild, pluginOptions: PluginOptions) => {
+
+    const format = pluginOptions.format || 'esm';
 
     pluginOptions.aliases ||= {};
     pluginOptions.exclude ||= [];
 
     const esbuildOptions: BuildOptions = {
+        format,
         bundle: false,
         minify: false,
         sourcemap: false, 
-        splitting: true, // Works only on esm
+        splitting: format === 'esm' ? true : false, // Works only on esm
         loader: {
             '.ts': 'ts',
             '.mts': 'ts',
@@ -29,10 +32,10 @@ export const setupEsmLib = async (build: PluginBuild, pluginOptions: PluginOptio
             '.js': 'ts',
         },
         target: [ "esnext" ],
-        platform: "browser",
+        platform: "neutral",
+        mainFields: format === 'esm' ? ['module', 'main'] : ['main'],
         // https://esbuild.github.io/api/#conditions
-        conditions: ['module','import'],
-        format: 'esm'
+        conditions: format === 'esm' ? ['module','import'] : ['require'],
     };
 
     merge(build.initialOptions, esbuildOptions);

package/src/lodash.d.ts

@@ -0,0 +1,46 @@
+declare module 'lodash' {
+    /**
+     * Recursively merges own and inherited enumerable properties of source
+     * objects into the destination object, skipping source properties that resolve
+     * to `undefined`. Array and plain object properties are merged recursively.
+     * Other objects and value types are overridden by assignment. Source objects
+     * are applied from left to right. Subsequent sources overwrite property
+     * assignments of previous sources.
+     *
+     * **Note:** This method mutates `object`.
+     *
+     * @category Object
+     * @param object The destination object.
+     * @param [sources] The source objects.
+     * @returns Returns `object`.
+     * @example
+     *
+     * var users = {
+     *   'data': [{ 'user': 'barney' }, { 'user': 'fred' }]
+     * };
+     *
+     * var ages = {
+     *   'data': [{ 'age': 36 }, { 'age': 40 }]
+     * };
+     *
+     * _.merge(users, ages);
+     * // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }
+     */
+    function merge<TObject, TSource>(object: TObject, source: TSource): TObject & TSource;
+    /**
+     * @see _.merge
+     */
+    function merge<TObject, TSource1, TSource2>(object: TObject, source1: TSource1, source2: TSource2): TObject & TSource1 & TSource2;
+    /**
+     * @see _.merge
+     */
+    function merge<TObject, TSource1, TSource2, TSource3>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3): TObject & TSource1 & TSource2 & TSource3;
+    /**
+     * @see _.merge
+     */
+    function merge<TObject, TSource1, TSource2, TSource3, TSource4>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4): TObject & TSource1 & TSource2 & TSource3 & TSource4;
+    /**
+     * @see _.merge
+     */
+    function merge(object: any, ...otherArgs: any[]): any;
+}

package/src/plugin.ts

@@ -1,26 +1,24 @@
 import type { Plugin } from "esbuild";
 import type { PluginOptions } from './types/plugin-options.js';
-import { setupCjsLib, setupEsmLib } from './lib/index.js';
+import { setupLib } from './lib/index.js';
 import { setupForGjs, setupForNode, setupForDeno, setupForBrowser } from './app/index.js';
 
 export const gjsifyPlugin = (pluginOptions: PluginOptions = {}) => {
     const plugin: Plugin = {
         name: 'gjsify',
         async setup(build) {
-
             // Library mode
             if(pluginOptions.library) {
                 switch (pluginOptions.library) {
                     case 'esm':
-                        return setupEsmLib(build, pluginOptions)
                     case 'cjs':
-                        return setupCjsLib(build, pluginOptions)
+                        return setupLib(build, pluginOptions)
                     default:
                         throw new TypeError('Unknown library type: ' + pluginOptions.library);
                 }
             }
 
-            pluginOptions.app ||= 'gjs';
+            pluginOptions.app ||= 'gjs'
             
             // End user applications or tests
             switch (pluginOptions.app) {

package/src/types/plugin-options.ts

@@ -8,7 +8,7 @@ export interface PluginOptions extends DeepkitPluginOptions {
     /** An array of glob patterns to exclude matches and aliases */
     exclude?: string[];
     jsExtension?: string;
-    /** Override the format, only be considered if the target app platform is `'node'`, otherwise it is always `'esm'` */
+    /** Override the format */
     format?: 'esm' | 'cjs'
     /** 
      * Library Mode

package/src/utils/extension.ts

@@ -1,6 +1,6 @@
-export const getJsExtensions = (allowExt: string) => {
+export const getJsExtensions = (allowExt?: string) => {
     const extensions = {'.js': '.js', '.ts': '.js', '.mts': '.js', '.cts': '.js', '.cjs': '.js', '.mjs': '.js'};
-    if(extensions[allowExt]) {
+    if(allowExt && extensions[allowExt]) {
         delete extensions[allowExt]
     }
     return extensions;

package/tsconfig.json

@@ -3,11 +3,15 @@
     "module": "ESNext",
     "target": "ESNext",
     "outDir": "dist",
+    "types": ["node"],
+    "lib": ["ESNext", "DOM"],
     "declarationDir": "dist/types",
     "declaration": true,
+    "emitDeclarationOnly": true,
     "allowSyntheticDefaultImports": true,
     "moduleResolution": "bundler",
     "allowImportingTsExtensions": true
   },
+  "include": ["src/lodash.d.ts"],
   "files": ["src/index.ts"]
 }

package/dist/types/debug-plugin.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "esbuild";
-export declare const debugPlugin: () => Plugin;

package/dist/types/lib/esm.d.ts

@@ -1,3 +0,0 @@
-import type { PluginBuild } from "esbuild";
-import type { PluginOptions } from '../types/plugin-options.js';
-export declare const setupEsmLib: (build: PluginBuild, pluginOptions: PluginOptions) => Promise<void>;

package/src/alias-plugin.ts

@@ -1,68 +0,0 @@
-import { existsSync } from "fs";
-import { realpath } from "fs/promises";
-
-import type { Plugin } from "esbuild";
-
-export const aliasPlugin = (aliasObj: Record<string, string>) => {
-  const aliases = Object.keys(aliasObj);
-  const re = new RegExp(`^(${aliases.map(x => escapeRegExp(x)).join('|')})$`);
-
-  const plugin: Plugin = {
-    name: 'alias',
-    setup(build) {
-      // we do not register 'file' namespace here, because the root file won't be processed
-      // https://github.com/evanw/esbuild/issues/791
-      build.onResolve({ filter: re }, async (args) => {
-        let resolvedAliasPath = aliasObj[args.path];
-
-        let namespace = args.namespace;
-
-        if (resolvedAliasPath) {
-
-          if (resolvedAliasPath.startsWith('http://')) {
-            namespace = 'http';
-            resolvedAliasPath = resolvedAliasPath.slice(5)
-          } else if (resolvedAliasPath.startsWith('https://')) {
-            namespace = 'https';
-            resolvedAliasPath = resolvedAliasPath.slice(6)
-          } else {
-            const resolvedAlias = (await build.resolve(resolvedAliasPath, {
-              importer: args.importer,
-              kind: args.kind,
-              namespace: namespace,
-              resolveDir: args.resolveDir,
-              pluginData: args.pluginData,
-            }));
-
-            if (resolvedAlias.errors) {
-              return resolvedAlias;
-            } else {
-              resolvedAliasPath = resolvedAlias.path;
-              namespace = resolvedAlias.namespace;
-            }
-          }
-
-          if (existsSync(resolvedAliasPath)) {
-            resolvedAliasPath = await realpath(resolvedAliasPath);
-          }
-
-          // console.debug(`resolvedAliasPath: ${args.path} -> ${resolvedAliasPath}`);
-
-          return {
-            path: resolvedAliasPath,
-            namespace: namespace,
-          }
-        }
-
-        return null;
-      });
-    },
-  };
-
-  return plugin;
-};
-
-function escapeRegExp(str: string) {
-  // $& means the whole matched string
-  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}

package/src/lib/cjs.ts

@@ -1,46 +0,0 @@
-import { aliasPlugin } from '../alias-plugin.js';
-import { transformExtPlugin } from '@gjsify/esbuild-plugin-transform-ext';
-import { merge } from "lodash";
-import { getJsExtensions, globToEntryPoints } from "../utils/index.js";
-
-// Types
-import type { PluginBuild, BuildOptions } from "esbuild";
-import type { PluginOptions } from '../types/plugin-options.js';
-
-export const setupCjsLib = async (build: PluginBuild, pluginOptions: PluginOptions) => {
-
-    pluginOptions.aliases ||= {};
-    pluginOptions.exclude ||= [];
-
-    const esbuildOptions: BuildOptions = {
-        bundle: false,
-        splitting: false, // only works with esm, see https://esbuild.github.io/api/#splitting
-        minify: false,
-        sourcemap: false,
-        loader: {
-            '.ts': 'ts',
-            '.mts': 'ts',
-            '.cts': 'ts',
-            '.tsx': 'ts',
-            '.mtsx': 'ts',
-            '.ctsx': 'ts',
-            '.mjs': 'ts',
-            '.cjs': 'ts',
-            '.js': 'ts',
-        },
-        target: ['esnext'],
-        platform: "browser",
-        // https://esbuild.github.io/api/#conditions
-        conditions: ['require'],
-        format: 'cjs'
-    };
-
-    merge(build.initialOptions, esbuildOptions);
-
-    build.initialOptions.entryPoints = await globToEntryPoints(build.initialOptions.entryPoints, pluginOptions.exclude)
-
-    if(pluginOptions.debug) console.debug("initialOptions", build.initialOptions);
-
-    await aliasPlugin(pluginOptions.aliases).setup(build);
-    await transformExtPlugin({ outExtension: getJsExtensions(pluginOptions.jsExtension) }).setup(build);
-}