@ohos-ports/go-npm 0.1.9-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +109 -0
- package/bin/index.js +228 -0
- package/example/package.json +15 -0
- package/index.js +1 -0
- package/package.json +41 -0
- package/src/index.js +230 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
## Go NPM
|
|
2
|
+
### Distribute cross-platform Go binaries via NPM
|
|
3
|
+
|
|
4
|
+
Applications written in Golang are portable - you can easily cross-compile binaries that work on Windows, Mac, and Linux. But how do you distribute the binaries to customers? When you publish new releases, how do they update the binary?
|
|
5
|
+
|
|
6
|
+
**Use NPM to distribute cross-platform Go binaries**
|
|
7
|
+
|
|
8
|
+
## Kidding me! Why NPM?
|
|
9
|
+
* **Cross-platform**: NPM is the only popular package manager that works cross-platform.
|
|
10
|
+
* **Lower barier to entry**: Most developers have NPM installed already.
|
|
11
|
+
* **Pain free publishing**: It just takes one command to publish - `npm publish`
|
|
12
|
+
* **Dead simple install & update story**: `npm install/update -g your-awesome-app`
|
|
13
|
+
* **Adds $PATH**: NPM will automatically add your binary location to $PATH and generate .cmd file for Windows. Your app just works after installation!
|
|
14
|
+
|
|
15
|
+
## Okay, tell me how?
|
|
16
|
+
### 1. Publish your binaries
|
|
17
|
+
Setup your Go application to compile and publish binaries to a file server. This could be Github Releases or Amazon S3 or even Dropbox. All you need is a link.
|
|
18
|
+
|
|
19
|
+
I like to use [GoReleaser](https://github.com/goreleaser/goreleaser) to setup by release process. You create a simple YAML configuration file like this and run `goreleaser` CLI to publish binaries for various platform/architecture combination to Github:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
# .goreleaser.yml
|
|
23
|
+
# Build customization
|
|
24
|
+
builds:
|
|
25
|
+
- binary: drum-roll
|
|
26
|
+
goos:
|
|
27
|
+
- windows
|
|
28
|
+
- darwin
|
|
29
|
+
- linux
|
|
30
|
+
goarch:
|
|
31
|
+
- amd64
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
`go-npm` will pull the appropriate binary for the platform & architecture where the package is being installed.
|
|
35
|
+
|
|
36
|
+
### 2. Create a package.json file for your NPM app
|
|
37
|
+
To publish to NPM, you need to create a `package.json` file. You give your application a name, link to Readme, Github repository etc, and more importantly add `go-npm` as a dependency. You can create this file in an empty directory in your project or in a separate Git repository altogether. It is your choice.
|
|
38
|
+
|
|
39
|
+
**Create package.json**
|
|
40
|
+
|
|
41
|
+
`$ npm init`
|
|
42
|
+
|
|
43
|
+
Answer the questions to create an initial package.json file
|
|
44
|
+
|
|
45
|
+
**Add go-npm dependency**
|
|
46
|
+
|
|
47
|
+
From the directory containing package.json file, do
|
|
48
|
+
|
|
49
|
+
`$ npm install go-npm --save`
|
|
50
|
+
|
|
51
|
+
This will install go-npm under to your package.json file. It will also create a `node_modules` directory where the `go-npm` package is downloaded. You don't need this directory since you are only going to publish the module and not consume it yourself. Let's go ahead and delete it.
|
|
52
|
+
|
|
53
|
+
`$ rm -r node_modules`
|
|
54
|
+
|
|
55
|
+
**Add postinstall and preuninstall scripts**
|
|
56
|
+
Here is the magic: You ask to run `go-npm install` after it completes installing your package. This will pull down binaries from Github or Amazon S3 and install in NPM's `bin` directory. Binaries under bin directory are immediately available for use in your Terminal.
|
|
57
|
+
|
|
58
|
+
Edit `package.json` file and add the following:
|
|
59
|
+
```
|
|
60
|
+
{
|
|
61
|
+
"postinstall": "go-npm install",
|
|
62
|
+
"preuninstall": "go-npm uninstall",
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
`go-npm uninstall` simply deletes the binary from `bin` directory before NPM uninstalls your package.
|
|
67
|
+
|
|
68
|
+
**Configure your binary path**
|
|
69
|
+
|
|
70
|
+
You need to tell `go-npm` where to download the binaries from, and where to install them. Edit `package.json` file and add the following configuration.
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
"goBinary": {
|
|
74
|
+
"name": "command-name",
|
|
75
|
+
"path": "./bin",
|
|
76
|
+
"url": "https://github.com/user/my-go-package/releases/download/v{{version}}/myGoPackage_{{version}}_{{platform}}_{{arch}}.tar.gz"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
* *name*: Name of the command users will use to run your binary.
|
|
80
|
+
* *path*: Temporary path where binaries will be downloaded to
|
|
81
|
+
* *url*: HTTP Web server where binaries are hosted.
|
|
82
|
+
|
|
83
|
+
Following variables are available to customize the URL:
|
|
84
|
+
* `{{version}}`: Version number read from `package.json` file. When you publish your package to NPM, it will use this version number. Ex: 0.0.1
|
|
85
|
+
* `{{platform}}`: `$GOOS` value for the platform
|
|
86
|
+
* `{{arch}}`: `$GOARCH` value for the architecture
|
|
87
|
+
|
|
88
|
+
If you use `goreleaser` to publish your modules, it will automatically set the right architecture & platform in your URL.
|
|
89
|
+
|
|
90
|
+
**Publish to NPM**
|
|
91
|
+
|
|
92
|
+
All that's left now is publish to NPM. As I promised before, just one command
|
|
93
|
+
|
|
94
|
+
`$ npm publish`
|
|
95
|
+
|
|
96
|
+
### 3. Distribute to users
|
|
97
|
+
|
|
98
|
+
To install:
|
|
99
|
+
|
|
100
|
+
`npm install -g your-app-name`
|
|
101
|
+
|
|
102
|
+
To Update:
|
|
103
|
+
|
|
104
|
+
`npm update -g your-app-name`
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
With ❤️ to the community by [Sanath Kumar Ramesh](http://twitter.com/sanathkr_)
|
package/bin/index.js
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
"use strict";
|
|
5
|
+
|
|
6
|
+
var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
|
|
7
|
+
|
|
8
|
+
var request = require('request'),
|
|
9
|
+
path = require('path'),
|
|
10
|
+
tar = require('tar'),
|
|
11
|
+
zlib = require('zlib'),
|
|
12
|
+
mkdirp = require('mkdirp'),
|
|
13
|
+
fs = require('fs'),
|
|
14
|
+
exec = require('child_process').exec;
|
|
15
|
+
|
|
16
|
+
// Mapping from Node's `process.arch` to Golang's `$GOARCH`
|
|
17
|
+
var ARCH_MAPPING = {
|
|
18
|
+
"ia32": "386",
|
|
19
|
+
"x64": "amd64",
|
|
20
|
+
"arm": "arm",
|
|
21
|
+
"arm64": "arm64"
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
// Mapping between Node's `process.platform` to Golang's
|
|
25
|
+
var PLATFORM_MAPPING = {
|
|
26
|
+
"darwin": "darwin",
|
|
27
|
+
"linux": "linux",
|
|
28
|
+
"win32": "windows",
|
|
29
|
+
"freebsd": "freebsd",
|
|
30
|
+
"openharmony": "linux"
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
function getInstallationPath(callback) {
|
|
34
|
+
|
|
35
|
+
// `npm bin` will output the path where binary files should be installed
|
|
36
|
+
exec("npm bin", function (err, stdout, stderr) {
|
|
37
|
+
|
|
38
|
+
var dir = null;
|
|
39
|
+
if (err || stderr || !stdout || stdout.length === 0) {
|
|
40
|
+
|
|
41
|
+
// We couldn't infer path from `npm bin`. Let's try to get it from
|
|
42
|
+
// Environment variables set by NPM when it runs.
|
|
43
|
+
// npm_config_prefix points to NPM's installation directory where `bin` folder is available
|
|
44
|
+
// Ex: /Users/foo/.nvm/versions/node/v4.3.0
|
|
45
|
+
var env = process.env;
|
|
46
|
+
if (env && env.npm_config_prefix) {
|
|
47
|
+
dir = path.join(env.npm_config_prefix, "bin");
|
|
48
|
+
}
|
|
49
|
+
} else {
|
|
50
|
+
dir = stdout.trim();
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
if (!dir) {
|
|
54
|
+
return callback("Error determining binary installation path: neither `npm bin` nor npm_config_prefix is available");
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
mkdirp.sync(dir);
|
|
58
|
+
|
|
59
|
+
callback(null, dir);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
function verifyAndPlaceBinary(binName, binPath, callback) {
|
|
64
|
+
if (!fs.existsSync(path.join(binPath, binName))) return callback('Downloaded binary does not contain the binary specified in configuration - ' + binName);
|
|
65
|
+
|
|
66
|
+
getInstallationPath(function (err, installationPath) {
|
|
67
|
+
if (err) return callback("Error getting binary installation path from `npm bin`");
|
|
68
|
+
|
|
69
|
+
// Move the binary file
|
|
70
|
+
fs.renameSync(path.join(binPath, binName), path.join(installationPath, binName));
|
|
71
|
+
|
|
72
|
+
callback(null);
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
function validateConfiguration(packageJson) {
|
|
77
|
+
|
|
78
|
+
if (!packageJson.version) {
|
|
79
|
+
return "'version' property must be specified";
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
if (!packageJson.goBinary || _typeof(packageJson.goBinary) !== "object") {
|
|
83
|
+
return "'goBinary' property must be defined and be an object";
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
if (!packageJson.goBinary.name) {
|
|
87
|
+
return "'name' property is necessary";
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
if (!packageJson.goBinary.path) {
|
|
91
|
+
return "'path' property is necessary";
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
if (!packageJson.goBinary.url) {
|
|
95
|
+
return "'url' property is required";
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// if (!packageJson.bin || typeof(packageJson.bin) !== "object") {
|
|
99
|
+
// return "'bin' property of package.json must be defined and be an object";
|
|
100
|
+
// }
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
function parsePackageJson() {
|
|
104
|
+
if (!(process.arch in ARCH_MAPPING)) {
|
|
105
|
+
console.error("Installation is not supported for this architecture: " + process.arch);
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
if (!(process.platform in PLATFORM_MAPPING)) {
|
|
110
|
+
console.error("Installation is not supported for this platform: " + process.platform);
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
var packageJsonPath = path.join(".", "package.json");
|
|
115
|
+
if (!fs.existsSync(packageJsonPath)) {
|
|
116
|
+
console.error("Unable to find package.json. " + "Please run this script at root of the package you want to be installed");
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
var packageJson = JSON.parse(fs.readFileSync(packageJsonPath));
|
|
121
|
+
var error = validateConfiguration(packageJson);
|
|
122
|
+
if (error && error.length > 0) {
|
|
123
|
+
console.error("Invalid package.json: " + error);
|
|
124
|
+
return;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// We have validated the config. It exists in all its glory
|
|
128
|
+
var binName = packageJson.goBinary.name;
|
|
129
|
+
var binPath = packageJson.goBinary.path;
|
|
130
|
+
var url = packageJson.goBinary.url;
|
|
131
|
+
var version = packageJson.version;
|
|
132
|
+
if (version[0] === 'v') version = version.substr(1); // strip the 'v' if necessary v0.0.1 => 0.0.1
|
|
133
|
+
|
|
134
|
+
// Binary name on Windows has .exe suffix
|
|
135
|
+
if (process.platform === "win32") {
|
|
136
|
+
binName += ".exe";
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// Interpolate variables in URL, if necessary
|
|
140
|
+
url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]);
|
|
141
|
+
url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
|
|
142
|
+
url = url.replace(/{{version}}/g, version);
|
|
143
|
+
url = url.replace(/{{bin_name}}/g, binName);
|
|
144
|
+
|
|
145
|
+
return {
|
|
146
|
+
binName: binName,
|
|
147
|
+
binPath: binPath,
|
|
148
|
+
url: url,
|
|
149
|
+
version: version
|
|
150
|
+
};
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Reads the configuration from application's package.json,
|
|
155
|
+
* validates properties, downloads the binary, untars, and stores at
|
|
156
|
+
* ./bin in the package's root. NPM already has support to install binary files
|
|
157
|
+
* specific locations when invoked with "npm install -g"
|
|
158
|
+
*
|
|
159
|
+
* See: https://docs.npmjs.com/files/package.json#bin
|
|
160
|
+
*/
|
|
161
|
+
var INVALID_INPUT = "Invalid inputs";
|
|
162
|
+
function install(callback) {
|
|
163
|
+
|
|
164
|
+
var opts = parsePackageJson();
|
|
165
|
+
if (!opts) return callback(INVALID_INPUT);
|
|
166
|
+
|
|
167
|
+
mkdirp.sync(opts.binPath);
|
|
168
|
+
var ungz = zlib.createGunzip();
|
|
169
|
+
var untar = tar.Extract({ path: opts.binPath });
|
|
170
|
+
|
|
171
|
+
ungz.on('error', callback);
|
|
172
|
+
untar.on('error', callback);
|
|
173
|
+
|
|
174
|
+
// First we will Un-GZip, then we will untar. So once untar is completed,
|
|
175
|
+
// binary is downloaded into `binPath`. Verify the binary and call it good
|
|
176
|
+
untar.on('end', verifyAndPlaceBinary.bind(null, opts.binName, opts.binPath, callback));
|
|
177
|
+
|
|
178
|
+
console.log("Downloading from URL: " + opts.url);
|
|
179
|
+
var req = request({ uri: opts.url });
|
|
180
|
+
req.on('error', callback.bind(null, "Error downloading from URL: " + opts.url));
|
|
181
|
+
req.on('response', function (res) {
|
|
182
|
+
if (res.statusCode !== 200) return callback("Error downloading binary. HTTP Status Code: " + res.statusCode);
|
|
183
|
+
|
|
184
|
+
req.pipe(ungz).pipe(untar);
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
function uninstall(callback) {
|
|
189
|
+
|
|
190
|
+
var opts = parsePackageJson();
|
|
191
|
+
if (!opts) return callback("Installation is not supported for this architecture or platform");
|
|
192
|
+
|
|
193
|
+
getInstallationPath(function (err, installationPath) {
|
|
194
|
+
if (err) return callback("Error finding binary installation directory");
|
|
195
|
+
|
|
196
|
+
try {
|
|
197
|
+
fs.unlinkSync(path.join(installationPath, opts.binName));
|
|
198
|
+
} catch (ex) {
|
|
199
|
+
// Ignore errors when deleting the file.
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
return callback(null);
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// Parse command line arguments and call the right method
|
|
207
|
+
var actions = {
|
|
208
|
+
"install": install,
|
|
209
|
+
"uninstall": uninstall
|
|
210
|
+
};
|
|
211
|
+
|
|
212
|
+
var argv = process.argv;
|
|
213
|
+
if (argv && argv.length > 2) {
|
|
214
|
+
var cmd = process.argv[2];
|
|
215
|
+
if (!actions[cmd]) {
|
|
216
|
+
console.log("Invalid command to go-npm. `install` and `uninstall` are the only supported commands");
|
|
217
|
+
process.exit(1);
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
actions[cmd](function (err) {
|
|
221
|
+
if (err) {
|
|
222
|
+
console.error(err);
|
|
223
|
+
process.exit(1);
|
|
224
|
+
} else {
|
|
225
|
+
process.exit(0);
|
|
226
|
+
}
|
|
227
|
+
});
|
|
228
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "app",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Example App",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"postinstall": "go-npm install",
|
|
8
|
+
"preuninstall": "go-npm uninstall"
|
|
9
|
+
},
|
|
10
|
+
"goBinary": {
|
|
11
|
+
"name": "myBinaryName",
|
|
12
|
+
"path": "./bin",
|
|
13
|
+
"url": "https://github.com/user/myrepo/releases/download/v{{version}}/myBinaryName{{platform}}_{{arch}}.tar.gz"
|
|
14
|
+
}
|
|
15
|
+
}
|
package/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require('./bin/index.js');
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ohos-ports/go-npm",
|
|
3
|
+
"version": "0.1.9-beta.1",
|
|
4
|
+
"description": "Distribute and install Go binaries via NPM (OpenHarmony port: openharmony->linux platform mapping, arm64->arm64 arch mapping)",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"go-npm": "./bin/index.js"
|
|
8
|
+
},
|
|
9
|
+
"scripts": {
|
|
10
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
|
+
},
|
|
12
|
+
"author": "Sanath Kumar Ramesh <dayanandasaraswati@gmail.com>",
|
|
13
|
+
"license": "Apache-2.0",
|
|
14
|
+
"dependencies": {
|
|
15
|
+
"mkdirp": "^0.5.1",
|
|
16
|
+
"request": "^2.81.0",
|
|
17
|
+
"tar": "^2.2.1"
|
|
18
|
+
},
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/ohos-ports/ohos-ports.git",
|
|
22
|
+
"directory": "ports/go-npm/0.1.9"
|
|
23
|
+
},
|
|
24
|
+
"homepage": "https://github.com/sanathkr/go-npm",
|
|
25
|
+
"devDependencies": {
|
|
26
|
+
"babel-cli": "^6.24.1",
|
|
27
|
+
"babel-core": "^6.25.0",
|
|
28
|
+
"babel-preset-es2015": "@ohos-ports/babel-preset-es2015@^7.0.0-beta.1"
|
|
29
|
+
},
|
|
30
|
+
"files": [
|
|
31
|
+
"bin/",
|
|
32
|
+
"index.js",
|
|
33
|
+
"src/",
|
|
34
|
+
"example/",
|
|
35
|
+
"README.md",
|
|
36
|
+
"LICENSE"
|
|
37
|
+
],
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/ohos-ports/ohos-ports/issues"
|
|
40
|
+
}
|
|
41
|
+
}
|
package/src/index.js
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
"use strict"
|
|
4
|
+
|
|
5
|
+
const request = require('request'),
|
|
6
|
+
path = require('path'),
|
|
7
|
+
tar = require('tar'),
|
|
8
|
+
zlib = require('zlib'),
|
|
9
|
+
mkdirp = require('mkdirp'),
|
|
10
|
+
fs = require('fs'),
|
|
11
|
+
exec = require('child_process').exec;
|
|
12
|
+
|
|
13
|
+
// Mapping from Node's `process.arch` to Golang's `$GOARCH`
|
|
14
|
+
const ARCH_MAPPING = {
|
|
15
|
+
"ia32": "386",
|
|
16
|
+
"x64": "amd64",
|
|
17
|
+
"arm": "arm",
|
|
18
|
+
"arm64": "arm64"
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
// Mapping between Node's `process.platform` to Golang's
|
|
22
|
+
const PLATFORM_MAPPING = {
|
|
23
|
+
"darwin": "darwin",
|
|
24
|
+
"linux": "linux",
|
|
25
|
+
"win32": "windows",
|
|
26
|
+
"freebsd": "freebsd",
|
|
27
|
+
"openharmony": "linux"
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
function getInstallationPath(callback) {
|
|
31
|
+
|
|
32
|
+
// `npm bin` will output the path where binary files should be installed
|
|
33
|
+
exec("npm bin", function(err, stdout, stderr) {
|
|
34
|
+
|
|
35
|
+
let dir = null;
|
|
36
|
+
if (err || stderr || !stdout || stdout.length === 0) {
|
|
37
|
+
|
|
38
|
+
// We couldn't infer path from `npm bin`. Let's try to get it from
|
|
39
|
+
// Environment variables set by NPM when it runs.
|
|
40
|
+
// npm_config_prefix points to NPM's installation directory where `bin` folder is available
|
|
41
|
+
// Ex: /Users/foo/.nvm/versions/node/v4.3.0
|
|
42
|
+
let env = process.env;
|
|
43
|
+
if (env && env.npm_config_prefix) {
|
|
44
|
+
dir = path.join(env.npm_config_prefix, "bin");
|
|
45
|
+
}
|
|
46
|
+
} else {
|
|
47
|
+
dir = stdout.trim();
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
if (!dir) {
|
|
51
|
+
return callback("Error determining binary installation path: neither `npm bin` nor npm_config_prefix is available");
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
mkdirp.sync(dir);
|
|
55
|
+
|
|
56
|
+
callback(null, dir);
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
function verifyAndPlaceBinary(binName, binPath, callback) {
|
|
62
|
+
if (!fs.existsSync(path.join(binPath, binName))) return callback(`Downloaded binary does not contain the binary specified in configuration - ${binName}`);
|
|
63
|
+
|
|
64
|
+
getInstallationPath(function(err, installationPath) {
|
|
65
|
+
if (err) return callback("Error getting binary installation path from `npm bin`");
|
|
66
|
+
|
|
67
|
+
// Move the binary file
|
|
68
|
+
fs.renameSync(path.join(binPath, binName), path.join(installationPath, binName));
|
|
69
|
+
|
|
70
|
+
callback(null);
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function validateConfiguration(packageJson) {
|
|
75
|
+
|
|
76
|
+
if (!packageJson.version) {
|
|
77
|
+
return "'version' property must be specified";
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
if (!packageJson.goBinary || typeof(packageJson.goBinary) !== "object") {
|
|
81
|
+
return "'goBinary' property must be defined and be an object";
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
if (!packageJson.goBinary.name) {
|
|
85
|
+
return "'name' property is necessary";
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
if (!packageJson.goBinary.path) {
|
|
89
|
+
return "'path' property is necessary";
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
if (!packageJson.goBinary.url) {
|
|
93
|
+
return "'url' property is required";
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
// if (!packageJson.bin || typeof(packageJson.bin) !== "object") {
|
|
97
|
+
// return "'bin' property of package.json must be defined and be an object";
|
|
98
|
+
// }
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
function parsePackageJson() {
|
|
102
|
+
if (!(process.arch in ARCH_MAPPING)) {
|
|
103
|
+
console.error("Installation is not supported for this architecture: " + process.arch);
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
if (!(process.platform in PLATFORM_MAPPING)) {
|
|
108
|
+
console.error("Installation is not supported for this platform: " + process.platform);
|
|
109
|
+
return
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
const packageJsonPath = path.join(".", "package.json");
|
|
113
|
+
if (!fs.existsSync(packageJsonPath)) {
|
|
114
|
+
console.error("Unable to find package.json. " +
|
|
115
|
+
"Please run this script at root of the package you want to be installed");
|
|
116
|
+
return
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
let packageJson = JSON.parse(fs.readFileSync(packageJsonPath));
|
|
120
|
+
let error = validateConfiguration(packageJson);
|
|
121
|
+
if (error && error.length > 0) {
|
|
122
|
+
console.error("Invalid package.json: " + error);
|
|
123
|
+
return
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
// We have validated the config. It exists in all its glory
|
|
127
|
+
let binName = packageJson.goBinary.name;
|
|
128
|
+
let binPath = packageJson.goBinary.path;
|
|
129
|
+
let url = packageJson.goBinary.url;
|
|
130
|
+
let version = packageJson.version;
|
|
131
|
+
if (version[0] === 'v') version = version.substr(1); // strip the 'v' if necessary v0.0.1 => 0.0.1
|
|
132
|
+
|
|
133
|
+
// Binary name on Windows has .exe suffix
|
|
134
|
+
if (process.platform === "win32") {
|
|
135
|
+
binName += ".exe"
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
// Interpolate variables in URL, if necessary
|
|
139
|
+
url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]);
|
|
140
|
+
url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
|
|
141
|
+
url = url.replace(/{{version}}/g, version);
|
|
142
|
+
url = url.replace(/{{bin_name}}/g, binName);
|
|
143
|
+
|
|
144
|
+
return {
|
|
145
|
+
binName: binName,
|
|
146
|
+
binPath: binPath,
|
|
147
|
+
url: url,
|
|
148
|
+
version: version
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Reads the configuration from application's package.json,
|
|
154
|
+
* validates properties, downloads the binary, untars, and stores at
|
|
155
|
+
* ./bin in the package's root. NPM already has support to install binary files
|
|
156
|
+
* specific locations when invoked with "npm install -g"
|
|
157
|
+
*
|
|
158
|
+
* See: https://docs.npmjs.com/files/package.json#bin
|
|
159
|
+
*/
|
|
160
|
+
const INVALID_INPUT = "Invalid inputs";
|
|
161
|
+
function install(callback) {
|
|
162
|
+
|
|
163
|
+
let opts = parsePackageJson();
|
|
164
|
+
if (!opts) return callback(INVALID_INPUT);
|
|
165
|
+
|
|
166
|
+
mkdirp.sync(opts.binPath);
|
|
167
|
+
let ungz = zlib.createGunzip();
|
|
168
|
+
let untar = tar.Extract({path: opts.binPath});
|
|
169
|
+
|
|
170
|
+
ungz.on('error', callback);
|
|
171
|
+
untar.on('error', callback);
|
|
172
|
+
|
|
173
|
+
// First we will Un-GZip, then we will untar. So once untar is completed,
|
|
174
|
+
// binary is downloaded into `binPath`. Verify the binary and call it good
|
|
175
|
+
untar.on('end', verifyAndPlaceBinary.bind(null, opts.binName, opts.binPath, callback));
|
|
176
|
+
|
|
177
|
+
console.log("Downloading from URL: " + opts.url);
|
|
178
|
+
let req = request({uri: opts.url});
|
|
179
|
+
req.on('error', callback.bind(null, "Error downloading from URL: " + opts.url));
|
|
180
|
+
req.on('response', function(res) {
|
|
181
|
+
if (res.statusCode !== 200) return callback("Error downloading binary. HTTP Status Code: " + res.statusCode);
|
|
182
|
+
|
|
183
|
+
req.pipe(ungz).pipe(untar);
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
function uninstall(callback) {
|
|
188
|
+
|
|
189
|
+
let opts = parsePackageJson();
|
|
190
|
+
if (!opts) return callback("Installation is not supported for this architecture or platform");
|
|
191
|
+
getInstallationPath(function(err, installationPath) {
|
|
192
|
+
if (err) return callback("Error finding binary installation directory");
|
|
193
|
+
|
|
194
|
+
try {
|
|
195
|
+
fs.unlinkSync(path.join(installationPath, opts.binName));
|
|
196
|
+
} catch(ex) {
|
|
197
|
+
// Ignore errors when deleting the file.
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
return callback(null);
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
// Parse command line arguments and call the right method
|
|
206
|
+
let actions = {
|
|
207
|
+
"install": install,
|
|
208
|
+
"uninstall": uninstall
|
|
209
|
+
};
|
|
210
|
+
|
|
211
|
+
let argv = process.argv;
|
|
212
|
+
if (argv && argv.length > 2) {
|
|
213
|
+
let cmd = process.argv[2];
|
|
214
|
+
if (!actions[cmd]) {
|
|
215
|
+
console.log("Invalid command to go-npm. `install` and `uninstall` are the only supported commands");
|
|
216
|
+
process.exit(1);
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
actions[cmd](function(err) {
|
|
220
|
+
if (err) {
|
|
221
|
+
console.error(err);
|
|
222
|
+
process.exit(1);
|
|
223
|
+
} else {
|
|
224
|
+
process.exit(0);
|
|
225
|
+
}
|
|
226
|
+
});
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|