[TS/JS] Entry point per namespace and reworked 1.x compatible single file build (#7510)

* [TS/JS] Entry point per namespace

* Fix handling of outputpath and array_test

* Attempt to fix generate_code

* Fix cwd for ts in generate_code

* Attempt to fixup bazel and some docs

* Add --ts-flat-files to bazel build to get bundle

* Move to DEFAULT_FLATC_TS_ARGS

* Attempt to add esbuild

* Attempt to use npm instead

* Remove futile attempt to add esbuild

* Attempt to as bazel esbuild

* Shuffle

* Upgrade bazel deps

* Revert failed attempts to get bazel working

* Ignore flatc tests for now

* Add esbuild dependency

* `package.json` Include esbuild

* `WORKSPACE` Add fetching esbuild binary

* Update WORKSPACE

* Unfreeze Lockfile

* Update WORKSPACE

* Update BUILD.bazel

* Rework to suggest instead of running external bundler

* Add esbuild generation to test script

* Prelim bundle test

* Run test JavaScriptTest from flatbuffers 1.x

* Deps upgrade

* Clang format fix

* Revert bazel changes

* Fix newline

* Generate with type declarations

* Handle "empty" root namespace

* Adjust tests for typescript_keywords.ts

* Separate test procedure for old node resolution module output

* Fix rel path for root level re-exports

* Bazel support for esbuild-based flatc

Unfortunately, we lose typing information because the new esbuild method
of generating single files does not generate type information.

The method used here is a bit hack-ish because it relies on parsing the
console output of flatc to figure out what to do.

* Try to fix bazel build for when node isn't present on host

* Auto formatting fixes

* Fix missing generated code

Co-authored-by: Derek Bailey <derekbailey@google.com>
Co-authored-by: James Kuszmaul <jabukuszmaul+collab@gmail.com>
This commit is contained in:
Björn Harrtell
2023-01-21 21:22:22 +01:00
committed by GitHub
parent 1703662285
commit ef76b5ece4
249 changed files with 11509 additions and 15906 deletions

View File

@@ -3,8 +3,7 @@ Rules for building typescript flatbuffers with Bazel.
"""
load("@build_bazel_rules_nodejs//:index.bzl", "js_library")
load("@npm//@bazel/typescript:index.bzl", "ts_project")
load(":build_defs.bzl", "DEFAULT_INCLUDE_PATHS", "flatbuffer_library_public")
load(":build_defs.bzl", "flatbuffer_library_public")
DEFAULT_FLATC_TS_ARGS = [
"--gen-object-api",
@@ -21,11 +20,10 @@ def flatbuffer_ts_library(
compatible_with = None,
target_compatible_with = None,
deps = [],
include_paths = DEFAULT_INCLUDE_PATHS,
include_paths = None,
flatc_args = DEFAULT_FLATC_TS_ARGS,
visibility = None,
restricted_to = None,
include_reflection = True,
gen_reflections = False,
package_name = None):
"""Generates a ts_library rule for a given flatbuffer definition.
@@ -46,9 +44,6 @@ def flatbuffer_ts_library(
for, instead of default-supported environments.
target_compatible_with: Optional, The list of target platform constraints
to use.
include_reflection: Optional, Whether to depend on the flatbuffer
reflection library automatically. Only really relevant for the
target that builds the reflection library itself.
gen_reflections: Optional, if true this will generate the flatbuffer
reflection binaries for the schemas.
package_name: Optional, Package name to use for the generated code.
@@ -56,65 +51,26 @@ def flatbuffer_ts_library(
srcs_lib = "%s_srcs" % (name)
out_base = [s.replace(".fbs", "").split("/")[-1].split(":")[-1] for s in srcs]
# Because of how we have to manage the bazel rules for typescript,
# reflection has to get special-cased to get imported when
# run within bazel. As such, generate the code using the _pregenerate
# suffix; then do a find/replace to fix-up all the reflection imports.
pre_outs = ["%s_pregenerated.ts" % s for s in out_base]
outs = ["%s_generated.ts" % s for s in out_base]
if len(srcs) != 1:
fail("flatbuffer_ts_library only supports one .fbs file per target currently.")
outs = ["%s_generated.cjs" % s for s in out_base]
includes = [d + "_includes" for d in deps]
reflection_name = "%s_reflection" % name if gen_reflections else ""
flatbuffer_library_public(
name = srcs_lib,
srcs = srcs,
outs = pre_outs,
outs = outs,
language_flag = "--ts",
includes = includes,
include_paths = include_paths,
flatc_args = flatc_args + ["--filename-suffix _pregenerated"],
flatc_args = flatc_args + ["--filename-suffix _generated"],
compatible_with = compatible_with,
restricted_to = restricted_to,
reflection_name = reflection_name,
reflection_visibility = visibility,
target_compatible_with = target_compatible_with,
)
fix_import_cmd = " ".join([
"SRCS=($(SRCS));",
"OUTS=($(OUTS));",
"for i in $${!SRCS[@]}; do",
"sed \"s/'.*reflection\\/reflection_pregenerated/'flatbuffers_reflection\\/reflection_generated/; s/_pregenerated/_generated/\" $${SRCS[i]} > $${OUTS[i]};",
"done",
])
native.genrule(
name = name + "_reimporter",
srcs = pre_outs,
outs = outs,
cmd = fix_import_cmd,
)
ts_project(
name = name + "_ts",
srcs = outs,
declaration = True,
visibility = visibility,
compatible_with = compatible_with,
restricted_to = restricted_to,
target_compatible_with = target_compatible_with,
tsconfig = {
"compilerOptions": {
"declaration": True,
"lib": [
"ES2015",
"ES2020.BigInt",
"DOM",
],
"module": "commonjs",
"moduleResolution": "node",
"noUnusedLocals": True,
"strict": True,
"types": ["node"],
},
},
deps = deps + ["@com_github_google_flatbuffers//ts:flatbuffers"] + (["@com_github_google_flatbuffers//reflection/ts:reflection_ts_fbs"] if include_reflection else []),
flatc_path = "@com_github_google_flatbuffers//ts:compile_flat_file",
)
js_library(
name = name,
@@ -122,7 +78,7 @@ def flatbuffer_ts_library(
compatible_with = compatible_with,
restricted_to = restricted_to,
target_compatible_with = target_compatible_with,
deps = [name + "_ts"],
srcs = outs,
package_name = package_name,
)
native.filegroup(