Merge pull request #884 from neon-bindings/kv/re-org

Re-organize the Neon directory structure a bit
neon-bindings · Apr 26, 2022 · 09c04b3 · 09c04b3
2 parents db080d2 + 53914f2
commit 09c04b3
Show file tree

Hide file tree

Showing 86 changed files with 1,430 additions and 1,453 deletions.
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -4,4 +4,4 @@
 neon-check = " check  --all --all-targets --features napi-experimental"
 neon-clippy = "clippy --all --all-targets --features napi-experimental -- -A clippy::missing_safety_doc"
 neon-test = "  test   --all               --features=napi-experimental"
-neon-doc = "   rustdoc                    --features=napi-experimental -- --cfg docsrs"
+neon-doc = "   rustdoc -p neon            --features=napi-experimental -- --cfg docsrs"
diff --git a/.gitignore b/.gitignore
@@ -7,9 +7,9 @@ Cargo.lock
 **/index.node
 **/artifacts.json
 cli/lib
-create-neon/dist
-create-neon/create-neon-test-project
-create-neon/create-neon-manual-test-project
+**/dist
+pkgs/create-neon/create-neon-test-project
+pkgs/create-neon/create-neon-manual-test-project
 test/cli/lib
 npm-debug.log
 rls*.log
diff --git a/.prettierignore b/.prettierignore
@@ -2,6 +2,6 @@
 cli/lib/
 test/cli/lib/
 node_modules/
