diff options
author | c-parsons <cparsons@google.com> | 2018-09-28 09:09:18 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-09-28 09:09:18 -0400 |
commit | 6e2d7e4a75b8ec0c307cf2ff2ca3d837633413ca (patch) | |
tree | e637ecb29b736e80c3b26ce296e1d503781ca448 /skylark_library.bzl | |
parent | 1099dd2d0a80649700e3dff0cfc759cfe0f86c6e (diff) | |
download | bazel-skylib-6e2d7e4a75b8ec0c307cf2ff2ca3d837633413ca.tar.gz |
Rename a number of instances of 'skylark' to 'starlark' or 'bzl'
Most notably, this renames/moves a few important identifiers:
//:skylark_library.bzl -> //:bzl_library.bzl
skylark_library -> bzl_library
SkylarkLibraryInfo -> StarlarkLibraryInfo
Diffstat (limited to 'skylark_library.bzl')
-rw-r--r-- | skylark_library.bzl | 113 |
1 files changed, 8 insertions, 105 deletions
diff --git a/skylark_library.bzl b/skylark_library.bzl index a91639d..499cd5a 100644 --- a/skylark_library.bzl +++ b/skylark_library.bzl @@ -1,109 +1,12 @@ -# Copyright 2017 The Bazel Authors. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Skylib module containing a library rule for aggregating rules files.""" - -SkylarkLibraryInfo = provider( - "Information on contained Skylark rules.", - fields = { - "srcs": "Top level rules files.", - "transitive_srcs": "Transitive closure of rules files required for " + - "interpretation of the srcs", - }, +print( + "WARNING: skylark_library.bzl is deprecated and will go away in the future, please" + + " use bzl_library.bzl instead.", ) -def _skylark_library_impl(ctx): - deps_files = [depset(x.files, order = "postorder") for x in ctx.attr.deps] - all_files = depset(ctx.files.srcs, order = "postorder", transitive = deps_files) - return [ - # All dependent files should be listed in both `files` and in `runfiles`; - # this ensures that a `skylark_library` can be referenced as `data` from - # a separate program, or from `tools` of a genrule(). - DefaultInfo( - files = all_files, - runfiles = ctx.runfiles(files = list(all_files)), - ), - - # We also define our own provider struct, for aggregation and testing. - SkylarkLibraryInfo( - srcs = ctx.files.srcs, - transitive_srcs = all_files, - ), - ] - -skylark_library = rule( - implementation = _skylark_library_impl, - attrs = { - "srcs": attr.label_list( - allow_files = [".bzl"], - ), - "deps": attr.label_list( - allow_files = [".bzl"], - providers = [ - [SkylarkLibraryInfo], - ], - ), - }, -) -"""Creates a logical collection of Skylark .bzl files. - -Args: - srcs: List of `.bzl` files that are processed to create this target. - deps: List of other `skylark_library` targets that are required by the - Skylark files listed in `srcs`. - -Example: - Suppose your project has the following structure: - - ``` - [workspace]/ - WORKSPACE - BUILD - checkstyle/ - BUILD - checkstyle.bzl - lua/ - BUILD - lua.bzl - luarocks.bzl - ``` - - In this case, you can have `skylark_library` targets in `checkstyle/BUILD` and - `lua/BUILD`: - - `checkstyle/BUILD`: - - ```python - load("@bazel_skylib//:skylark_library.bzl", "skylark_library") - - skylark_library( - name = "checkstyle-rules", - srcs = ["checkstyle.bzl"], - ) - ``` - - `lua/BUILD`: +load("//:bzl_library.bzl", "StarlarkLibraryInfo", "bzl_library") - ```python - load("@bazel_skylib//:skylark_library.bzl", "skylark_library") +# These are temporary forwarding macros to facilitate migration to +# the new names for these objects. +SkylarkLibraryInfo = StarlarkLibraryInfo - skylark_library( - name = "lua-rules", - srcs = [ - "lua.bzl", - "luarocks.bzl", - ], - ) - ``` -""" +skylark_library = bzl_library |