Fork Martijn's repo (#2)

* Alter package.json

* add typescript

* Add CI stuff

* Typescript migration

* Add prettier

* Bump deps

* Add types

* Fix types

* Alter example project

* Fix CI

* Use pnpm 9

* Force corepack

* Prepare initial publish

* Alter links

Author: alexaka1

.editorconfig

@@ -8,3 +8,14 @@ indent_style = space
 insert_final_newline = true
 tab_width = 2
 trim_trailing_whitespace = true
+quote_type = single
+
+[*.md]
+trim_trailing_whitespace = false
+max_line_length = 0
+
+[{*.yaml,*.yml}]
+quote_type = single
+
+[{*.json}]
+quote_type = double

.gitattributes

@@ -0,0 +1,8 @@
+# https://www.aleksandrhovhannisyan.com/blog/crlf-vs-lf-normalizing-line-endings-in-git/#a-simple-gitattributes-config
+# We'll let Git's auto-detection algorithm infer if a file is text. If it is,
+# enforce LF line endings regardless of OS or git configurations.
+* text=auto eol=lf
+
+# Isolate binary files in case the auto-detection algorithm fails and
+# marks them as text files (which could brick them).
+*.{png,jpg,jpeg,gif,webp,woff,woff2} binary

.github/CODEOWNERS

@@ -1 +1 @@
-* @MartijnCuppens
+* @alexaka1

.github/CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
+reported by contacting the project team at [email protected]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

.github/FUNDING.yml

@@ -1 +1 @@
-github: [MartijnCuppens]
+github: [alexaka1]

.github/dependabot.yml

@@ -1,10 +1,10 @@
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
       interval: monthly
-  - package-ecosystem: "github-actions"
-    directory: "/examples/"
+  - package-ecosystem: 'github-actions'
+    directory: '/examples/'
     schedule:
       interval: monthly

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: 'pnpm'
+
+      - run: corepack enable
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run lint && pnpm run build

.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish
+on:
+  workflow_run:
+    workflows: [CI]
+    branches: [main]
+    types: [completed]
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: 'pnpm'
+
+      - run: corepack enable
+      - run: pnpm install --frozen-lockfile
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: pnpm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -3,7 +3,7 @@ name: Tests
 on:
   push:
     branches-ignore:
-      - "dependabot/**"
+      - 'dependabot/**'
   pull_request:
   workflow_dispatch:
 
@@ -18,20 +18,23 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [16, 18, 20]
+        node: [18, 20, 22]
 
     steps:
       - name: Clone repository
         uses: actions/checkout@v4
-
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-          cache: npm
+          cache: 'pnpm'
 
-      - name: Install npm dependencies
-        run: npm ci
+      - run: corepack enable
+      - name: Install pnpm dependencies
+        run: pnpm install --frozen-lockfile
 
       - name: Run examples
         run: cd examples && npm run build

.gitignore

@@ -1 +1,25 @@
 node_modules
+dist
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml

.idea/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+pnpm-lock.yaml

.idea/encodings.xml

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Martijn Cuppens
+Copyright (c) 2024 Alex Martossy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.idea/misc.xml

@@ -1,6 +1,8 @@
 # Tailwind OKLCH
 
-view on: [npm](https://www.npmjs.com/package/tailwindcss-oklch) - [GitHub](https://github.com/MartijnCuppens/tailwindcss-oklch)
+view on: [npm](https://www.npmjs.com/package/@alexaka1/tailwindcss-oklch) - [GitHub](https://github.com/alexaka1/tailwindcss-oklch)
+
+This repo was cloned from [Martijn Cuppens's tailwindcss-oklch](https://github.com/MartijnCuppens/tailwindcss-oklch). Special thanks to Martijn for creating this plugin.
 
 Brings OKLCH to Tailwind and introduces these helpful utilities:
 
@@ -23,10 +25,8 @@ Then, enable the plugin in your Tailwind config:
 ```js
 /** @type {import('tailwindcss').Config} */
 module.exports = {
-  plugins: [
-    require('tailwindcss-oklch')(),
-  ],
-}
+  plugins: [require('tailwindcss-oklch')()],
+};
 ```
 
 ## Features
@@ -65,13 +65,15 @@ Precision was added since color.js uses floats to calculate the OKLCH values, wh
 ```js
 /** @type {import('tailwindcss').Config} */
 module.exports = {
-  plugins: [require('tailwindcss-oklch')({
-    contrastThreshold: .5,
-    precision: 8,
-    minContrastLightness: 0,
-    maxContrastLightness: 1,
-  })],
-}
+  plugins: [
+    require('tailwindcss-oklch')({
+      contrastThreshold: 0.5,
+      precision: 8,
+      minContrastLightness: 0,
+      maxContrastLightness: 1,
+    }),
+  ],
+};
 ```
 
 ## Demo
@@ -126,8 +128,8 @@ You can later on change the colors without recompiling by setting the LCH values
 ```css
 @layer base {
   :root {
-    --color-primary-l: .32;
-    --color-primary-c: .1;
+    --color-primary-l: 0.32;
+    --color-primary-c: 0.1;
     --color-primary-h: 150;
   }
 }

.idea/modules.xml

@@ -0,0 +1 @@
+!/dist/main.css