-create-neon/dist/
+**/dist/
 target/
 artifacts.json
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,71 +1,5 @@
-[package]
-name = "neon"
-version = "0.10.0"
-authors = ["Dave Herman <david.herman@gmail.com>"]
-description = "A safe abstraction layer for Node.js."
-readme = "README.md"
-homepage = "https://www.neon-bindings.com"
-repository = "https://github.com/neon-bindings/neon"
-license = "MIT/Apache-2.0"
-exclude = ["neon.jpg", "doc/**/*"]
-build = "build.rs"
-edition = "2018"
-
-[dev-dependencies]
-nodejs-sys = "0.13.0"
-semver = "0.9"
-psd = "0.1.9"     # used for a doc example
-failure = "0.1.5" # used for a doc example
-
-[dependencies]
-libloading = "0.7.3"
-semver = "0.9.0"
-smallvec = "1.4.2"
-neon-macros = { version = "=0.10.0", path = "crates/neon-macros" }
-
-[features]
-default = ["napi-1"]
-
-# Default N-API version. Prefer to select a minimum required version.
-# DEPRECATED: This is an alias that should be removed
-napi-runtime = ["napi-8"]
-
-# Select the N-API version
-# Feature flags to enable the experimental N-API runtime. For now, this feature
-# is disabled by default.
-# The Node N-API documentation specifies N-API and Node version requirements
-# https://nodejs.org/api/n-api.html
-napi-1 = []
-napi-2 = ["napi-1"]
-napi-3 = ["napi-2"]
-napi-4 = ["napi-3"]
-napi-5 = ["napi-4"]
-napi-6 = ["napi-5"]
-napi-7 = ["napi-6"]
-napi-8 = ["napi-7"]
-napi-latest = ["napi-8"]
-napi-experimental = ["napi-8"]
-
-# DEPRECATED: These perform no action and will be removed in 1.0
-try-catch-api = []
-channel-api = []
-event-queue-api = []
-promise-api = []
-task-api = []
-
-# Feature flag to include procedural macros
-# DEPRECATED: This is always enabled and should be removed.
-proc-macros = []
-
-[package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
-features = [
-    "napi-experimental",
-]
-
 [workspace]
 members = [
-    "crates/neon-macros",
-    "test/electron",
-    "test/napi"
+    "crates/*",
+    "test/*",
 ]
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# <img src="neon.png" alt="neon" width="100%" />
+# <img src="doc/neon.png" alt="neon" width="100%" />
 
 [![Cargo](https://img.shields.io/crates/v/neon.svg)](https://crates.io/crates/neon)
 [![npm](https://img.shields.io/npm/v/neon-cli.svg)](https://www.npmjs.com/package/neon-cli)
@@ -29,7 +29,8 @@ our [API docs](https://docs.rs/neon/latest/neon).
 
 The latest version of Neon, 0.10, includes a few small breaking changes in order to clean up and improve the usability of our APIs.
 
-**Read the new [migration guide](https://github.com/neon-bindings/neon/blob/main/MIGRATION_GUIDE_0.10.md)** to learn how to port your Neon projects to 0.10!
+**Read the new [migration guide](https://github.com/neon-bindings/neon/blob/main/docs/MIGRATION_GUIDE_0.10.md)** to learn how to port your 
+Neon projects to 0.10!
 
 ## Platform Support
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -1,6 +1,6 @@
 # Version 0.10
 
-See the [Neon 0.10 Migration Guide](MIGRATION_GUIDE_0.10.md) for more details about new features and breaking changes.
+See the [Neon 0.10 Migration Guide](docs/MIGRATION_GUIDE_0.10.md) for more details about new features and breaking changes.
 
 ## Features
 

diff --git a/build.rs b/build.rs
diff --git a/crates/neon/Cargo.toml b/crates/neon/Cargo.toml
@@ -0,0 +1,63 @@
+[package]
+name = "neon"
+version = "0.10.0"
+authors = ["Dave Herman <david.herman@gmail.com>"]
+description = "A safe abstraction layer for Node.js."
+readme = "README.md"
+homepage = "https://www.neon-bindings.com"
+repository = "https://github.com/neon-bindings/neon"
+license = "MIT/Apache-2.0"
+exclude = ["neon.jpg", "doc/**/*"]
+edition = "2018"
+
+[dev-dependencies]
+nodejs-sys = "0.13.0"
+semver = "0.9"
+psd = "0.1.9"     # used for a doc example
+failure = "0.1.5" # used for a doc example
+
+[dependencies]
+libloading = "0.7.3"
+semver = "0.9.0"
+smallvec = "1.4.2"
+neon-macros = { version = "=0.10.0", path = "../neon-macros" }
+
+[features]
+default = ["napi-1"]
+
+# Default N-API version. Prefer to select a minimum required version.
+# DEPRECATED: This is an alias that should be removed
+napi-runtime = ["napi-8"]
+
+# Select the N-API version
+# Feature flags to enable the experimental N-API runtime. For now, this feature
+# is disabled by default.
+# The Node N-API documentation specifies N-API and Node version requirements
+# https://nodejs.org/api/n-api.html
+napi-1 = []
+napi-2 = ["napi-1"]
+napi-3 = ["napi-2"]
+napi-4 = ["napi-3"]
+napi-5 = ["napi-4"]
+napi-6 = ["napi-5"]
+napi-7 = ["napi-6"]
+napi-8 = ["napi-7"]
+napi-latest = ["napi-8"]
+napi-experimental = ["napi-8"]
+
+# DEPRECATED: These perform no action and will be removed in 1.0
+try-catch-api = []
+channel-api = []
+event-queue-api = []
+promise-api = []
+task-api = []
+
+# Feature flag to include procedural macros
+# DEPRECATED: This is always enabled and should be removed.
+proc-macros = []
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+features = [
+    "napi-experimental",
+]
diff --git a/src/context/internal.rs → crates/neon/src/context/internal.rs b/src/context/internal.rs → crates/neon/src/context/internal.rs
diff --git a/src/context/mod.rs → crates/neon/src/context/mod.rs b/src/context/mod.rs → crates/neon/src/context/mod.rs
diff --git a/src/event/channel.rs → crates/neon/src/event/channel.rs b/src/event/channel.rs → crates/neon/src/event/channel.rs
diff --git a/src/event/mod.rs → crates/neon/src/event/mod.rs b/src/event/mod.rs → crates/neon/src/event/mod.rs
diff --git a/src/event/task.rs → crates/neon/src/event/task.rs b/src/event/task.rs → crates/neon/src/event/task.rs
diff --git a/src/handle/internal.rs → crates/neon/src/handle/internal.rs b/src/handle/internal.rs → crates/neon/src/handle/internal.rs
diff --git a/src/handle/mod.rs → crates/neon/src/handle/mod.rs b/src/handle/mod.rs → crates/neon/src/handle/mod.rs
diff --git a/src/handle/root.rs → crates/neon/src/handle/root.rs b/src/handle/root.rs → crates/neon/src/handle/root.rs
diff --git a/src/lib.rs → crates/neon/src/lib.rs b/src/lib.rs → crates/neon/src/lib.rs
diff --git a/src/lifecycle.rs → crates/neon/src/lifecycle.rs b/src/lifecycle.rs → crates/neon/src/lifecycle.rs
diff --git a/src/macro_internal/mod.rs → crates/neon/src/macro_internal/mod.rs b/src/macro_internal/mod.rs → crates/neon/src/macro_internal/mod.rs
diff --git a/src/meta.rs → crates/neon/src/meta.rs b/src/meta.rs → crates/neon/src/meta.rs
@@ -24,13 +24,3 @@ pub fn version() -> Version {
         build: vec![],
     }
 }
-
-// We captured the build profile from build.rs and saved it in the cfg variable `neon_profile`.
-
-/// The current build profile (either `"release"` or `"debug"`).
-#[cfg(neon_profile = "release")]
-pub const BUILD_PROFILE: &str = "release";
-
-/// The current build profile (either `"release"` or `"debug"`).
-#[cfg(not(neon_profile = "release"))]
-pub const BUILD_PROFILE: &str = "debug";
diff --git a/src/object/mod.rs → crates/neon/src/object/mod.rs b/src/object/mod.rs → crates/neon/src/object/mod.rs
diff --git a/src/prelude.rs → crates/neon/src/prelude.rs b/src/prelude.rs → crates/neon/src/prelude.rs
diff --git a/src/reflect.rs → crates/neon/src/reflect.rs b/src/reflect.rs → crates/neon/src/reflect.rs
diff --git a/src/result/mod.rs → crates/neon/src/result/mod.rs b/src/result/mod.rs → crates/neon/src/result/mod.rs
diff --git a/src/sys/array.rs → crates/neon/src/sys/array.rs b/src/sys/array.rs → crates/neon/src/sys/array.rs
diff --git a/src/sys/arraybuffer.rs → crates/neon/src/sys/arraybuffer.rs b/src/sys/arraybuffer.rs → crates/neon/src/sys/arraybuffer.rs
diff --git a/src/sys/async_work.rs → crates/neon/src/sys/async_work.rs b/src/sys/async_work.rs → crates/neon/src/sys/async_work.rs
diff --git a/src/sys/bindings/functions.rs → crates/neon/src/sys/bindings/functions.rs b/src/sys/bindings/functions.rs → crates/neon/src/sys/bindings/functions.rs
diff --git a/src/sys/bindings/mod.rs → crates/neon/src/sys/bindings/mod.rs b/src/sys/bindings/mod.rs → crates/neon/src/sys/bindings/mod.rs
diff --git a/src/sys/bindings/types.rs → crates/neon/src/sys/bindings/types.rs b/src/sys/bindings/types.rs → crates/neon/src/sys/bindings/types.rs
diff --git a/src/sys/buffer.rs → crates/neon/src/sys/buffer.rs b/src/sys/buffer.rs → crates/neon/src/sys/buffer.rs
diff --git a/src/sys/call.rs → crates/neon/src/sys/call.rs b/src/sys/call.rs → crates/neon/src/sys/call.rs
diff --git a/src/sys/convert.rs → crates/neon/src/sys/convert.rs b/src/sys/convert.rs → crates/neon/src/sys/convert.rs
diff --git a/src/sys/date.rs → crates/neon/src/sys/date.rs b/src/sys/date.rs → crates/neon/src/sys/date.rs
diff --git a/src/sys/error.rs → crates/neon/src/sys/error.rs b/src/sys/error.rs → crates/neon/src/sys/error.rs
diff --git a/src/sys/external.rs → crates/neon/src/sys/external.rs b/src/sys/external.rs → crates/neon/src/sys/external.rs
diff --git a/src/sys/fun.rs → crates/neon/src/sys/fun.rs b/src/sys/fun.rs → crates/neon/src/sys/fun.rs
diff --git a/src/sys/lifecycle.rs → crates/neon/src/sys/lifecycle.rs b/src/sys/lifecycle.rs → crates/neon/src/sys/lifecycle.rs
diff --git a/src/sys/mem.rs → crates/neon/src/sys/mem.rs b/src/sys/mem.rs → crates/neon/src/sys/mem.rs
diff --git a/src/sys/mod.rs → crates/neon/src/sys/mod.rs b/src/sys/mod.rs → crates/neon/src/sys/mod.rs
diff --git a/src/sys/no_panic.rs → crates/neon/src/sys/no_panic.rs b/src/sys/no_panic.rs → crates/neon/src/sys/no_panic.rs
diff --git a/src/sys/object.rs → crates/neon/src/sys/object.rs b/src/sys/object.rs → crates/neon/src/sys/object.rs
diff --git a/src/sys/primitive.rs → crates/neon/src/sys/primitive.rs b/src/sys/primitive.rs → crates/neon/src/sys/primitive.rs
diff --git a/src/sys/promise.rs → crates/neon/src/sys/promise.rs b/src/sys/promise.rs → crates/neon/src/sys/promise.rs
diff --git a/src/sys/raw.rs → crates/neon/src/sys/raw.rs b/src/sys/raw.rs → crates/neon/src/sys/raw.rs
diff --git a/src/sys/reference.rs → crates/neon/src/sys/reference.rs b/src/sys/reference.rs → crates/neon/src/sys/reference.rs
diff --git a/src/sys/scope.rs → crates/neon/src/sys/scope.rs b/src/sys/scope.rs → crates/neon/src/sys/scope.rs
diff --git a/src/sys/string.rs → crates/neon/src/sys/string.rs b/src/sys/string.rs → crates/neon/src/sys/string.rs
diff --git a/src/sys/tag.rs → crates/neon/src/sys/tag.rs b/src/sys/tag.rs → crates/neon/src/sys/tag.rs
diff --git a/src/sys/tsfn.rs → crates/neon/src/sys/tsfn.rs b/src/sys/tsfn.rs → crates/neon/src/sys/tsfn.rs
diff --git a/src/sys/typedarray.rs → crates/neon/src/sys/typedarray.rs b/src/sys/typedarray.rs → crates/neon/src/sys/typedarray.rs
diff --git a/src/types/boxed.rs → crates/neon/src/types/boxed.rs b/src/types/boxed.rs → crates/neon/src/types/boxed.rs
diff --git a/src/types/buffer/lock.rs → crates/neon/src/types/buffer/lock.rs b/src/types/buffer/lock.rs → crates/neon/src/types/buffer/lock.rs
diff --git a/src/types/buffer/mod.rs → crates/neon/src/types/buffer/mod.rs b/src/types/buffer/mod.rs → crates/neon/src/types/buffer/mod.rs
diff --git a/src/types/buffer/types.rs → crates/neon/src/types/buffer/types.rs b/src/types/buffer/types.rs → crates/neon/src/types/buffer/types.rs
diff --git a/src/types/date.rs → crates/neon/src/types/date.rs b/src/types/date.rs → crates/neon/src/types/date.rs
diff --git a/src/types/error.rs → crates/neon/src/types/error.rs b/src/types/error.rs → crates/neon/src/types/error.rs
diff --git a/src/types/function/mod.rs → crates/neon/src/types/function/mod.rs b/src/types/function/mod.rs → crates/neon/src/types/function/mod.rs
diff --git a/src/types/function/private.rs → crates/neon/src/types/function/private.rs b/src/types/function/private.rs → crates/neon/src/types/function/private.rs
diff --git a/src/types/mod.rs → crates/neon/src/types/mod.rs b/src/types/mod.rs → crates/neon/src/types/mod.rs
diff --git a/src/types/private.rs → crates/neon/src/types/private.rs b/src/types/private.rs → crates/neon/src/types/private.rs
diff --git a/src/types/promise.rs → crates/neon/src/types/promise.rs b/src/types/promise.rs → crates/neon/src/types/promise.rs
diff --git a/src/types/utf8.rs → crates/neon/src/types/utf8.rs b/src/types/utf8.rs → crates/neon/src/types/utf8.rs
diff --git a/MIGRATION_GUIDE_0.10.md → doc/MIGRATION_GUIDE_0.10.md b/MIGRATION_GUIDE_0.10.md → doc/MIGRATION_GUIDE_0.10.md
diff --git a/neon.png → doc/neon.png b/neon.png → doc/neon.png