Skip to content

Commit 2734d35

Browse files
Typescript Teamalexeagle
Typescript Team
authored and
alexeagle
committed
update SHA to working release
PiperOrigin-RevId: 156613372
0 parents  commit 2734d35

28 files changed

+1557
-0
lines changed

‎.clang-format

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
BasedOnStyle: Google

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.idea
2+
node_modules
3+
/bazel-*

‎AUTHORS

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# This the official list of Bazel authors for copyright purposes.
2+
# This file is distinct from the CONTRIBUTORS files.
3+
# See the latter for an explanation.
4+
5+
# Names should be added to this file as:
6+
# Name or Organization <email address>
7+
# The email address is not required for organizations.
8+
9+
Google Inc.

‎BUILD

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Copyright 2017 The Bazel Authors. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# The node_modules directory is created by `yarn install`
16+
# WORKAROUND for https://github.com/bazelbuild/bazel/issues/374#issuecomment-296217940
17+
# see notes in internal/yarn_install.bzl
18+
filegroup(
19+
name = "node_modules",
20+
srcs = glob(["node_modules/**/*"]),
21+
visibility = ["//visibility:public"],
22+
)

‎CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Want to contribute? Great! First, read this page (including the small print at the end).
2+
3+
### Before you contribute
4+
**Before we can use your code, you must sign the
5+
[Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
6+
(CLA)**, which you can do online.
7+
8+
The CLA is necessary mainly because you own the copyright to your changes,
9+
even after your contribution becomes part of our codebase, so we need your
10+
permission to use and distribute your code. We also need to be sure of
11+
various other things for instance that you'll tell us if you know that
12+
your code infringes on other people's patents. You don't have to sign
13+
the CLA until after you've submitted your code for review and a member has
14+
approved it, but you must do it before we can put your code into our codebase.
15+
16+
Before you start working on a larger contribution, you should get in touch
17+
with us first. Use the issue tracker to explain your idea so we can help and
18+
possibly guide you.
19+
20+
### Code reviews and other contributions.
21+
**All submissions, including submissions by project members, require review.**
22+
TODO(alexeagle): document how external contributions are handled.
23+
24+
### The small print
25+
Contributions made by corporations are covered by a different agreement than
26+
the one above, the
27+
[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).

‎CONTRIBUTORS

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# People who have agreed to one of the CLAs and can contribute patches.
2+
# The AUTHORS file lists the copyright holders; this file
3+
# lists people. For example, Google employees are listed here
4+
# but not in AUTHORS, because Google holds the copyright.
5+
#
6+
# https://developers.google.com/open-source/cla/individual
7+
# https://developers.google.com/open-source/cla/corporate
8+
#
9+
# Names should be added to this file as:
10+
# Name <email address>
11+
12+
Alex Eagle <[email protected]>

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# TypeScript rules for Bazel
2+
3+
**WARNING: this is an early release with limited features. Breaking changes are likely. Not recommended for general use.**
4+
5+
The TypeScript rules integrate the TypeScript compiler with Bazel.
6+
7+
## Installation
8+
9+
First, install a current Bazel distribution.
10+
11+
Create a `BUILD` file in your project root:
12+
13+
```python
14+
package(default_visibility = ["//visibility:public"])
15+
exports_files(["tsconfig.json"])
16+
17+
# NOTE: this will move to node_modules/BUILD in a later release
18+
filegroup(name = "node_modules", srcs = glob(["node_modules/**/*"]))
19+
```
20+
21+
> Note, on Mac file paths are case-insensitive, so make sure there isn't already
22+
a `build` folder in the project root.
23+
24+
Next create a `WORKSPACE` file in your project root (or edit the existing one)
25+
containing:
26+
27+
```python
28+
load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
29+
30+
git_repository(
31+
name = "io_bazel_rules_typescript",
32+
remote = "sso://bazel/rules_typescript",
33+
commit = "b25f535a7fdb4382dc67ed455c54b7ba23995c85")
34+
35+
load("@io_bazel_rules_typescript//:defs.bzl", "node_repositories", "yarn_install")
36+
37+
node_repositories()
38+
yarn_install(package_json = "//:package.json")
39+
40+
```
41+
42+
## Usage
43+
44+
Currently, the only available rule is `ts_library` which invokes the TypeScript
45+
compiler on one compilation unit (generally one directory of source files).
46+
47+
Create a `BUILD` file next to your sources:
48+
49+
```
50+
package(default_visibility=["//visibility:public"])
51+
load("@io_bazel_rules_typescript//:defs.bzl", "ts_library")
52+
53+
ts_library(
54+
name = "my_code",
55+
srcs = glob(["*.ts"]),
56+
deps = ["//path/to/other:library"],
57+
tsconfig = "//:tsconfig.json",
58+
)
59+
```
60+
61+
(Note that you may want to name the ts_library target the same as the enclosing
62+
directory, making it the default target in the package.)
63+
64+
Then build it:
65+
66+
`bazel build //path/to/package:target`
67+
68+
The resulting `.d.ts` file paths will be printed. Additionally, the `.js`
69+
outputs from TypeScript will be written to disk, next to the `.d.ts` files.
70+
71+
## Notes
72+
73+
If you'd like a "watch mode", try https://github.com/bazelbuild/bazel-watcher
74+
(note, it's also quite new).
75+
76+
At some point, we plan to release a tool similar to [gazelle] to generate the
77+
BUILD files from your source code.
78+
79+
[gazelle]: https://github.com/bazelbuild/rules_go/tree/master/go/tools/gazelle

‎WORKSPACE

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Copyright 2017 The Bazel Authors. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
workspace(name = "io_bazel_rules_typescript")
16+
17+
load("//:defs.bzl", "node_repositories", "yarn_install")
18+
19+
# Install a hermetic version of node.
20+
# After this is run, label @io_bazel_rules_typescript_node//:bin/node will exist
21+
node_repositories()
22+
23+
# Install yarn, and run yarn install to create node_modules.
24+
# After this is run, label @yarn//installed:node_modules will exist.
25+
# (But your rules can reference //:node_modules instead)
26+
yarn_install(package_json = "//:package.json")

0 commit comments

Comments
 (0)