docs: fix docs.rs build, add badges to README
This commit is contained in:
parent
5a0b9919ea
commit
177e41b753
4 changed files with 25 additions and 24 deletions
2
.github/workflows/linux-musl.yaml
vendored
2
.github/workflows/linux-musl.yaml
vendored
|
@ -35,7 +35,7 @@ jobs:
|
||||||
|
|
||||||
- name: Run check
|
- name: Run check
|
||||||
run: |
|
run: |
|
||||||
docker run --rm -v $(pwd)/.cargo:/root/.cargo -v $(pwd):/napi-rs -w /napi-rs builder cargo check --all --bins --examples --tests -vvv
|
docker run --rm -v $(pwd)/.cargo:/root/.cargo -v $(pwd):/napi-rs -w /napi-rs builder cargo check -vvv
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: |
|
run: |
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
|
|
||||||
> This project was initialized from [xray](https://github.com/atom/xray)
|
> This project was initialized from [xray](https://github.com/atom/xray)
|
||||||
|
|
||||||
|
![](https://docs.rs/napi/badge.svg?version=0.4.2)
|
||||||
|
![](https://img.shields.io/crates/v/napi.svg)
|
||||||
|
![](https://img.shields.io/npm/v/napi-rs.svg)
|
||||||
|
|
||||||
# Platform Support
|
# Platform Support
|
||||||
|
|
||||||
![](https://github.com/napi-rs/napi-rs/workflows/macOS/badge.svg)
|
![](https://github.com/napi-rs/napi-rs/workflows/macOS/badge.svg)
|
||||||
|
|
|
@ -9,13 +9,24 @@ repository = "https://github.com/napi-rs/napi-rs"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
keywords = ["NodeJS", "FFI", "NAPI", "n-api"]
|
keywords = ["NodeJS", "FFI", "NAPI", "n-api"]
|
||||||
|
|
||||||
|
[features]
|
||||||
|
docs-rs = []
|
||||||
|
|
||||||
[target.'cfg(windows)'.build-dependencies]
|
[target.'cfg(windows)'.build-dependencies]
|
||||||
flate2 = "1.0"
|
flate2 = "1.0"
|
||||||
reqwest = { version = "0.10", features = ["native-tls", "blocking"] }
|
reqwest = { version = "0.10", features = ["native-tls", "blocking"] }
|
||||||
tar = "0.4"
|
tar = "0.4"
|
||||||
|
|
||||||
|
[target.x86_64-unknown-linux-gnu.build-dependencies]
|
||||||
|
flate2 = "1.0"
|
||||||
|
reqwest = { version = "0.10", features = ["native-tls", "blocking"] }
|
||||||
|
tar = "0.4"
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
bindgen = "0.54"
|
bindgen = "0.54"
|
||||||
glob = "0.3"
|
glob = "0.3"
|
||||||
regex = "1.3"
|
regex = "1.3"
|
||||||
semver = "0.10"
|
semver = "0.10"
|
||||||
|
|
||||||
|
[package.metadata.docs.rs]
|
||||||
|
features = ["docs"]
|
||||||
|
|
32
sys/build.rs
32
sys/build.rs
|
@ -1,11 +1,11 @@
|
||||||
extern crate bindgen;
|
extern crate bindgen;
|
||||||
#[cfg(windows)]
|
#[cfg(any(target_os = "windows", feature = "docs-rs"))]
|
||||||
extern crate flate2;
|
extern crate flate2;
|
||||||
extern crate glob;
|
extern crate glob;
|
||||||
#[cfg(windows)]
|
#[cfg(any(target_os = "windows", feature = "docs-rs"))]
|
||||||
extern crate reqwest;
|
extern crate reqwest;
|
||||||
extern crate semver;
|
extern crate semver;
|
||||||
#[cfg(windows)]
|
#[cfg(any(target_os = "windows", feature = "docs-rs"))]
|
||||||
extern crate tar;
|
extern crate tar;
|
||||||
|
|
||||||
use glob::glob;
|
use glob::glob;
|
||||||
|
@ -14,8 +14,7 @@ use std::env;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::process::Command;
|
use std::process::Command;
|
||||||
|
|
||||||
// https://stackoverflow.com/questions/37498864/finding-executable-in-path-with-rust
|
#[cfg(not(any(target_os = "windows", feature = "docs-rs")))]
|
||||||
|
|
||||||
const NODE_PRINT_EXEC_PATH: &'static str = "console.log(process.execPath)";
|
const NODE_PRINT_EXEC_PATH: &'static str = "console.log(process.execPath)";
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
|
@ -56,24 +55,11 @@ fn main() {
|
||||||
.expect("Unable to write napi bindings");
|
.expect("Unable to write napi bindings");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(target_os = "windows")]
|
#[cfg(any(target_os = "windows", feature = "docs-rs"))]
|
||||||
fn find_node_include_path(node_full_version: &str) -> PathBuf {
|
fn find_node_include_path(node_full_version: &str) -> PathBuf {
|
||||||
let mut node_exec_path = PathBuf::from(
|
let mut out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
|
||||||
String::from_utf8(
|
out_path.push(format!("node-headers-{}.tar.gz", node_full_version));
|
||||||
Command::new("node")
|
let mut header_dist_path = PathBuf::from(&PathBuf::from(&out_path).parent().unwrap());
|
||||||
.arg("-e")
|
|
||||||
.arg(NODE_PRINT_EXEC_PATH)
|
|
||||||
.output()
|
|
||||||
.unwrap()
|
|
||||||
.stdout,
|
|
||||||
)
|
|
||||||
.expect("can not find executable node"),
|
|
||||||
)
|
|
||||||
.parent()
|
|
||||||
.unwrap()
|
|
||||||
.to_path_buf();
|
|
||||||
node_exec_path.push(format!("node-headers-{}.tar.gz", node_full_version));
|
|
||||||
let mut header_dist_path = PathBuf::from(&PathBuf::from(&node_exec_path).parent().unwrap());
|
|
||||||
let unpack_path = PathBuf::from(&header_dist_path);
|
let unpack_path = PathBuf::from(&header_dist_path);
|
||||||
header_dist_path.push(format!("node-{}", node_full_version));
|
header_dist_path.push(format!("node-{}", node_full_version));
|
||||||
header_dist_path.push("include");
|
header_dist_path.push("include");
|
||||||
|
@ -95,7 +81,7 @@ fn find_node_include_path(node_full_version: &str) -> PathBuf {
|
||||||
header_dist_path
|
header_dist_path
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(not(target_os = "windows"))]
|
#[cfg(not(any(target_os = "windows", feature = "docs-rs")))]
|
||||||
fn find_node_include_path(_node_full_version: &str) -> PathBuf {
|
fn find_node_include_path(_node_full_version: &str) -> PathBuf {
|
||||||
let node_exec_path = String::from_utf8(
|
let node_exec_path = String::from_utf8(
|
||||||
Command::new("node")
|
Command::new("node")
|
||||||
|
|
Loading…
Reference in a new issue