Skip to content

Commit

Permalink
chore: bump to latest stardoc (#149)
Browse files Browse the repository at this point in the history
  • Loading branch information
gregmagolan authored Apr 28, 2024
1 parent 10f49a1 commit d2b5a42
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 29 deletions.
1 change: 1 addition & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ bazel_dep(name = "bazel_skylib_gazelle_plugin", version = "1.5.0", dev_dependenc
bazel_dep(name = "buildifier_prebuilt", version = "6.4.0", dev_dependency = True)
bazel_dep(name = "gazelle", version = "0.36.0", dev_dependency = True, repo_name = "bazel_gazelle")
bazel_dep(name = "rules_go", version = "0.46.0", dev_dependency = True)
bazel_dep(name = "stardoc", version = "0.6.2", dev_dependency = True, repo_name = "io_bazel_stardoc")
22 changes: 22 additions & 0 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,28 @@ go_register_toolchains(version = "1.19.3")

gazelle_dependencies()

############################################
# Stardoc
load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")

stardoc_repositories()

load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")

rules_jvm_external_deps()

load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")

rules_jvm_external_setup()

load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")

stardoc_external_deps()

load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")

stardoc_pinned_maven_install()

# Buildifier
load("@buildifier_prebuilt//:deps.bzl", "buildifier_prebuilt_deps")

Expand Down
53 changes: 26 additions & 27 deletions docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Public API surface is re-exported here.

Users should not load files under "/internal"


<a id="webpack_bundle"></a>

## webpack_bundle
Expand All @@ -23,21 +22,21 @@ Runs the webpack-cli under bazel
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="webpack_bundle-name"></a>name | A unique name for this target. | none |
| <a id="webpack_bundle-node_modules"></a>node_modules | Label pointing to the linked node_modules target where webpack is linked, e.g. <code>//:node_modules</code>.<br><br>The following packages must be linked into the node_modules supplied:<br><br> webpack, webpack-cli | none |
| <a id="webpack_bundle-srcs"></a>srcs | Non-entry point JavaScript source files from the workspace.<br><br>You must not repeat file(s) passed to entry_point/entry_points. | <code>[]</code> |
| <a id="webpack_bundle-args"></a>args | Command line arguments to pass to Webpack.<br><br>These argument passed on the command line before arguments that are added by the rule. Run <code>bazel</code> with <code>--subcommands</code> to see what Webpack CLI command line was invoked.<br><br>See the [Webpack CLI docs](https://webpack.js.org/api/cli/) for a complete list of supported arguments. | <code>[]</code> |
| <a id="webpack_bundle-deps"></a>deps | Runtime dependencies which may be loaded during compilation. | <code>[]</code> |
| <a id="webpack_bundle-chdir"></a>chdir | Working directory to run Webpack under.<br><br>This is needed to workaround some buggy resolvers in webpack loaders, which assume that the node_modules tree is located in a parent of the working directory rather than a parent of the script with the require statement.<br><br>Note that any relative paths in your configuration may need to be adjusted so they are relative to the new working directory.<br><br>See also: https://github.com/aspect-build/rules_js/blob/main/docs/js_binary.md#js_binary-chdir | <code>None</code> |
| <a id="webpack_bundle-data"></a>data | Runtime dependencies to include in binaries/tests that depend on this target.<br><br>The transitive npm dependencies, transitive sources, default outputs and runfiles of targets in the <code>data</code> attribute are added to the runfiles of this target. They should appear in the '*.runfiles' area of any executable which has a runtime dependency on this target. | <code>[]</code> |
| <a id="webpack_bundle-env"></a>env | Environment variables of the action.<br><br>Subject to <code>$(location)</code> and make variable expansion. | <code>{}</code> |
| <a id="webpack_bundle-output_dir"></a>output_dir | If True, webpack produces an output directory containing all output files. | <code>False</code> |
| <a id="webpack_bundle-entry_point"></a>entry_point | The point where to start the application bundling process.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Exactly one of <code>entry_point</code> to <code>entry_points</code> must be specified if <code>output_dir</code> is <code>False</code>. | <code>None</code> |
| <a id="webpack_bundle-entry_points"></a>entry_points | The map of entry points to bundle names.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Exactly one of <code>entry_point</code> to <code>entry_points</code> must be specified if <code>output_dir</code> is <code>False</code>. | <code>{}</code> |
| <a id="webpack_bundle-webpack_config"></a>webpack_config | Webpack configuration file.<br><br>See https://webpack.js.org/configuration/ | <code>None</code> |
| <a id="webpack_bundle-configure_mode"></a>configure_mode | Configure <code>mode</code> in the generated base webpack config.<br><br><code>mode</code> is set to <code>production</code> if the Bazel compilation mode is <code>opt</code> otherwise it is set to <code>development</code>.<br><br>The configured value will be overridden if it is set in a supplied <code>webpack_config</code>.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | <code>True</code> |
| <a id="webpack_bundle-configure_devtool"></a>configure_devtool | Configure <code>devtool</code> in the generated base webpack config.<br><br><code>devtool</code> is set to <code>eval</code> if the Bazel compilation mode is <code>fastbuild</code>, <code>eval-source-map</code> if the Bazel compilation mode is <code>dbg</code>, otherwise it is left unset.<br><br>The configured value will be overridden if it is set in a supplied <code>webpack_config</code>.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | <code>True</code> |
| <a id="webpack_bundle-use_execroot_entry_point"></a>use_execroot_entry_point | Use the <code>entry_point</code> script of the <code>webpack</code> <code>js_binary</code> that is in the execroot output tree instead of the copy that is in runfiles.<br><br>When set, runfiles are hoisted to the target platform when this is configured and included as target platform execroot inputs to the action.<br><br>Using the entry point script that is in the execroot output tree means that there will be no conflicting runfiles <code>node_modules</code> in the node_modules resolution path which can confuse npm packages such as next and react that don't like being resolved in multiple node_modules trees. This more closely emulates the environment that tools such as Next.js see when they are run outside of Bazel. | <code>True</code> |
| <a id="webpack_bundle-supports_workers"></a>supports_workers | Experimental! Use only with caution.<br><br>Allows you to enable the Bazel Worker strategy for this library. | <code>False</code> |
| <a id="webpack_bundle-node_modules"></a>node_modules | Label pointing to the linked node_modules target where webpack is linked, e.g. `//:node_modules`.<br><br>The following packages must be linked into the node_modules supplied:<br><br> webpack, webpack-cli | none |
| <a id="webpack_bundle-srcs"></a>srcs | Non-entry point JavaScript source files from the workspace.<br><br>You must not repeat file(s) passed to entry_point/entry_points. | `[]` |
| <a id="webpack_bundle-args"></a>args | Command line arguments to pass to Webpack.<br><br>These argument passed on the command line before arguments that are added by the rule. Run `bazel` with `--subcommands` to see what Webpack CLI command line was invoked.<br><br>See the [Webpack CLI docs](https://webpack.js.org/api/cli/) for a complete list of supported arguments. | `[]` |
| <a id="webpack_bundle-deps"></a>deps | Runtime dependencies which may be loaded during compilation. | `[]` |
| <a id="webpack_bundle-chdir"></a>chdir | Working directory to run Webpack under.<br><br>This is needed to workaround some buggy resolvers in webpack loaders, which assume that the node_modules tree is located in a parent of the working directory rather than a parent of the script with the require statement.<br><br>Note that any relative paths in your configuration may need to be adjusted so they are relative to the new working directory.<br><br>See also: https://github.com/aspect-build/rules_js/blob/main/docs/js_binary.md#js_binary-chdir | `None` |
| <a id="webpack_bundle-data"></a>data | Runtime dependencies to include in binaries/tests that depend on this target.<br><br>The transitive npm dependencies, transitive sources, default outputs and runfiles of targets in the `data` attribute are added to the runfiles of this target. They should appear in the '*.runfiles' area of any executable which has a runtime dependency on this target. | `[]` |
| <a id="webpack_bundle-env"></a>env | Environment variables of the action.<br><br>Subject to `$(location)` and make variable expansion. | `{}` |
| <a id="webpack_bundle-output_dir"></a>output_dir | If True, webpack produces an output directory containing all output files. | `False` |
| <a id="webpack_bundle-entry_point"></a>entry_point | The point where to start the application bundling process.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Exactly one of `entry_point` to `entry_points` must be specified if `output_dir` is `False`. | `None` |
| <a id="webpack_bundle-entry_points"></a>entry_points | The map of entry points to bundle names.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Exactly one of `entry_point` to `entry_points` must be specified if `output_dir` is `False`. | `{}` |
| <a id="webpack_bundle-webpack_config"></a>webpack_config | Webpack configuration file.<br><br>See https://webpack.js.org/configuration/ | `None` |
| <a id="webpack_bundle-configure_mode"></a>configure_mode | Configure `mode` in the generated base webpack config.<br><br>`mode` is set to `production` if the Bazel compilation mode is `opt` otherwise it is set to `development`.<br><br>The configured value will be overridden if it is set in a supplied `webpack_config`.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | `True` |
| <a id="webpack_bundle-configure_devtool"></a>configure_devtool | Configure `devtool` in the generated base webpack config.<br><br>`devtool` is set to `eval` if the Bazel compilation mode is `fastbuild`, `eval-source-map` if the Bazel compilation mode is `dbg`, otherwise it is left unset.<br><br>The configured value will be overridden if it is set in a supplied `webpack_config`.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | `True` |
| <a id="webpack_bundle-use_execroot_entry_point"></a>use_execroot_entry_point | Use the `entry_point` script of the `webpack` `js_binary` that is in the execroot output tree instead of the copy that is in runfiles.<br><br>When set, runfiles are hoisted to the target platform when this is configured and included as target platform execroot inputs to the action.<br><br>Using the entry point script that is in the execroot output tree means that there will be no conflicting runfiles `node_modules` in the node_modules resolution path which can confuse npm packages such as next and react that don't like being resolved in multiple node_modules trees. This more closely emulates the environment that tools such as Next.js see when they are run outside of Bazel. | `True` |
| <a id="webpack_bundle-supports_workers"></a>supports_workers | Experimental! Use only with caution.<br><br>Allows you to enable the Bazel Worker strategy for this library. | `False` |
| <a id="webpack_bundle-kwargs"></a>kwargs | Additional arguments | none |


Expand All @@ -63,17 +62,17 @@ under the hood.
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="webpack_devserver-name"></a>name | A unique name for this target. | none |
| <a id="webpack_devserver-node_modules"></a>node_modules | Label pointing to the linked node_modules target where webpack is linked, e.g. <code>//:node_modules</code>.<br><br>The following packages must be linked into the node_modules supplied:<br><br> webpack, webpack-cli, webpack-dev-server | none |
| <a id="webpack_devserver-chdir"></a>chdir | Working directory to run Webpack under.<br><br>This is needed to workaround some buggy resolvers in webpack loaders, which assume that the node_modules tree is located in a parent of the working directory rather than a parent of the script with the require statement.<br><br>Note that any relative paths in your configuration may need to be adjusted so they are relative to the new working directory.<br><br>See also: https://github.com/aspect-build/rules_js/blob/main/docs/js_binary.md#js_binary-chdir | <code>None</code> |
| <a id="webpack_devserver-env"></a>env | Environment variables of the action.<br><br>Subject to <code>$(location)</code> and make variable expansion. | <code>{}</code> |
| <a id="webpack_devserver-entry_point"></a>entry_point | The point where to start the application bundling process.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Only one of <code>entry_point</code> to <code>entry_points</code> must be specified. | <code>None</code> |
| <a id="webpack_devserver-entry_points"></a>entry_points | The map of entry points to bundle names.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Only one of <code>entry_point</code> to <code>entry_points</code> must be specified. | <code>{}</code> |
| <a id="webpack_devserver-webpack_config"></a>webpack_config | Webpack configuration file. See https://webpack.js.org/configuration/. | <code>None</code> |
| <a id="webpack_devserver-configure_mode"></a>configure_mode | Configure <code>mode</code> in the generated base webpack config.<br><br><code>mode</code> is set to <code>production</code> if the Bazel compilation mode is <code>opt</code> otherwise it is set to <code>development</code>.<br><br>The configured value will be overridden if it is set in a supplied <code>webpack_config</code>.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | <code>True</code> |
| <a id="webpack_devserver-configure_devtool"></a>configure_devtool | Configure <code>devtool</code> in the generated base webpack config.<br><br><code>devtool</code> is set to <code>eval</code> if the Bazel compilation mode is <code>fastbuild</code>, <code>eval-source-map</code> if the Bazel compilation mode is <code>dbg</code>, otherwise it is left unset.<br><br>The configured value will be overridden if it is set in a supplied <code>webpack_config</code>.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | <code>True</code> |
| <a id="webpack_devserver-args"></a>args | Additional arguments to pass to webpack.<br><br>The <code>serve</code> command, the webpack config file (<code>--config</code>) and the mode (<code>--mode</code>) are automatically set. | <code>[]</code> |
| <a id="webpack_devserver-data"></a>data | Bundle and runtime dependencies of the program.<br><br>Should include the <code>webpack_bundle</code> rule <code>srcs</code> and <code>deps</code>.<br><br>The webpack config and entry_point[s] are automatically passed to data and should not be repeated. | <code>[]</code> |
| <a id="webpack_devserver-mode"></a>mode | The mode to pass to <code>--mode</code>. | <code>"development"</code> |
| <a id="webpack_devserver-node_modules"></a>node_modules | Label pointing to the linked node_modules target where webpack is linked, e.g. `//:node_modules`.<br><br>The following packages must be linked into the node_modules supplied:<br><br> webpack, webpack-cli, webpack-dev-server | none |
| <a id="webpack_devserver-chdir"></a>chdir | Working directory to run Webpack under.<br><br>This is needed to workaround some buggy resolvers in webpack loaders, which assume that the node_modules tree is located in a parent of the working directory rather than a parent of the script with the require statement.<br><br>Note that any relative paths in your configuration may need to be adjusted so they are relative to the new working directory.<br><br>See also: https://github.com/aspect-build/rules_js/blob/main/docs/js_binary.md#js_binary-chdir | `None` |
| <a id="webpack_devserver-env"></a>env | Environment variables of the action.<br><br>Subject to `$(location)` and make variable expansion. | `{}` |
| <a id="webpack_devserver-entry_point"></a>entry_point | The point where to start the application bundling process.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Only one of `entry_point` to `entry_points` must be specified. | `None` |
| <a id="webpack_devserver-entry_points"></a>entry_points | The map of entry points to bundle names.<br><br>See https://webpack.js.org/concepts/entry-points/<br><br>Only one of `entry_point` to `entry_points` must be specified. | `{}` |
| <a id="webpack_devserver-webpack_config"></a>webpack_config | Webpack configuration file. See https://webpack.js.org/configuration/. | `None` |
| <a id="webpack_devserver-configure_mode"></a>configure_mode | Configure `mode` in the generated base webpack config.<br><br>`mode` is set to `production` if the Bazel compilation mode is `opt` otherwise it is set to `development`.<br><br>The configured value will be overridden if it is set in a supplied `webpack_config`.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | `True` |
| <a id="webpack_devserver-configure_devtool"></a>configure_devtool | Configure `devtool` in the generated base webpack config.<br><br>`devtool` is set to `eval` if the Bazel compilation mode is `fastbuild`, `eval-source-map` if the Bazel compilation mode is `dbg`, otherwise it is left unset.<br><br>The configured value will be overridden if it is set in a supplied `webpack_config`.<br><br>See https://bazel.build/docs/user-manual#compilation-mode for more info on how to configure the compilation mode. | `True` |
| <a id="webpack_devserver-args"></a>args | Additional arguments to pass to webpack.<br><br>The `serve` command, the webpack config file (`--config`) and the mode (`--mode`) are automatically set. | `[]` |
| <a id="webpack_devserver-data"></a>data | Bundle and runtime dependencies of the program.<br><br>Should include the `webpack_bundle` rule `srcs` and `deps`.<br><br>The webpack config and entry_point[s] are automatically passed to data and should not be repeated. | `[]` |
| <a id="webpack_devserver-mode"></a>mode | The mode to pass to `--mode`. | `"development"` |
| <a id="webpack_devserver-kwargs"></a>kwargs | Additional arguments. See [js_run_devserver](https://github.com/aspect-build/rules_js/blob/main/docs/js_run_devserver.md). | none |


4 changes: 2 additions & 2 deletions internal_deps.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ def rules_webpack_internal_deps():

http_archive(
name = "io_bazel_stardoc",
sha256 = "3fd8fec4ddec3c670bd810904e2e33170bedfe12f90adf943508184be458c8bb",
urls = ["https://github.com/bazelbuild/stardoc/releases/download/0.5.3/stardoc-0.5.3.tar.gz"],
sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432",
urls = ["https://github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz"],
)

http_archive(
Expand Down

0 comments on commit d2b5a42

Please sign in to comment.