diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7fad5bc --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/codespan-reporting-0.9.5.crate diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index 371cae1..1793ce5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,138 @@ -# rust-codespan-reporting +# codespan-reporting -The rust-codespan-reporting package +[![Continuous integration][actions-badge]][actions-url] +[![Crates.io][crate-badge]][crate-url] +[![Docs.rs][docs-badge]][docs-url] +[![Gitter][gitter-badge]][gitter-lobby] + +[actions-badge]: https://img.shields.io/github/workflow/status/brendanzab/codespan/Continuous%20integration +[actions-url]: https://github.com/brendanzab/codespan/actions +[crate-url]: https://crates.io/crates/codespan-reporting +[crate-badge]: https://img.shields.io/crates/v/codespan-reporting.svg +[docs-url]: https://docs.rs/codespan-reporting +[docs-badge]: https://docs.rs/codespan-reporting/badge.svg +[gitter-badge]: https://badges.gitter.im/codespan-rs/codespan.svg +[gitter-lobby]: https://gitter.im/codespan-rs/Lobby + +Beautiful diagnostic reporting for text-based programming languages. + +![Example preview](./codespan-reporting/assets/readme_preview.svg?sanitize=true) + +Languages like Rust and Elm already support beautiful error reporting output, +but it can take a significant amount work to implement this for new programming +languages! The `codespan-reporting` crate aims to make beautiful error +diagnostics easy and relatively painless for everyone! + +We're still working on improving the crate to help it support broader use cases, +and improving the quality of the diagnostic rendering, so stay tuned for +updates and please give us feedback if you have it. Contributions are also very +welcome! + +## Example + +```rust +use codespan_reporting::diagnostic::{Diagnostic, Label}; +use codespan_reporting::files::SimpleFiles; +use codespan_reporting::term::termcolor::{ColorChoice, StandardStream}; + +// `files::SimpleFile` and `files::SimpleFiles` help you get up and running with +// `codespan-reporting` quickly! More complicated use cases can be supported +// by creating custom implementations of the `files::Files` trait. + +let mut files = SimpleFiles::new(); + +let file_id = files.add( + "FizzBuzz.fun", + unindent::unindent( + r#" + module FizzBuzz where + + fizz₁ : Nat → String + fizz₁ num = case (mod num 5) (mod num 3) of + 0 0 => "FizzBuzz" + 0 _ => "Fizz" + _ 0 => "Buzz" + _ _ => num + + fizz₂ : Nat → String + fizz₂ num = + case (mod num 5) (mod num 3) of + 0 0 => "FizzBuzz" + 0 _ => "Fizz" + _ 0 => "Buzz" + _ _ => num + "#, + ), +); + +// We normally recommend creating a custom diagnostic data type for your +// application, and then converting that to `codespan-reporting`'s diagnostic +// type, but for the sake of this example we construct it directly. + +let diagnostic = Diagnostic::error() + .with_message("`case` clauses have incompatible types") + .with_code("E0308") + .with_labels(vec![ + Label::primary(file_id, 328..331).with_message("expected `String`, found `Nat`"), + Label::secondary(file_id, 211..331).with_message("`case` clauses have incompatible types"), + Label::secondary(file_id, 258..268).with_message("this is found to be of type `String`"), + Label::secondary(file_id, 284..290).with_message("this is found to be of type `String`"), + Label::secondary(file_id, 306..312).with_message("this is found to be of type `String`"), + Label::secondary(file_id, 186..192).with_message("expected type `String` found here"), + ]) + .with_notes(vec![unindent::unindent( + " + expected type `String` + found type `Nat` + ", + )]); + +// We now set up the writer and configuration, and then finally render the +// diagnostic to standard error. + +let writer = StandardStream::stderr(ColorChoice::Always); +let config = codespan_reporting::term::Config::default(); + +term::emit(&mut writer.lock(), &config, &files, &diagnostic)?; +``` + +## Running the CLI example + +To get an idea of what the colored CLI output looks like, +clone the [repository](https://github.com/brendanzab/codespan) +and run the following shell command: + +```sh +cargo run --example term +``` + +More examples of using `codespan-reporting` can be found in the +[examples directory](./codespan-reporting/examples). + +## Projects using codespan-reporting + +`codespan-reporting` is currently used in the following projects: + +- [Arret](https://arret-lang.org) +- [cargo-deny](https://github.com/EmbarkStudios/cargo-deny) +- [CXX](https://github.com/dtolnay/cxx) +- [Gleam](https://github.com/lpil/gleam/) +- [Gluon](https://github.com/gluon-lang/gluon) +- [MDBook LinkCheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck) +- [Nushell](https://www.nushell.sh/) +- [Pikelet](https://github.com/pikelet-lang/pikelet) + +## Alternatives to codespan-reporting + +There are a number of alternatives to `codespan-reporting`, including: + +- [annotate-snippets][annotate-snippets] +- [codemap][codemap] +- [language-reporting][language-reporting] (a fork of codespan) + +These are all ultimately inspired by rustc's excellent [error reporting infrastructure][librustc_errors]. + +[annotate-snippets]: https://crates.io/crates/annotate-snippets +[codemap]: https://crates.io/crates/codemap +[language-reporting]: https://crates.io/crates/language-reporting +[librustc_errors]: https://github.com/rust-lang/rust/tree/master/src/librustc_errors diff --git a/rust-codespan-reporting.spec b/rust-codespan-reporting.spec new file mode 100644 index 0000000..c8d1eda --- /dev/null +++ b/rust-codespan-reporting.spec @@ -0,0 +1,106 @@ +# Generated by rust2rpm 16 +%bcond_without check +%global debug_package %{nil} + +%global crate codespan-reporting +%global github_project brendanzab/codespan + +Name: rust-%{crate} +Version: 0.9.5 +Release: 2%{?dist} +Summary: Beautiful diagnostic reporting for text-based programming languages + +# Upstream license specification: Apache-2.0 +License: ASL 2.0 +URL: https://crates.io/crates/codespan-reporting +Source: %{crates_source} +Source: https://raw.githubusercontent.com/%{github_project}/v%{version}/README.md +Source: https://raw.githubusercontent.com/%{github_project}/v%{version}/LICENSE + +ExclusiveArch: %{rust_arches} +%if %{__cargo_skip_build} +BuildArch: noarch +%endif + +BuildRequires: rust-packaging + +%global _description %{expand: +Beautiful diagnostic reporting for text-based programming languages.} + +%description %{_description} + +%package devel +Summary: %{summary} +BuildArch: noarch + +%description devel %{_description} + +This package contains library source intended for building other packages +which use "%{crate}" crate. + +%files devel +%{cargo_registry}/%{crate}-%{version_no_tilde}/ +%doc README.md +%license LICENSE + +%package -n %{name}+default-devel +Summary: %{summary} +BuildArch: noarch + +%description -n %{name}+default-devel %{_description} + +This package contains library source intended for building other packages +which use "default" feature of "%{crate}" crate. + +%files -n %{name}+default-devel +%ghost %{cargo_registry}/%{crate}-%{version_no_tilde}/Cargo.toml + +%package -n %{name}+serde-devel +Summary: %{summary} +BuildArch: noarch + +%description -n %{name}+serde-devel %{_description} + +This package contains library source intended for building other packages +which use "serde" feature of "%{crate}" crate. + +%files -n %{name}+serde-devel +%ghost %{cargo_registry}/%{crate}-%{version_no_tilde}/Cargo.toml + +%package -n %{name}+serialization-devel +Summary: %{summary} +BuildArch: noarch + +%description -n %{name}+serialization-devel %{_description} + +This package contains library source intended for building other packages +which use "serialization" feature of "%{crate}" crate. + +%files -n %{name}+serialization-devel +%ghost %{cargo_registry}/%{crate}-%{version_no_tilde}/Cargo.toml + +%prep +%autosetup -n %{crate}-%{version_no_tilde} -p1 +%cargo_prep +cp -prt "${PWD}" '%{SOURCE1}' '%{SOURCE2}' + +%generate_buildrequires +%cargo_generate_buildrequires -a + +%build +%cargo_build -a + +%install +%cargo_install -a + +%if %{with check} +%check +%cargo_test -a +%endif + +%changelog +* Fri Feb 05 2021 Jan Staněk - 0.9.5-2 +- Import README.md and LICENSE from upstream git repository + +* Mon Feb 01 11:50:43 CET 2021 Jan Staněk - 0.9.5-1 +- Initial package diff --git a/sources b/sources new file mode 100644 index 0000000..663baf1 --- /dev/null +++ b/sources @@ -0,0 +1 @@ +SHA512 (codespan-reporting-0.9.5.crate) = f48954f8ba01a0c25035e7afe21de30d3202c4c53077a1f2d86e2aa615206ff34c9e8671e3c0090c8b609c7e2869ef63e984dfe5a5ec534f1b73b83799c893a1