@evilmartians/harmony - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

dist/base/index.js

@@ -1,3 +0,3 @@
-'use strict';
-module.exports = {
+
+  export default {
   "red": {
@@ -329,2 +329,1 @@ "50": "oklch(0.988281 0.0046875 20)",
 };
-Object.defineProperty(exports, '__esModule', { value: true });

dist/tailwind/index.js

@@ -1,3 +0,3 @@
-'use strict';
-module.exports = {
+
+  export default {
   "inherit": "inherit",
@@ -334,2 +334,1 @@ "current": "currentColor",
 };
-Object.defineProperty(exports, '__esModule', { value: true });

package.json

 {
   "name": "@evilmartians/harmony",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "scripts": {
-    "build": "deno task build",
+    "build": "deno task build && deno task publint",
     "prepublishOnly": "npm run build"
   },
-  "main": "dist/index.js",
+  "type": "module",
   "exports": {
     "./tailwind": {
+      "types": "./dist/tailwind/index.d.ts",
+      "require": "./dist/tailwind/index.cjs",
       "import": "./dist/tailwind/index.js",
-      "require": "./dist/tailwind/index.mjs",
-      "types": "./dist/tailwind/index.d.ts"
+      "default": "./dist/tailwind/index.js"
     },
     "./tailwind.css": "./dist/tailwind/index.css",
     "./base": {
-      "import": "./dist/base/index.mjs",
-      "require": "./dist/base/index.js",
-      "types": "./dist/base/index.d.ts"
+      "types": "./dist/base/index.d.ts",
+      "require": "./dist/base/index.cjs",
+      "import": "./dist/base/index.js",
+      "default": "./dist/base/index.js"
     },
     "./css/*": "./dist/css/*"
   },
-  "files": ["dist/*"],
-  "keywords": ["colors", "palette", "tailwind"],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "dist/*"
+  ],
+  "keywords": [
+    "colors",
+    "palette",
+    "tailwind"
+  ],
   "sideEffects": false,
@@ -30,3 +42,18 @@ "repository": {
   },
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.10",
+    "publint": "^0.2.12",
+    "zod": "^3.23.8"
+  },
+  "devEngines": {
+    "runtime": [
+      {
+        "name": "deno",
+        "version": ">= 2.0.0",
+        "onFail": "error"
+      }
+    ]
+  }
 }

README.md

 ![Harmony](cover.png)
 
+[![github.actions.changesets.badge]][github.actions.changesets] [![MIT][license.badge]][license] [![npm.badge]][npm]
+
 # Harmony: Accessible UI Color Palette
@@ -8,2 +10,3 @@
 is designed to elevate control over color contrast in your design system.
+
 - Uses OKLCH and APCA for highly consistent color shades
@@ -42,3 +45,3 @@ - Has P3 options for modern screens
 /* app.css, or anywhere within Tailwind-aware context */
-@import 'tailwindcss';
+@import "tailwindcss";
 @import "@evilmartians/harmony/tailwind.css";
@@ -87,3 +90,3 @@ ```
 ```css
-@import '@evilmartians/harmony/css/orange.css';
+@import "@evilmartians/harmony/css/orange.css";
 
@@ -99,3 +102,3 @@ h1 {
 ```css
-@import '@evilmartians/harmony/css/index.css';
+@import "@evilmartians/harmony/css/index.css";
 
@@ -121,1 +124,28 @@ /* now you can use any color */
 ```
+
+## Development
+
+### Prerequisites
+
+| Dependency                                           | Version | Description       |
+| ---------------------------------------------------- | ------- | ----------------- |
+| [Deno](https://docs.deno.com/runtime/)               | ^2.0    | Runtime           |
+| [Lefthook](https://github.com/evilmartians/lefthook) | ^0.7.0  | Git-hooks manager |
+
+### Publication Workflow
+
+The project uses [changesets](https://github.com/changesets/changesets) to manage versioning and changelog.
+Typical workflow is as follow:
+
+1. make changes to codebase,
+2. run `deno task changesets` at project root and follow prompt to generate a "changeset" (logging a change),
+3. commit both (1) and (2) into git.
+
+The [changesets Github action](./.github/workflows/changesets.yaml) is triggered on `push` to `main` and will create a corresponding "Changesets: Versioning & Publication" pull request, which, upon merged, will trigger publication of the new version to NPM.
+
+[license.badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[license]: ./LICENSE
+[npm.badge]: https://img.shields.io/npm/v/@evilmartians/harmony
+[npm]: https://www.npmjs.com/package/@evilmartians/harmony
+[github.actions.changesets.badge]: https://github.com/evilmartians/harmony/actions/workflows/changesets.yaml/badge.svg?branch=main
+[github.actions.changesets]: https://github.com/evilmartians/harmony/actions/workflows/changesets.yaml

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

110811

increased by1.88%

Number of lines in readme file

147

increased by25.64%

Is type module

Yes

Worsened metrics

Dev dependency count

4

increased byInfinity%

No dependency changes