aboutsummaryrefslogtreecommitdiff
path: root/packages/web-util/src/index.build.ts
blob: c0c5fc179fd529d187809ba18266404349c44ab4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
import esbuild, { PluginBuild } from "esbuild";
import linaria from "@linaria/esbuild";
import fs from "fs";
import path from "path";
import postcss from "postcss";
import sass from "sass";
import postcssrc from "postcss-load-config";

// this should give us the current directory where
// the project is being built
const BASE = process.cwd();

type Assets = {
  base: string;
  files: string[];
};

export function getFilesInDirectory(startPath: string, regex?: RegExp): Assets {
  if (!fs.existsSync(startPath)) {
    return {
      base: startPath,
      files: [],
    };
  }
  const files = fs.readdirSync(startPath);
  const result = files
    .flatMap((file) => {
      const filename = path.join(startPath, file);

      const stat = fs.lstatSync(filename);
      if (stat.isDirectory()) {
        return getFilesInDirectory(filename, regex).files;
      }
      if (!regex || regex.test(filename)) {
        return [filename];
      }
      return [];
    })
    .filter((x) => !!x);

  return {
    base: startPath,
    files: result,
  };
}

let GIT_ROOT = BASE;
while (!fs.existsSync(path.join(GIT_ROOT, ".git")) && GIT_ROOT !== "/") {
  GIT_ROOT = path.join(GIT_ROOT, "../");
}
if (GIT_ROOT === "/") {
  // eslint-disable-next-line no-undef
  console.log("not found");
  // eslint-disable-next-line no-undef
  process.exit(1);
}
const GIT_HASH = git_hash();

const buf = fs.readFileSync(path.join(BASE, "package.json"));
let _package = JSON.parse(buf.toString("utf-8"));

function git_hash() {
  const rev = fs
    .readFileSync(path.join(GIT_ROOT, ".git", "HEAD"))
    .toString()
    .trim()
    .split(/.*[: ]/)
    .slice(-1)[0];
  if (rev.indexOf("/") === -1) {
    return rev;
  } else {
    return fs.readFileSync(path.join(GIT_ROOT, ".git", rev)).toString().trim();
  }
}

// FIXME: Put this into some helper library.
function copyFilesPlugin(assets: Assets | Assets[]) {
  return {
    name: "copy-files",
    setup(build: PluginBuild) {
      if (!assets || (assets instanceof Array && !assets.length)) {
        return;
      }
      const list = assets instanceof Array ? assets : [assets];

      const outDir = build.initialOptions.outdir;
      if (outDir === undefined) {
        throw Error("esbuild build options does not specify outdir");
      }
      build.onEnd(() => {
        list.forEach((as) => {
          for (const file of as.files) {
            const destination = path.join(outDir, path.relative(as.base, file));
            const dirname = path.dirname(destination);
            if (!fs.existsSync(dirname)) {
              fs.mkdirSync(dirname, { recursive: true });
            }
            fs.copyFileSync(file, destination);
          }
        });
      });
    },
  };
}

const DEFAULT_SASS_FILTER = /\.(s[ac]ss|css)$/;

const sassPlugin: esbuild.Plugin = {
  name: "custom-build-sass",
  setup(build) {
    build.onLoad({ filter: DEFAULT_SASS_FILTER }, ({ path: file }) => {
      const resolveDir = path.dirname(file);
      const { css: contents } = sass.compile(file, { loadPaths: ["./"] });

      return {
        resolveDir,
        loader: "css",
        contents,
      };
    });
  },
};


/**
 * Problem: 
 *   No loader is configured for ".node" files: ../../node_modules/.pnpm/fsevents@2.3.3/node_modules/fsevents/fsevents.node
 * 
 * Reference:
 *   https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
 */
const nativeNodeModulesPlugin: esbuild.Plugin = {
  name: 'native-node-modules',
  setup(build) {
    // If a ".node" file is imported within a module in the "file" namespace, resolve 
    // it to an absolute path and put it into the "node-file" virtual namespace.
    build.onResolve({ filter: /\.node$/, namespace: 'file' }, args => ({
      path: require.resolve(args.path, { paths: [args.resolveDir] }),
      namespace: 'node-file',
    }))

    // Files in the "node-file" virtual namespace call "require()" on the
    // path from esbuild of the ".node" file in the output directory.
    build.onLoad({ filter: /.*/, namespace: 'node-file' }, args => ({
      contents: `
        import path from ${JSON.stringify(args.path)}
        try { module.exports = require(path) }
        catch {}
      `,
    }))

    // If a ".node" file is imported within a module in the "node-file" namespace, put
    // it in the "file" namespace where esbuild's default loading behavior will handle
    // it. It is already an absolute path since we resolved it to one above.
    build.onResolve({ filter: /\.node$/, namespace: 'node-file' }, args => ({
      path: args.path,
      namespace: 'file',
    }))

    // Tell esbuild's default loading behavior to use the "file" loader for
    // these ".node" files.
    let opts = build.initialOptions
    opts.loader = opts.loader || {}
    opts.loader['.node'] = 'file'
  },
}


