Merge pull request #191 from pulsar-edit/badge/linter-stylelint

Badge Notice: Admin Actions Log: `linter-stylelint` to receive: archived, broken badges

docs/reference/Admin_Actions.md

@@ -4,6 +4,12 @@ When you consider that most backend services are a black box of code and decisio
 
 With that said this document will serve as the ongoing history of administrative actions that must be taken against the backend.
 
+## 2023 - August 14
+
+The community package `linter-stylelint` has been discovered to be broken. The source code contains an [error](https://github.com/AtomLinter/linter-stylelint/issues/610) that was originally reported before Pulsar had ever been created. This package's source code has since been archived as of August 7th, 2023. So it is now impossible for this package to ever receive an update to resolve it's issue.
+
+As this package is now permanently broken, and archived, it'll receive both the [`Archived`](./badge-spec.md#archived) and [`Broken`](./badge-spec.md#broken) badges to reflect it's status.
+
 ## 2023 - April 22
 
 The community package `language-nasmx86` has been found to have been removed from GitHub, meaning the package is no longer downloadable.
@@ -19,7 +25,7 @@ By changing the `repository.url` object of the top level `language-pegjs` `packa
 
 ## 2023 - March 28
 
-The following packages will recieve the Outdated Badge:
+The following packages will receive the Outdated Badge:
 
 ### Hydrogen
 
@@ -82,7 +88,7 @@ We removed the following packages due to suspected spam:
 
 ## 2023 - March 18
 
-Removed some community packages during our effort to ensure we only keep packages with licenses that allow for redistribution. The packages listed below either had licenses that outright prohibited redistribution or were otherwise unclear, and after a thourough attempt to contact the publishers we decided to remove the packages. More information on this topic is available on the [Pulsar Blog](https://pulsar-edit.dev/blog/20230319-confused-Techie-HowLicenseNoneDeletedPackages.html)
+Removed some community packages during our effort to ensure we only keep packages with licenses that allow for redistribution. The packages listed below either had licenses that outright prohibited redistribution or were otherwise unclear, and after a thorough attempt to contact the publishers we decided to remove the packages. More information on this topic is available on the [Pulsar Blog](https://pulsar-edit.dev/blog/20230319-confused-Techie-HowLicenseNoneDeletedPackages.html)
 
 * [`bemhtml`](https://github.com/jchouse/bemhtml)
 * [`github-user-datatip`](https://github.com/jgebhardt/atom-github-user-datatip)
@@ -165,7 +171,7 @@ Removed some community packages during our effort to ensure we only keep package
 
 ## 2023 - March 17
 
-Removed some community packages during our effort to ensure we only keep packages with Licenses that allow for redistribution. The packages listed below either had licenses that outright prohibited redistribution or were otherwise unclear, and after a thourough attempt to contact the publishers we had resolved to remove the packages.
+Removed some community packages during our effort to ensure we only keep packages with Licenses that allow for redistribution. The packages listed below either had licenses that outright prohibited redistribution or were otherwise unclear, and after a thorough attempt to contact the publishers we had resolved to remove the packages.
 
 * [`mstest2`](https://github.com/mstest1/mstest2)
 * [`latex-online`](https://github.com/Spijkervet/atom-latex-online)

docs/reference/badge_spec.md

@@ -64,7 +64,7 @@ The `Outdated` badge is used to indicate that the version of a package that may
 
 This badge should only be used when the main functionality of the package is missing/broken/or otherwise non-functional when installed onto Pulsar, in a supported Pulsar configuration.
 
-That is, if a Pulsar user on a supported platform, indepent of any other issues, installs a package and it immediately does not work, displays severe visual bugs, or causes an error message logged as a notification, and there is a fix available for that package within it's source code, that has not been pushed to Pulsar in a reasonable time, then it is eligible to receive this badge.
+That is, if a Pulsar user on a supported platform, independent of any other issues, installs a package and it immediately does not work, displays severe visual bugs, or causes an error message logged as a notification, and there is a fix available for that package within it's source code, that has not been pushed to Pulsar in a reasonable time, then it is eligible to receive this badge.
 
 This badge would be added on a case by case basis, and would likely only be added if Pulsar users are reporting the error.
 
@@ -74,13 +74,13 @@ As with all other badges this badge may be removed at any time, and if you, as a
 
 The `Made for Pulsar!` badge is automatically applied to any community packages that have been published to Pulsar through the PPR. Unlike most other badges, which are applied to the package itself and thus saved in the PPR Database, the `Made for Pulsar!` badge is applied dynamically at the time it is requested from the PPR. Since this badge is applied dynamically there is no real way, currently, to opt out of its usage if a community package maintainer wished to do so.
 
-The `Made for Pulsar!` badge is meant to be a badge of acheivment, showing that your package is more likely to work as expected, and be under active maintainance.
+The `Made for Pulsar!` badge is meant to be a badge of achievement, showing that your package is more likely to work as expected, and be under active maintenance.
 
 ### Broken
 
 The `Broken` badge is used to indicate that the package available on the PPR does not work at all in its current form, on any supported platform. Either requiring manual changes to the source code, or otherwise being unrealistic to fix from the users perspective.
 
-This package likely emits warnings immediatly, or may even cause the editor to crash as a whole. Installation of these packages is not recommended by the Pulsar team, and instead it is encouraged to work with the original maintainer to get these packages working, or otherwise the community is encouraged to maintain and manage a fork of said package.
+This package likely emits warnings immediately, or may even cause the editor to crash as a whole. Installation of these packages is not recommended by the Pulsar team, and instead it is encouraged to work with the original maintainer to get these packages working, or otherwise the community is encouraged to maintain and manage a fork of said package.
 
 If a community member does decide to maintain a fork of a package with a `Broken` badge, it's recommended to make the Pulsar team or Pulsar Backend team (such as by opening an issue on this repo) aware of this, so any warnings and links on the original package can be changed to recommend installation of your functional fork.
 

scripts/tools/add-badge.js

@@ -17,10 +17,10 @@ let sqlStorage;
 /**
  @see https://github.com/pulsar-edit/package-backend/blob/main/docs/reference/badge-spec.md
  Valid Values:
-  - type: <enum|required> The type of badge
-  - title: <enum|required> The title of the badge
-  - text: <string|optional> The text content of the badge
-  - link: <string|optional> A link for the badge
+  - type: <enum|required> The type of badge (info, warn, success)
+  - title: <enum|required> The title of the badge (outdated, broken, archived)
+  - text: <string|optional> The text content of the badge (no periods, fewest words possible)
+  - link: <string|optional> A link for the badge (link to admin actions log)
 */
 let badgeConfig = {
   type: "",
@@ -31,7 +31,7 @@ let badgeConfig = {
 
 let packageName = "";
 
-const VALID_BADGES = ["Outdated", "Broken"];
+const VALID_BADGES = ["Outdated", "Broken", "Archived"];
 const VALID_BADGES_TYPES = ["warn", "info", "success"];
 
 async function main() {