diff --git a/Cargo.toml b/Cargo.toml index 320d39a..c4c78af 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,11 +4,16 @@ members = [ "crates/decodal-cli", "crates/decodal-wasm", ] -resolver = "3" +resolver = "2" -[profile.release] -opt-level = "z" -lto = true -codegen-units = 1 -strip = true -panic = "abort" +[workspace.package] +version = "0.1.0" +edition = "2024" +rust-version = "1.85" +license = "MIT OR Apache-2.0" +repository = "https://gitea.hareworks.net/Hare/Decodal" +readme = "README.md" + +[workspace.dependencies] +serde_json = "1" +wasm-bindgen = "0.2" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..8ad3e6e --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,173 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..dd4df64 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Decodal contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..251fa19 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Decodal + +Decodal is a small deterministic DSL for describing, composing, validating, and materializing structured data. + +It is designed around a lightweight Rust core: + +- host-supplied imports through `SourceLoader` +- no filesystem access in `decodal-core` +- concrete and abstract values with constraints and defaults +- deterministic expression evaluation +- optional regex support behind a Cargo feature +- browser playground support through WebAssembly + +## Install the CLI + +```sh +cargo install decodal +``` + +Run a Decodal file: + +```sh +decodal examples/advanced/main.dcdl +``` + +Enable optional regex support when needed: + +```sh +cargo install decodal --features regex +``` + +## Library crate + +Embedded hosts should depend on `decodal-core` and provide imports with a `SourceLoader`. + +```toml +[dependencies] +decodal-core = "0.1" +``` + +## Web playground + +The static documentation site and browser playground live under: + +```text +site/decodal-site/ +``` + +## License + +Licensed under either of: + +- Apache License, Version 2.0 +- MIT license + +at your option. diff --git a/crates/decodal-cli/Cargo.toml b/crates/decodal-cli/Cargo.toml index 4fb5122..d63f66d 100644 --- a/crates/decodal-cli/Cargo.toml +++ b/crates/decodal-cli/Cargo.toml @@ -1,11 +1,18 @@ [package] name = "decodal" -version = "0.1.0" -edition = "2024" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +repository.workspace = true +readme.workspace = true +description = "Command-line interface for the Decodal data description language." +keywords = ["decodal", "dsl", "config", "cli"] +categories = ["command-line-utilities", "config"] [features] default = [] regex = ["decodal-core/regex"] [dependencies] -decodal-core = { path = "../decodal-core" } +decodal-core = { version = "0.1.0", path = "../decodal-core" } diff --git a/crates/decodal-core/Cargo.toml b/crates/decodal-core/Cargo.toml index 436ebe3..954f347 100644 --- a/crates/decodal-core/Cargo.toml +++ b/crates/decodal-core/Cargo.toml @@ -1,7 +1,14 @@ [package] name = "decodal-core" -version = "0.1.0" -edition = "2024" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +repository.workspace = true +readme.workspace = true +description = "Core parser, evaluator, and embedding API for the Decodal data description language." +keywords = ["decodal", "dsl", "config", "schema"] +categories = ["config", "parser-implementations"] [features] default = ["std"] diff --git a/crates/decodal-wasm/Cargo.toml b/crates/decodal-wasm/Cargo.toml index 6d5d440..d85ff3b 100644 --- a/crates/decodal-wasm/Cargo.toml +++ b/crates/decodal-wasm/Cargo.toml @@ -1,15 +1,22 @@ [package] name = "decodal-wasm" -version = "0.1.0" -edition = "2024" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +license.workspace = true +repository.workspace = true +readme.workspace = true +description = "WebAssembly wrapper for evaluating Decodal in browser playgrounds." +keywords = ["decodal", "wasm", "dsl", "config"] +categories = ["wasm", "config"] [lib] crate-type = ["cdylib", "rlib"] [dependencies] -decodal-core = { path = "../decodal-core" } -serde_json = "1" -wasm-bindgen = "0.2" +decodal-core = { version = "0.1.0", path = "../decodal-core" } +serde_json.workspace = true +wasm-bindgen.workspace = true [package.metadata.wasm-pack.profile.release] wasm-opt = false diff --git a/doc/manual/souce/development.md b/doc/manual/souce/development.md index 335c4b6..33d954c 100644 --- a/doc/manual/souce/development.md +++ b/doc/manual/souce/development.md @@ -20,6 +20,29 @@ cargo test -p decodal-core --features regex cargo run -q -p decodal --features regex -- examples/regex/main.dcdl ``` +## crates.io release + +Crates are published as versioned workspace packages under the dual license `MIT OR Apache-2.0`. +The dependency order matters because `decodal` and `decodal-wasm` depend on `decodal-core` from crates.io. + +```sh +cargo publish -p decodal-core +# wait until crates.io index has decodal-core 0.1.0 +cargo publish -p decodal +cargo publish -p decodal-wasm +``` + +Before publishing, run: + +```sh +cargo fmt --check +cargo test +cargo check -p decodal-core --no-default-features +cargo publish -p decodal-core --dry-run +``` + +`cargo publish --dry-run` for `decodal` and `decodal-wasm` will fail until the matching `decodal-core` version is already visible in the crates.io index. + ## Web site and playground The Astro documentation site and browser playground are kept in: