diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..db38378 --- /dev/null +++ b/contributing.md @@ -0,0 +1,72 @@ + + +# Contributing to + +Firstly, thank you for taking an interesting in contributing! is an +open-source project, and welcomes contributions in the form of feature code, +bug reports and fixes, tests, feature suggestions and anything else which may +help to make it better software. + +## Before Starting + +It’s a good idea to [discuss](https://discord.gg/7b6mpF6Qcf) potential +changes with one of the maintainers before starting work. Although efforts are +made to document future development work using the [issue tracker](/issues), it +will not always be up-to-date, and the maintainers may have useful information +to share on plans. + +The worst-case scenario would be for a contributor to spend a large amount of +time producing a PR, only for it to be rejected by the maintainers because it +is not consistent with their plans. A quick conversation before starting work +can save a lot of time. + +If a response is not forthcoming in the [Discord +chatroom](https://discord.gg/7b6mpF6Qcf), contacting one of the project +maintainers directly _but publicly_ may help. Please __do not__ contact the +maintainers privately, as it misses a good opportunity to share knowledge with +a wide audience. Jon Pretty can usually be contacted [on +X](https://x.com/propensive). + +All development work—whether bugfixing or implementing new +features—should have a corresponding issue before work starts. If you +have commit rights to the `propensive/` repository, push to a branch named +after the issue number, prefixed with `issue/`, for example, `issue/423`. + +## Contribution standards + +Pull requests should try to follow the coding style of existing code in the +repository. They are unlikely to be rejected on grounds of formatting, except +in extreme cases. does not use automatic code-formatting because it +has proven to produce unreliable results (and furthermore, hand-formatting is +not particularly laborious). + +Unfortunately an official coding style guide does not yet exist. + +Any code that is inconsistently formatted will be fixed before merging, without +complaint. + +Pull requests should have at least one review before being merged. When opening +a PR, contributors are welcome to suggest a reviewer. Pull requests should be +left in _draft_ mode until they are believed to be ready for review. + +For code contributions, we prefer pull requests with corresponding tests. But +we should not _let perfect be the enemy of the good_. Changes which break +existing tests, however, are likely to be rejected during review. + +## Reporting issues + +New issues are welcome, both as bug reports and feature suggestions. More +detail is preferable, and the clearest and most detailed reports will most +likely be addressed sooner, but a short report from a busy developer is still +preferred over a bug we never hear about. We will ask for more detail in triage +if it’s needed. + +## Conduct + +Contributors and other participants in online discussions are expected to be +polite, on-topic and to nurture a pleasant development environment for all +’s users. Propensive OÜ reserves the right to censure +and—in extreme cases—ban users whose behavior, in their opinion, is +detrimental toward this goal. But individualism is valued, and nobody should +feel constrained in how they express themselves. + diff --git a/doc/images/1000x1000.png b/doc/images/1000x1000.png new file mode 100644 index 0000000..d5f168f Binary files /dev/null and b/doc/images/1000x1000.png differ diff --git a/doc/images/128x128.png b/doc/images/128x128.png new file mode 100644 index 0000000..7c3072f Binary files /dev/null and b/doc/images/128x128.png differ diff --git a/doc/images/16x16.png b/doc/images/16x16.png new file mode 100644 index 0000000..6f9662a Binary files /dev/null and b/doc/images/16x16.png differ diff --git a/doc/images/200x200.png b/doc/images/200x200.png new file mode 100644 index 0000000..cdc828b Binary files /dev/null and b/doc/images/200x200.png differ diff --git a/doc/images/2400x2400@300dpi.png b/doc/images/2400x2400@300dpi.png new file mode 100644 index 0000000..a6945f5 Binary files /dev/null and b/doc/images/2400x2400@300dpi.png differ diff --git a/doc/images/48x48.png b/doc/images/48x48.png new file mode 100644 index 0000000..c2d8342 Binary files /dev/null and b/doc/images/48x48.png differ diff --git a/doc/images/github.png b/doc/images/github.png new file mode 100644 index 0000000..29795ce Binary files /dev/null and b/doc/images/github.png differ diff --git a/license.md b/license.md new file mode 100644 index 0000000..fb6e50b --- /dev/null +++ b/license.md @@ -0,0 +1,194 @@ +# Apache License + +_Version 2.0, January 2004_ +_[http://www.apache.org/licenses/](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 new file mode 100644 index 0000000..984f175 --- /dev/null +++ b/readme.md @@ -0,0 +1,135 @@ +[GitHub Workflow](https://github.com/propensive//actions) +[](https://discord.gg/7b6mpF6Qcf) + + +# + +____ + + + +## Features + + + +## Availability Plan + + has not yet been published. The medium-term plan is to build +with [Fury](https://github.com/propensive/fury) and to publish it as a source build on +[Vent](https://github.com/propensive/vent). This will enable ordinary users to write and build +software which depends on . + +Subsequently, will also be made available as a binary in the Maven +Central repository. This will enable users of other build tools to use it. + +For the overeager, curious and impatient, see [building](#building). + +## Getting Started + + + +## Status + + is classified as ____. For reference, Scala One projects are +categorized into one of the following five stability levels: + +- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity +- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns +- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement +- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later +- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated + +Projects at any stability level, even _embryonic_ projects, can still be used, +as long as caution is taken to avoid a mismatch between the project's stability +level and the required stability and maintainability of your own project. + + is designed to be _small_. Its entire source code currently consists +of 98 lines of code. + +## Building + + will ultimately be built by Fury, when it is published. In the +meantime, two possibilities are offered, however they are acknowledged to be +fragile, inadequately tested, and unsuitable for anything more than +experimentation. They are provided only for the necessity of providing _some_ +answer to the question, "how can I try ?". + +1. *Copy the sources into your own project* + + Read the `fury` file in the repository root to understand 's build + structure, dependencies and source location; the file format should be short + and quite intuitive. Copy the sources into a source directory in your own + project, then repeat (recursively) for each of the dependencies. + + The sources are compiled against the latest nightly release of Scala 3. + There should be no problem to compile the project together with all of its + dependencies in a single compilation. + +2. *Build with [Wrath](https://github.com/propensive/wrath/)* + + Wrath is a bootstrapping script for building and other projects in + the absence of a fully-featured build tool. It is designed to read the `fury` + file in the project directory, and produce a collection of JAR files which can + be added to a classpath, by compiling the project and all of its dependencies, + including the Scala compiler itself. + + Download the latest version of + [`wrath`](https://github.com/propensive/wrath/releases/latest), make it + executable, and add it to your path, for example by copying it to + `/usr/local/bin/`. + + Clone this repository inside an empty directory, so that the build can + safely make clones of repositories it depends on as _peers_ of ``. + Run `wrath -F` in the repository root. This will download and compile the + latest version of Scala, as well as all of 's dependencies. + + If the build was successful, the compiled JAR files can be found in the + `.wrath/dist` directory. + +## Contributing + +Contributors to are welcome and encouraged. New contributors may like +to look for issues marked +[beginner](https://github.com/propensive//labels/beginner). + +We suggest that all contributors read the [Contributing +Guide](/contributing.md) to make the process of contributing to +easier. + +Please __do not__ contact project maintainers privately with questions unless +there is a good reason to keep them private. While it can be tempting to +repsond to such questions, private answers cannot be shared with a wider +audience, and it can result in duplication of effort. + +## Author + + was designed and developed by Jon Pretty, and commercial support and +training on all aspects of Scala 3 is available from [Propensive +OÜ](https://propensive.com/). + + + +## Name + + + +In general, Scala One project names are always chosen with some rationale, +however it is usually frivolous. Each name is chosen for more for its +_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no +bias towards names with positive or "nice" meanings—since many of the libraries +perform some quite unpleasant tasks. + +Names should be English words, though many are obscure or archaic, and it +should be noted how willingly English adopts foreign words. Names are generally +of Greek or Latin origin, and have often arrived in English via a romance +language. + +## Logo + + + +## License + + is copyright © 2024 Jon Pretty & Propensive OÜ, and +is made available under the [Apache 2.0 License](/license.md). + diff --git a/src/core/parser.scala b/src/core/parser.scala index 1ee00c5..88d87a9 100644 --- a/src/core/parser.scala +++ b/src/core/parser.scala @@ -1,3 +1,19 @@ +/* + , version [unreleased]. Copyright 2024 Jon Pretty, Propensive OÜ. + + The primary distribution site is: https://propensive.com/ + + 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. +*/ + package aristotle import anticipation.* diff --git a/src/test/tests.scala b/src/test/tests.scala index 6fd48a1..5c01d4e 100644 --- a/src/test/tests.scala +++ b/src/test/tests.scala @@ -1,3 +1,19 @@ +/* + , version [unreleased]. Copyright 2024 Jon Pretty, Propensive OÜ. + + The primary distribution site is: https://propensive.com/ + + 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. +*/ + package aristotle import anticipation.*