Skip to content

Commit bde2435

Browse files
authored
CI: build @rescript/std, too (rescript-lang#5491)
1 parent bda48d0 commit bde2435

File tree

10 files changed

+943
-20
lines changed

10 files changed

+943
-20
lines changed

.github/workflows/ci.yml

+14-5
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ jobs:
117117
- name: Download artifacts
118118
uses: actions/download-artifact@v3
119119

120-
- name: Copy artifacts
120+
- name: Move artifacts
121121
run: ./scripts/moveArtifacts.sh
122122

123123
- name: Create ninja.tar.gz
@@ -126,16 +126,25 @@ jobs:
126126
- name: Run prepublish.js
127127
run: node ./scripts/prepublish.js -nocheck
128128

129-
- name: npm pack
129+
- name: npm pack (rescript)
130130
run: npm pack
131131

132+
- name: Copy JS files to stdlib package
133+
run: mkdir -p packages/std/lib && cp -R lib/es6 lib/js packages/std/lib
134+
135+
- name: npm pack (@rescript/std)
136+
run: npm pack
137+
working-directory: packages/std
138+
132139
- name: Get package info
133140
id: get_package_info
134141
# For pull requests, pass the correct commit SHA explicitly as GITHUB_SHA points to the wrong commit.
135142
run: node .github/workflows/get_package_info.js ${{ github.event.pull_request.head.sha }}
136143

137-
- name: "Upload artifact: npm package tarball"
144+
- name: "Upload artifact: npm packages"
138145
uses: actions/upload-artifact@v3
139146
with:
140-
name: ${{ steps.get_package_info.outputs.artifact_name }}
141-
path: ${{ steps.get_package_info.outputs.artifact_path }}
147+
name: npm-packages
148+
path: |
149+
${{ steps.get_package_info.outputs.rescript_package }}
150+
${{ steps.get_package_info.outputs.stdlib_package }}

.github/workflows/get_package_info.js

+10-6
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ const { name, version } = packageSpec;
66
const commitHash = process.argv[2] || process.env.GITHUB_SHA;
77
const commitHashShort = commitHash.substring(0, 7);
88

9-
const packageName = `${name}-${version}.tgz`;
10-
const artifactName = `${name}-${version}-${commitHashShort}.tgz`;
9+
const rescriptPackagePath = `${name}-${version}.tgz`;
10+
const rescriptArtifactName = `${name}-${version}-${commitHashShort}.tgz`;
1111

12-
fs.renameSync(packageName, artifactName);
12+
const stdlibPackagePath = `packages/std/rescript-std-${version}.tgz`;
13+
const stdlibArtifactName = `rescript-std-${version}-${commitHashShort}.tgz`;
1314

14-
// Pass artifactPath and artifactName to subsequent GitHub actions
15-
console.log(`::set-output name=artifact_path::${artifactName}`);
16-
console.log(`::set-output name=artifact_name::${artifactName}`);
15+
fs.renameSync(rescriptPackagePath, rescriptArtifactName);
16+
fs.renameSync(stdlibPackagePath, stdlibArtifactName);
17+
18+
// Pass information to subsequent GitHub actions
19+
console.log(`::set-output name=rescript_package::${rescriptArtifactName}`);
20+
console.log(`::set-output name=stdlib_package::${stdlibArtifactName}`);

.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,5 @@ scripts/moveArtifacts.sh
5151
scripts/deps.js
5252
scripts/format.js
5353
scripts/local_br_clean.sh
54+
scripts/setVersion.js
55+
packages/std/

packages/std/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lib/

packages/std/COPYING

+674
Large diffs are not rendered by default.

packages/std/COPYING.LESSER

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

packages/std/LICENSE

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Copyright (C) 2015- Authors of ReScript
2+
3+
This program is free software: you can redistribute it and/or modify
4+
it under the terms of the GNU Lesser General Public License as published by
5+
the Free Software Foundation, either version 3 of the License, or
6+
(at your option) any later version.
7+
8+
In addition to the permissions granted to you by the LGPL, you may combine
9+
or link a "work that uses the Library" with a publicly distributed version
10+
of this file to produce a combined library or application, then distribute
11+
that combined work under the terms of your choosing, with no requirement
12+
to comply with the obligations normally placed on you by section 4 of the
13+
LGPL version 3 (or the corresponding section of a later version of the LGPL
14+
should you choose to use a later version).
15+
16+
This program is distributed in the hope that it will be useful,
17+
but WITHOUT ANY WARRANTY; without even the implied warranty of
18+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19+
GNU Lesser General Public License for more details.
20+
21+
You should have received a copy of the GNU Lesser General Public License
22+
along with this program; if not, write to the Free Software
23+
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

packages/std/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# A light weight runtime for ReScript.
2+
3+
The motiviation of this repo is that when ReScript users want to share their library with JS users, the JS users don't need have ReScript toolchain installed, this makes sharing code with JS users easier (more details on that topic can be found in our [External Stdlib Docs](https://rescript-lang.org/docs/manual/latest/build-external-stdlib)).
4+
5+
It shares the same version schema with ReScript compiler.
6+
7+
When you use this library, the config would be adding such things in bsconfig.json
8+
9+
```json
10+
"external-stdlib" : "@rescript/std"
11+
```
12+
13+
## Contributing
14+
15+
See the [CONTRIBUTING.md](CONTRIBUTING.md).

packages/std/package.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "@rescript/std",
3+
"version": "10.0.0-beta.1",
4+
"keywords": [
5+
"rescript",
6+
"stdlib",
7+
"functional programming"
8+
],
9+
"author": {
10+
"name": "Hongbo Zhang"
11+
},
12+
"maintainers": [
13+
{
14+
"name": "hongbo_zhang",
15+
"email": "bobzhang1988@gmail.com"
16+
}
17+
],
18+
"files": [
19+
"lib"
20+
],
21+
"license": "SEE LICENSE IN LICENSE",
22+
"bugs": {
23+
"url": "https://github.com/rescript-compiler/issues"
24+
},
25+
"homepage": "http://rescript-lang.org"
26+
}

jscomp/build_version.js scripts/setVersion.js

+13-9
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@
22
/**
33
* This file is used only in dev time, feel free to use es6
44
*/
5-
var fs = require("fs");
6-
var path = require("path");
7-
var package_spec = JSON.parse(fs.readFileSync("../package.json", "utf8"));
5+
const fs = require("fs");
6+
const path = require("path");
87

9-
var { version, name } = package_spec;
8+
const packageSpec = JSON.parse(fs.readFileSync("./package.json", "utf8"));
9+
const { version, name } = packageSpec;
1010

11-
// var preRelelease = version.lastIndexOf("-");
12-
// if(preRelelease>=0){
13-
// version = version.substr(0,preRelelease)
14-
// }
11+
const stdlibPackageSpec = JSON.parse(
12+
fs.readFileSync("./packages/std/package.json", "utf8")
13+
);
14+
stdlibPackageSpec.version = version;
15+
fs.writeFileSync(
16+
"./packages/std/package.json",
17+
JSON.stringify(stdlibPackageSpec, null, 2)
18+
);
1519

1620
fs.writeFileSync(
17-
path.join(__dirname, "common", "bs_version.ml"),
21+
"./jscomp/common/bs_version.ml",
1822
`(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
1923
*
2024
* This program is free software: you can redistribute it and/or modify

0 commit comments

Comments
 (0)