rainbowbrackets - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

.github/ISSUE_TEMPLATE/bug_report.md

+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Current Behavior
+
+<!-- Describe how the issue manifests. -->
+
+## Expected Behavior
+
+<!-- Describe what the desired behavior would be. -->
+
+## Steps to Reproduce the Problem
+
+  1.
+  1.
+  1.
+
+## Environment
+
+- Version: <!-- Version set in package.json -->
+- Platform: <!-- Win/Mac/Linux -->
+- Node.js Version: <!-- Output of running `node -v` -->

.github/ISSUE_TEMPLATE/feature_request.md

+---
+name: 🌈 Feature request
+about: Suggest an amazing new idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Request
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Are you willing to resolve this issue by submitting a Pull Request?
+
+<!--
+  Remember that first-time contributors are welcome! 🙌
+-->
+
+- [ ] Yes, I have the time, and I know how to start.
+- [ ] Yes, I have the time, but I don't know how to start. I would need guidance.
+- [ ] No, I don't have the time, although I believe I could do it if I had the time...
+- [ ] No, I don't have the time and I wouldn't even know how to start.
+
+<!--
+  👋 Have a great day and thank you for the feature request!
+-->

contributing/contributing.md

+# Contributing to rainbowBrackets
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
+
+
+## Code of Conduct
+
+Practice kindness, respect and patience.
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [CodeMirror Documentation](https://codemirror.net/docs/) and have familiarized yourself with how extensions work in CodeMirror6. I specifically recommend the CodeMirror forum for discussion of common topics/goals.
+
+If you then still have a question and need clarification:
+
+- Open an [Issue](/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+## I Want To Contribute
+
+See [BUG_REPORT.md](BUG_REPORT.md) and [PULL_REQUEST.md](PULL_REQUEST.md) for ways to get started.
+
+> ### Legal Notice
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you down for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [CodeMirror Documentation](https://codemirror.net/docs/)).
+- Double check if this error is already being addressed via active issue.
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+
+#### How Do I Submit a Good Bug Report?
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](/issues/new).
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- I (or hopefully a contributor one day!) will investigate.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be addressed shortly.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for rainbowBrackets, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+- To expand on the above, the beauty of CodeMirror is its customization and modularity - if you believe your enhancement to be worthy of its own extension, simply publish it as such.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+- **Explain why this enhancement would be useful** to most rainbowBrackets users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+## Attribution
+These contribution guidelines are based on **contributing.md**. [Make your own](https://contributing.md/)!

package.json

 {
   "name": "rainbowbrackets",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "colorizes brackets, parentheses and braces to help track scope",
@@ -26,10 +26,4 @@ "main": "rainbowBrackets.js",
   "dependencies": {
-    "@codemirror/view": "^6.9.5",
-    "rainbowbrackets": "^2.0.0"
-  },
-  "devDependencies": {
-    "terser-webpack-plugin": "^5.3.7",
-    "webpack": "^5.80.0",
-    "webpack-cli": "^5.0.1"
+    "@codemirror/view": "^6.9.5"
   }
 }

rainbowBrackets.js

@@ -49,2 +49,3 @@ import { EditorView, Decoration, ViewPlugin } from '@codemirror/view';
 
+  // eslint-disable-next-line class-methods-use-this
   getMatchingBracket(closingBracket) {
@@ -51,0 +52,0 @@ switch (closingBracket) {

README.md

@@ -53,3 +53,3 @@ ![new hero](https://user-images.githubusercontent.com/114263701/232826474-ba2778e6-c37f-4146-bbcc-bba9f92fb744.png)
 
->Fixed as of 2.0.0. See updated API Reference.
+>Nearly Fixed as of 2.0.0. See updated API Reference.
 
@@ -56,0 +56,0 @@ ```javascript

test.js

-const rainbowBrackets = require('./rainbowBrackets.js')
-
-console.log(rainbowBrackets)

webpack.config.js

-const TerserPlugin = require('terser-webpack-plugin');
-
-module.exports = {
-  mode: 'production',
-  entry: './rainbowBrackets.js',
-  output: {
-    filename: 'rainbowBrackets.min.js',
-  },
-  optimization: {
-    minimize: true,
-    minimizer: [new TerserPlugin()],
-  },
-};

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

-50%

Dev dependency count

0

-100%

Number of low quality alerts

1

-50%

Number of low supply chain risk alerts

0

-100%

Worsened metrics

Total package byte prevSize

18117

-90.08%

Lines of code

72

-13.25%

Dependency changes

• - Removed

  rainbowbrackets@^2.0.0