diff --git a/Cargo.toml b/Cargo.toml index 582f812..e5df4e7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -39,6 +39,10 @@ syn = { version = "1.0", features = ["full"] } regex = "1.5" lazy_static = "1.4" +# JSON Schema devdeps +miette-schema = { version = "5.6.0", path = "miette-schema" } +serde_json = "1.0.95" + [features] default = [] fancy-no-backtrace = [ @@ -56,7 +60,7 @@ fancy = [ ] [workspace] -members = ["miette-derive"] +members = ["miette-derive", "miette-schema"] [package.metadata.docs.rs] all-features = true diff --git a/miette-schema/Cargo.toml b/miette-schema/Cargo.toml new file mode 100644 index 0000000..1ed3e3d --- /dev/null +++ b/miette-schema/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "miette-schema" +version = "5.6.0" +authors = ["Kat Marchán "] +edition = "2018" +license = "Apache-2.0" +description = "Type definitions for the JSON Schema of miette's json output" +repository = "https://github.com/zkat/miette" + +[features] +default = ["schemars", "serde"] + +[dependencies] +schemars = { version = "0.8.12", optional = true } +serde = { version = "1.0.159", features = ["derive"], optional = true } + +[dev-dependencies] +serde_json = "1.0.95" diff --git a/miette-schema/LICENSE b/miette-schema/LICENSE new file mode 100644 index 0000000..545f464 --- /dev/null +++ b/miette-schema/LICENSE @@ -0,0 +1,229 @@ +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. Notwithstanding the above, +nothing herein shall supersede or modify the terms of any separate license +agreement you may have executed with Licensor regarding such Contributions. + + +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 + +APPENDIX: How to +apply the Apache License to your work. + +To apply the Apache License to your work, +attach the following boilerplate notice, with the fields enclosed by brackets +"[]" replaced with your own identifying information. (Don't include the +brackets!) The text should be enclosed in the appropriate comment syntax for the +file format. We also recommend that a file or class name and description of +purpose be included on the same "printed page" as the copyright notice for easier +identification within third-party archives. + +Copyright [yyyy] Kat +Marchán + +Licensed under the Apache License, Version 2.0 (the "License"); + +you may +not use this file except in compliance with the License. + +You may obtain a copy +of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by +applicable law or agreed to in writing, software + +distributed under the License +is distributed on an "AS IS" BASIS, + +WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. + +See the License for the specific language +governing permissions and + +limitations under the License. \ No newline at end of file diff --git a/miette-schema/miette-json-schema.json b/miette-schema/miette-json-schema.json new file mode 100644 index 0000000..0e261a2 --- /dev/null +++ b/miette-schema/miette-json-schema.json @@ -0,0 +1,208 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "Diagnostic", + "description": "A miette diagnostic, the top level type of miette's json output", + "type": "object", + "properties": { + "causes": { + "description": "The underlying causes of this error (similar to a backtrace)", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "code": { + "description": "The error code\n\ne.g. \"oops::my::bad\" or \"E1312\"", + "default": "", + "type": "string" + }, + "filename": { + "description": "The name of the source file that caused the diagnostic", + "default": "", + "type": "string" + }, + "help": { + "description": "An additional piece of advice on how to address the diagnostic\n\ne.g. \"try removing this trailing comma\"", + "default": "", + "type": "string" + }, + "labels": { + "description": "Labels/spans referring to the locations in the source that are relevant to the diagnostic\n\nSee \"filename\" for the source file these labels refer to\n\ne.g. \"here's the extra comma you should remove\" (offset: 100, len: 1)", + "default": [], + "type": "array", + "items": { + "$ref": "#/definitions/Label" + } + }, + "message": { + "description": "The primary error message", + "default": "", + "type": "string" + }, + "related": { + "description": "Related Diagnostics nested under this one\n\nThis can be used to report multiple diagnostics at once, by e.g. having a vague top-level diagnostic like \"failed to compile\" with the more specific issues nested underneath it.", + "default": [], + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostic" + } + }, + "severity": { + "description": "The severity of the error (error, warning, advice, ...)", + "default": "error", + "allOf": [ + { + "$ref": "#/definitions/Severity" + } + ] + }, + "url": { + "description": "A URL to visit to get more information on this error", + "default": "", + "type": "string" + } + }, + "definitions": { + "Diagnostic": { + "description": "A miette diagnostic, the top level type of miette's json output", + "type": "object", + "properties": { + "causes": { + "description": "The underlying causes of this error (similar to a backtrace)", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "code": { + "description": "The error code\n\ne.g. \"oops::my::bad\" or \"E1312\"", + "default": "", + "type": "string" + }, + "filename": { + "description": "The name of the source file that caused the diagnostic", + "default": "", + "type": "string" + }, + "help": { + "description": "An additional piece of advice on how to address the diagnostic\n\ne.g. \"try removing this trailing comma\"", + "default": "", + "type": "string" + }, + "labels": { + "description": "Labels/spans referring to the locations in the source that are relevant to the diagnostic\n\nSee \"filename\" for the source file these labels refer to\n\ne.g. \"here's the extra comma you should remove\" (offset: 100, len: 1)", + "default": [], + "type": "array", + "items": { + "$ref": "#/definitions/Label" + } + }, + "message": { + "description": "The primary error message", + "default": "", + "type": "string" + }, + "related": { + "description": "Related Diagnostics nested under this one\n\nThis can be used to report multiple diagnostics at once, by e.g. having a vague top-level diagnostic like \"failed to compile\" with the more specific issues nested underneath it.", + "default": [], + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostic" + } + }, + "severity": { + "description": "The severity of the error (error, warning, advice, ...)", + "default": "error", + "allOf": [ + { + "$ref": "#/definitions/Severity" + } + ] + }, + "url": { + "description": "A URL to visit to get more information on this error", + "default": "", + "type": "string" + } + } + }, + "Label": { + "description": "A label/span indicating relevant portions of a source file for a Diagnostic", + "type": "object", + "properties": { + "label": { + "description": "The label/message for the span", + "default": "", + "type": "string" + }, + "span": { + "description": "The actual span/range of source code that we're referring to", + "default": { + "length": 0, + "offset": 0 + }, + "allOf": [ + { + "$ref": "#/definitions/Span" + } + ] + } + } + }, + "Severity": { + "description": "The severity of a diagnostic", + "oneOf": [ + { + "description": "This is an error", + "type": "string", + "enum": [ + "error" + ] + }, + { + "description": "This is a warning", + "type": "string", + "enum": [ + "warning" + ] + }, + { + "description": "This is just some advice", + "type": "string", + "enum": [ + "advice" + ] + }, + { + "description": "A dummy variant for forward/backward-compatibility with other versions of miette which may one day introduce more kinds of Severity. Any unknown ones will be mapped to this variant.", + "type": "string", + "enum": [ + "_unknown" + ] + } + ] + }, + "Span": { + "description": "A span/range of source code", + "type": "object", + "properties": { + "length": { + "description": "How many bytes the span contains", + "default": 0, + "type": "integer", + "format": "uint64", + "minimum": 0.0 + }, + "offset": { + "description": "The byte offset where the span starts", + "default": 0, + "type": "integer", + "format": "uint64", + "minimum": 0.0 + } + } + } + } +} diff --git a/miette-schema/src/lib.rs b/miette-schema/src/lib.rs new file mode 100644 index 0000000..92b8cdd --- /dev/null +++ b/miette-schema/src/lib.rs @@ -0,0 +1,173 @@ +#![deny(missing_docs)] + +//! # miette-schema +//! +//! This library provides type definitions and derives for +//! Serializing/Deserializing miette's JSON output using serde, and for getting +//! a schema of the format. The schema is based on [schemars][], which +//! understands your serde attributes. +//! +//! This idea is that if you have your own JSON output that may include miette +//! JSON output, you can slap the top-level [`Diagnostic`][] type in your own +//! types and get serde able to read/write it properly, and if you want a schema +//! for your entire output format then you can just slap `#[derive(JsonSchema)]` +//! on your own types and use `schemars::schema_for!(MyType)` to get the final +//! JSON Schema. +//! +//! The type definitions here are more conservative than what miette's JSON +//! output actually looks like to make the schema maximally +//! forward/backward-compatible with past/future versions of miette. +//! +//! Basically you should ideally assume every field is Optional because +//! older versions might be missing it and newer versions might remove it. Not +//! because we have any plans to break the format, but just because it's Best +//! Practice to prepare for that eventuality and interchange formats inevitably +//! result in version drift. We implement this by placing `#[serde(default)]` on +//! everything we can. +//! +//! This pretty closely matches how miette's JSON Output works in practice +//! today: every field is always emitted, and it just emits an empty string or +//! an empty array when there's no value. So in practice the +//! `#[serde(default)]`s won't ever be stressed, because miette itself pre-bakes +//! them in. So write code that's aware of empty strings! +//! +//! You also need to be tolerant of additional things being added in the future, +//! but thankfully that's just how Json Schema and serde already work, by +//! silently dropping unknown values on the floor... except for enum variants. +//! +//! We had to add an extra Unknown variant to every enum to capture "unknown +//! variants". Simply making the enum `#[non_exhaustive]` is insufficient +//! because the Rust compiler needs to put *something* there at runtime. +//! +//! [schemars]: https://docs.rs/schemars/latest/schemars/ + +#[cfg(feature = "schemars")] +use schemars::JsonSchema; +#[cfg(feature = "serde")] +use serde::{Deserialize, Serialize}; + +/// A miette diagnostic, the top level type of miette's json output +#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] +#[cfg_attr(feature = "schemars", derive(JsonSchema))] +#[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash, Default)] +pub struct Diagnostic { + /// The primary error message + #[serde(default)] + message: String, + /// The error code + /// + /// e.g. "oops::my::bad" or "E1312" + #[serde(default)] + code: String, + /// The severity of the error (error, warning, advice, ...) + #[serde(default)] + severity: Severity, + /// The underlying causes of this error (similar to a backtrace) + #[serde(default)] + causes: Vec, + /// A URL to visit to get more information on this error + #[serde(default)] + url: String, + /// An additional piece of advice on how to address the diagnostic + /// + /// e.g. "try removing this trailing comma" + #[serde(default)] + help: String, + /// Labels/spans referring to the locations in the source that are relevant + /// to the diagnostic + /// + /// See "filename" for the source file these labels refer to + /// + /// e.g. "here's the extra comma you should remove" (offset: 100, len: 1) + #[serde(default)] + labels: Vec