diff --git a/gazelle/js/README.md b/gazelle/js/README.md new file mode 100644 index 000000000..75f660f7e --- /dev/null +++ b/gazelle/js/README.md @@ -0,0 +1,20 @@ +# JavaScript/TypeScript BUILD file generation + +This package automates the creation and maintenance of BUILD files for JavaScript and TypeScript, using [rules_js](https://github.com/aspect-build/rules_js) and [rules_ts](https://github.com/aspect-build/rules_ts). It is a [Gazelle](https://github.com/bazelbuild/bazel-gazelle) `Language` implementation. + +## Usage + +This feature is included in the [Aspect CLI](https://github.com/aspect-build/aspect-cli), accessed with the [`configure` command](https://docs.aspect.build/v/cli/commands/aspect_configure). +It's also possible to build into your own Gazelle binary. + +## Rules + +Generated targets include: + +- `ts_project` targets for source, tests, and custom targets and their ts/js/npm dependencies +- `npm_package` targets for projects within a pnpm workspace +- `npm_link_all_packages` for linking npm packages + +### Directives + +See [Aspect CLI Directives](/cli/core/docs/help/topics/directives.md#JavaScript) for a list of supported directives. diff --git a/gazelle/kotlin/README.md b/gazelle/kotlin/README.md new file mode 100644 index 000000000..68d080de8 --- /dev/null +++ b/gazelle/kotlin/README.md @@ -0,0 +1,5 @@ +# Kotlin Gazelle Extension + +EXPERIMENTAL: This is a work in progress and is not yet ready for use. Work is ongoing including upcoming support for rules_jvm maven dependencies. + +This is a [Gazelle](https://github.com/bazelbuild/bazel-gazelle) `Language` implementation for Kotlin using the [rules_kotlin](https://github.com/bazelbuild/rules_kotlin) `jvm` rules.