Merge pull request #31 from billyeatcookies/dev

Update cupcake core
tomlin7 · Jul 21, 2023 · d60406b · d60406b
2 parents 0f67d85 + 694bc3c
commit d60406b
Show file tree

Hide file tree

Showing 83 changed files with 3,114 additions and 1,907 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v3
@@ -28,7 +28,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r requirements.txt
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -5,7 +5,7 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Python: Current File",
+            "name": "Python: Cupcake basic example",
             "type": "python",
             "request": "launch",
             "program": "examples/basic.py",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+<!-- insertion marker -->
+## Unreleased
+
+<small>[Compare with latest](https://github.com/billyeatcookies/cupcake/compare/v0.2.0-alpha...HEAD)</small>
+
+### Added
+
+- Add Screenshots ([4a904b9](https://github.com/billyeatcookies/cupcake/commit/4a904b9822d0b1671df9544de5d3d19e5370e3a8) by Billy).
+- Add quick start ([328df21](https://github.com/billyeatcookies/cupcake/commit/328df2156bc1480b786d455303072d969e6f9e06) by Billy).
+- Add feature list ([1ee937e](https://github.com/billyeatcookies/cupcake/commit/1ee937e2e6cf6ae71b053dbd2e3d5e0f53273f9f) by Billy).
+- Add docs ([f7cc3d6](https://github.com/billyeatcookies/cupcake/commit/f7cc3d61d3907b619b39dde4b6bca9376ea41925) by Billy).
+- Add contributing guidelines ([07a8bd0](https://github.com/billyeatcookies/cupcake/commit/07a8bd07916c932d08e9b22a6033eae07d1a134d) by Billy).
+- Add poetry for packaging and dependancy management ([9358b0e](https://github.com/billyeatcookies/cupcake/commit/9358b0e5ff219b201d4c39031c9e2b5026880ac7) by Billy).
+- Add find-replace to feature list ([1f18d8c](https://github.com/billyeatcookies/cupcake/commit/1f18d8cf0cb458e0c5adf01f6548638eb8248dad) by Billy).
+- Add links ([df7b6e7](https://github.com/billyeatcookies/cupcake/commit/df7b6e77b800dc33b89af32cf9e81a9f051aa3fa) by Billy).
+- Add images ([d55cc54](https://github.com/billyeatcookies/cupcake/commit/d55cc54e2b99581d8f4993225e4e375c0c1f2feb) by Billy).
+
+### Fixed
+
+- fix: Get the editor running fine ([afb66e9](https://github.com/billyeatcookies/cupcake/commit/afb66e9f59c6fdb5115583948b026374fddc3083) by Billy).
+- Fix line selection from line numbers ([c432bd8](https://github.com/billyeatcookies/cupcake/commit/c432bd8048313062ab3a53427577722448514773) by Billy).
+- Fix typo ([3481940](https://github.com/billyeatcookies/cupcake/commit/3481940e0c2140e14e157f46faa7c22e683d4b50) by Billy).
+- Fix in readme ([4379449](https://github.com/billyeatcookies/cupcake/commit/4379449b689efdee7f0537796c34ff73b3c5f45b) by Billy).
+- Fix tests, update readme ([0a42d23](https://github.com/billyeatcookies/cupcake/commit/0a42d23a2612ec5f4d2f377c40f2d40fbf52711e) by Billy).
+- Fix tests and attribute errors ([68afd28](https://github.com/billyeatcookies/cupcake/commit/68afd285579db1a98b8c2f682dd806656ecbd342) by Billy).
+- Fix autocomplete borders ([8b4adc1](https://github.com/billyeatcookies/cupcake/commit/8b4adc1eedacbd0ad430090474228b66b88c7b34) by Billy).
+- fix conflicts ([07aba0c](https://github.com/billyeatcookies/cupcake/commit/07aba0cee2eb2db98ae538e9ff3c51ba78c0331c) by cid0rz).
+- Fix entry indixes ([9908634](https://github.com/billyeatcookies/cupcake/commit/99086347e3b1e919a90bcbb97754c45df3a304c2) by Billy).
+- Fix the big issue slowing down editor ([3b3d0c9](https://github.com/billyeatcookies/cupcake/commit/3b3d0c9b061741f8fed561a95180768e729e9193) by billyeatcookies).
+
+### Changed
+
+- Change version to 0.5.1 ([e32417b](https://github.com/billyeatcookies/cupcake/commit/e32417ba75199eabb09f47edc938c3a0d82554e6) by Billy).
+
+### Removed
+
+- remove docs page ([8cd0f9a](https://github.com/billyeatcookies/cupcake/commit/8cd0f9a850f4d956423131fbf22c9d8b1e1999b8) by Billy).
+- remove docs ([5845bf9](https://github.com/billyeatcookies/cupcake/commit/5845bf9708b1597e68c3923cd6d50d530e0d8530) by Billy).
+- Remove unnecessary logs for scroll events ([9665e47](https://github.com/billyeatcookies/cupcake/commit/9665e47cb645659061509cd8d162f768b3940b2f) by Billy).
+- Remove proposals ([d9a6648](https://github.com/billyeatcookies/cupcake/commit/d9a6648bfb10633ac56e29b41222f93f79077eb7) by Billy).
+- Remove clear_selection ([7977a63](https://github.com/billyeatcookies/cupcake/commit/7977a63a863b774df6c1af306521ece23679bc24) by Billy).
+- Remove Find Replace feature from list ([13fb9da](https://github.com/billyeatcookies/cupcake/commit/13fb9dacedbd0ada5ef6943ccd252199b434e1cf) by Billy).
+
+<!-- insertion marker -->
+## [v0.2.0-alpha](https://github.com/billyeatcookies/cupcake/releases/tag/v0.2.0-alpha) - 2022-03-29
+
+<small>[Compare with first commit](https://github.com/billyeatcookies/cupcake/compare/2df53a1562c4c349c90554342ff352b567a72754...v0.2.0-alpha)</small>
+
+### Added
+
+- Add homepage ([7ed5cc1](https://github.com/billyeatcookies/cupcake/commit/7ed5cc18b655f017914657f4b3127e4600e3b875) by billyeatcookies).
+- Add proposals ([30cc23a](https://github.com/billyeatcookies/cupcake/commit/30cc23a8e3bb004aedea1cb7bab37b5f9b973f7e) by Billy).
+- Add minimap ([4c98445](https://github.com/billyeatcookies/cupcake/commit/4c984451a96ce4a6105ac72d3e58e3904771106b) by billyeatcookies).
+- Add `/docs` ([6f8ceb9](https://github.com/billyeatcookies/cupcake/commit/6f8ceb9ffe3f43e87565c97e5b82820285ae7575) by billyeatcookies).
+
+### Fixed
+
+- Fix: autocomplete window not hiding on no results ([400dede](https://github.com/billyeatcookies/cupcake/commit/400dede5718523dbaf4a8b8f6585175b56343aa3) by billyeatcookies).
+- Fix highlighting issues ([8a6711f](https://github.com/billyeatcookies/cupcake/commit/8a6711f17784480771cb808055273c5c0ba4c45e) by billyeatcookies).
+- Fix resizing issues, auto indentation, zoom, drag n drop ([ef1a3da](https://github.com/billyeatcookies/cupcake/commit/ef1a3da36e459c9167b6dccafa3c3df4fc76111f) by billyeatcookies).
+
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,20 +1,33 @@
-# CONTRIBUTING
-Thank you for considering to contribute to Cupcake! To keep the code clean and for understanding our naming conventions, here are some  guidelines and a list of coding tools used. 
+<h1 align="center">CONTRIBUTING</h1>
 
-## Dependencies
-For package management and dependencies this project uses [**poetry**](https://python-poetry.org/docs/#installation)
+## Cupcake Developer Guide
+Welcome to the Contributing Guidelines for Cupcake. Your contributions and support are greatly appreciated! 🧡
+> **Note**
+> You will need [Git](https://git-scm.com/) installed to follow the steps below!
 
-After installation of poetry, you will be able to install all dependencies of cupcake with the following command
-```
-poetry install
-``` 
+## Fixing an issue/adding a feature
+Here are the basic steps needed to get set up and contribute a patch.
 
-## Running Tests 
-Cupcake uses [**pytest**](https://docs.pytest.org/) to run tests. After installation of poetry, you will be able to run the following command
-```
-poetry run pytest
-```
-Otherwise, you can also run pytest directly
-```
-pytest tests
+1. [**Fork**](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the Cupcake repository to your GitHub account and get the source code using:
+
+```bash
+git clone https://github.com/<your_username>/Cupcake.git
+cd Cupcake
 ```
+2. We appreciate using a [**Release of Biscuit**](https://github.com/billyeatcookies/Biscuit/releases) itself for development, but you can use your preferred editor. Open the project directory in your preferred environment.
+3. **Open an issue** report in the [issue tracker](https://github.com/billyeatcookies/Cupcake/issues) if the issue has not been reported/proposed yet. 
+
+4. Switch to a new local branch where your work for the issue will go (format it `fix-#` or `feat-#` if you are having trouble naming)
+    ```
+    git checkout -b fix-123 main
+    ```
+5. Once you fixed the issue, try running the related examples, and check no errors are occuring, if everything is ok, commit with a proper message regarding what has been fixed.
+6. You can run the changelog command (not mandatory, requires `pip install git-changelog`):
+    ```
+    git-changelog -o CHANGELOG.md
+    ```
+    This will update the changelog, and now commit the changes.
+7. Push the branch on your fork on GitHub and create a pull request. Include `fix: #` in the description
+    ```
+    fix: #123, Fix x bug in y module
+    ```
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions of Cupcakes are currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.20.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Go the discussions tab of the repo and you can open a discussion there, and we will look into it! you can expect to get an update on the reported vulnerability within a few days, we will try to fix it quickly if its accepted.