const postCssPlugin: esbuild.Plugin = {
  name: "custom-build-postcss",
  setup(build) {
    build.onLoad({ filter: DEFAULT_SASS_FILTER }, async ({ path: file }) => {
      const resolveDir = path.dirname(file);
      const sourceBuffer = fs.readFileSync(file);
      const source = sourceBuffer.toString("utf-8");
      const postCssConfig = await postcssrc();
      postCssConfig.options.from = file;

      const { css: contents } = await postcss(postCssConfig.plugins).process(
        source,
        postCssConfig.options,
      );

      return {
        resolveDir,
        loader: "css",
        contents,
      };
    });
  },
};

/**
 * This should be able to load the plugin but but some reason it does not work
 *
 *       text: "Cannot find module '../plugins/preeval'\n" +
 *
 */
function linariaPlugin() {
  const linariaCssPlugin: esbuild.Plugin = (linaria as any)({
    babelOptions: {
      presets: ["@babel/preset-typescript", "@babel/preset-react", "@linaria"],
    },
    sourceMap: true,
  });
  return linariaCssPlugin;
}

const defaultEsBuildConfig: esbuild.BuildOptions = {
  bundle: true,
  loader: {
    ".svg": "file",
    ".inline.svg": "text",
    ".png": "dataurl",
    ".jpeg": "dataurl",
    ".ttf": "file",
    ".woff": "file",
    ".woff2": "file",
    ".eot": "file",
  },
  target: ["es2020"],
  format: "esm",
  platform: "browser",
  jsxFactory: "h",
  jsxFragment: "Fragment",
  alias: {
    react: "preact/compat",
    "react-dom": "preact/compat",
  },
  define: {
    __VERSION__: `"${_package.version}"`,
    __GIT_HASH__: `"${GIT_HASH}"`,
  },
};

export interface BuildParams {
  type: "development" | "test" | "production";
  source: {
    assets: Assets | Assets[];
    js: string[];
  };
  public?: string;
  destination: string;
  css: "sass" | "postcss" | "linaria";
  linariaPlugin?: () => esbuild.Plugin;
}

export function computeConfig(params: BuildParams): esbuild.BuildOptions {
  const plugins: Array<esbuild.Plugin> = [
    copyFilesPlugin(params.source.assets),
  ];

  if (params.css) {
    switch (params.css) {
      case "sass": {
        plugins.push(sassPlugin);
        break;
      }
      case "postcss": {
        plugins.push(postCssPlugin);
        break;
      }

      case "linaria": {
        if (params.linariaPlugin) {
          plugins.push(params.linariaPlugin());
        }
        break;
      }

      default: {
        const cssType: never = params.css;
        throw Error(`not supported: ${cssType}`);
      }
    }
  }
  if (!params.type) {
    throw Error(
      `missing build type, it should be "test", "development" or "production"`,
    );
  }

  // if (!params.source.js) {
  //   throw Error(`no javascript entry points, nothing to compile?`);
  // }
  if (!params.destination) {
    throw Error(`missing destination folder`);
  }

  return {
    ...defaultEsBuildConfig,
    entryPoints: params.source.js,
    publicPath: params.public,
    outdir: params.destination,
    minify: false, //params.type === "production",
    sourcemap: true, //params.type !== "production",
    define: {
      ...defaultEsBuildConfig.define,
      "process.env.NODE_ENV": JSON.stringify(params.type),
    },
    plugins,
  };
}

/**
 * Build sources for prod environment
 */
export function build(config: BuildParams) {
  return esbuild.build(computeConfig(config));
}

const LIVE_RELOAD_SCRIPT =
  "./node_modules/@gnu-taler/web-util/lib/live-reload.mjs";

/**
 * Do startup for development environment
 */
export function initializeDev(
  config: BuildParams,
): () => Promise<esbuild.BuildResult> {
  function buildDevelopment() {
    const result = computeConfig(config);
    result.inject = [LIVE_RELOAD_SCRIPT];
    return esbuild.build(result);
  }
  return buildDevelopment;
}