Merge pull request #28 from juliamertz/main

Unify theme format & update workflows

Author: juliamertz

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches: main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  check:
+    name: Continuous integration
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Deno
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+
+      - name: Check formatting
+        run: deno fmt --check

.github/workflows/release.yml

@@ -1,28 +1,32 @@
-name: Update release
+name: Release
 
 on:
   push:
     branches:
       - main
     paths:
-      - 'styles/**/rose-pine.user.css'
+      - "styles/**/rose-pine.user.css"
 
 permissions:
   contents: write
 
 jobs:
   release:
-    name: Update release
+    name: Release
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Build
-        run: |
-          bash ./build.sh
-          cd ./scripts && npm install && cd ..
-          node ./scripts/generate-imports.js
+        uses: actions/checkout@v4
+
+      - name: Setup Deno
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+
+      - name: Build import lists
+        run: ./scripts/generate-imports
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release upload userstyle-imports import.json --clobber
+        run: gh release upload userstyle-imports rose-pine*-import.json --clobber

.gitignore

@@ -1,4 +1,4 @@
 scripts/node_modules
 package-lock.json
 bun.lockb
-import.json
+rose-pine*-import.json

.prettierignore

@@ -11,13 +11,20 @@
 
 # Getting started
 
-1. Install the [Stylus](https://github.com/openstyles/stylus) extension for [Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne) or [Firefox](https://addons.mozilla.org/en-GB/firefox/addon/styl-us/).
+1. Install the [Stylus](https://github.com/openstyles/stylus) extension for
+   [Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne)
+   or [Firefox](https://addons.mozilla.org/en-GB/firefox/addon/styl-us/).
 2. Downloading Userstyles:
    - Open the folder of the userstyle you want to install.
-   - Then, click on the "Stylus Install" button or open `rose-pine.user.css` and click on "Raw."
-     > To download all userstyles at once, go to the [releases](https://github.com/rose-pine/userstyles/releases/tag/userstyle-imports) page and follow the instructions listed there.
-3. Optionally, you can configure any available options that you want to change. Then, click on the "Install Style" button.
-4. Some might require extra steps to work correctly, so make sure to check its readme page for additional information.
+   - Then, click on the "Stylus Install" button or open `rose-pine.user.less`
+     and click on "Raw."
+   > To download all userstyles at once, go to the
+   > [releases](https://github.com/rose-pine/userstyles/releases/tag/userstyle-imports)
+   > page and follow the instructions listed there.
+3. Optionally, you can configure any available options that you want to change.
+   Then, click on the "Install Style" button.
+4. Some might require extra steps to work correctly, so make sure to check its
+   readme page for additional information.
 
 ## Userstyles
 
@@ -56,4 +63,9 @@
 
 ## Contributing
 
-Contributions are welcome and appreciated! Please run `sh build.sh` to format the repository before submitting a pull request.
+We use [deno](https://docs.deno.com/runtime/getting_started/installation/) to
+format this repo and for automation, make sure you have it installed.
+
+Contributions are welcome and appreciated! You can create a new userstyle from
+the template by running `./scripts/init Website` Please run `deno fmt` to format
+the repository before submitting a pull request.

build.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env -S deno --allow-read --allow-write
+// vim:ft=javascript
+
+import usercssMeta from "npm:usercss-meta@0.12.0";
+
+async function readTheme(name) {
+  const path = `./styles/${name}/rose-pine.user.less`;
+  const text = await Deno.readTextFile(path);
+  const metadata = usercssMeta.parse(text).metadata;
+  return {
+    enabled: true,
+    name: metadata.name ?? "",
+    description: metadata.description ?? "",
+    author: "Rose Piné",
+    updateUrl: metadata.updateURL ?? "",
+    usercssData: metadata,
+    sourceCode: text.toString(),
+  };
+}
+
+function patchMetadata(theme, defaultVariant) {
+  if (!theme.usercssData?.vars) return theme;
+  const keys = Object.keys(theme.usercssData.vars);
+  if (keys.includes("lightVariant") && keys.includes("darkVariant")) {
+    theme.usercssData.vars.lightVariant.default = "dawn";
+    theme.usercssData.vars.darkVariant.default = defaultVariant;
+  } else if (keys.includes("variant")) {
+    theme.usercssData.vars.variant.default = defaultVariant;
+  } else {
+    console.warn(`Theme ${theme.name} has no variant variable`);
+  }
+  return theme;
+}
+
+let result = [];
+for await (const entry of Deno.readDir(`./styles`)) {
+  try {
+    const theme = await readTheme(entry.name);
+    result.push(theme);
+  } catch (err) {
+    console.error(`ignoring ${entry.name}: ${err}`);
+  }
+}
+
+const settings = {
+  settings: {
+    updateInterval: 24,
+    updateOnlyEnabled: true,
+    patchCsp: true,
+  },
+};
+
+for (const variant of ["main", "moon", "dawn"]) {
+  const patched = result.map((theme) => patchMetadata(theme, variant));
+  const serialized = JSON.stringify([settings, ...patched], null, 2);
+  const filename = `rose-pine${variant == "main" ? "" : `-${variant}`}-import.json`;
+  await Deno.writeTextFile(filename, serialized);
+}

readme.md

@@ -0,0 +1,48 @@
+#!/usr/bin/env -S deno --allow-read --allow-write
+// vim:ft=typescript
+
+function replace(
+  source: string,
+  identifier: string,
+  replacement: string,
+): string {
+  const pattern = new RegExp(`\{\{\s*${identifier}\s*\}\}`, "g");
+  return source.replace(pattern, replacement);
+}
+
+function replaceMap(
+  source: string,
+  substitutions: Record<string, string>,
+): string {
+  let buff = source;
+  for (const [key, value] of Object.entries(substitutions)) {
+    buff = replace(buff, key, value);
+  }
+  return buff;
+}
+
+const substitutions = {
+  title: Deno.args[0],
+  directory: Deno.args[0].toLowerCase(),
+	year: new Date().getUTCFullYear(),
+};
+
+const themePath = `./styles/${substitutions.directory}`;
+await Deno.mkdir(themePath);
+
+const userstyleTemplate = await Deno.readTextFile( "./template/rose-pine.user.less",);
+const readmeTemplate = await Deno.readTextFile("./template/readme.md");
+const licenseTemplate = await Deno.readTextFile("./template/license");
+
+await Deno.writeTextFile(
+  `${themePath}/rose-pine.user.less`,
+  replaceMap(userstyleTemplate, substitutions),
+);
+await Deno.writeTextFile(
+  `${themePath}/readme.md`,
+  replaceMap(readmeTemplate, substitutions),
+);
+await Deno.writeTextFile(
+  `${themePath}/license`,
+  replaceMap(licenseTemplate, substitutions),
+);