feat: notifier and reglib

.github/dependabot.yaml

@@ -12,3 +12,4 @@ updates:
     schedule:
       interval: weekly
       day: sunday
+    versioning-strategy: increase

.github/workflows/codeql.yaml

@@ -5,14 +5,14 @@ on:
     branches:
       - main
     paths:
-      - package.json
       - src/index.ts
+      - src/types/*.d.ts
   push:
     branches:
       - main
     paths:
-      - package.json
       - src/index.ts
+      - src/types/*.d.ts
 
 permissions:
   actions: read

.github/workflows/commitlint.yaml

@@ -1,7 +1,6 @@
 name: Commit Lint
 
 on:
-  pull_request:
   push:
 
 jobs:
@@ -19,8 +18,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4
@@ -31,7 +28,17 @@ jobs:
       - name: Install Dependencies
         run: pnpm i
 
+      - name: Extract Commit Message (Push)
+        if: ${{ github.event_name }} == 'push'
+        run: |
+          git log -1 --pretty=%B > commit_message.txt
+
+      - name: Extract Commit Message (Pull Request)
+        if: ${{ github.event_name }} == 'pull_request'
+        run: |
+          git show -s --format=%B > commit_message.txt
+
       - name: Lint
-        env:
-          COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
-        run: echo $COMMIT_MESSAGE | pnpm commitlint
+        run: |
+          COMMIT_MESSAGE=$(cat commit_message.txt)
+          echo "$COMMIT_MESSAGE" | pnpm commitlint

.github/workflows/editorconfig.yaml

@@ -1,11 +1,6 @@
 name: Editorconfig
 
 on:
-  workflow_run:
-    workflows:
-      - CodeQL
-    types:
-      - completed
   pull_request:
     branches:
       - main
@@ -17,8 +12,6 @@ jobs:
   editorconfig:
     name: Editorconfig
 
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
@@ -28,8 +21,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.github/workflows/eslint.yaml

@@ -28,8 +28,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.github/workflows/pre-commit.yaml

@@ -20,8 +20,6 @@ jobs:
 
       - name: Setup Python
         uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
 
       - name: Lint
         uses: pre-commit/action@v3.0.1

.github/workflows/prettier.yaml

@@ -1,11 +1,6 @@
 name: Prettier
 
 on:
-  workflow_run:
-    workflows:
-      - CodeQL
-    types:
-      - completed
   pull_request:
     branches:
       - main
@@ -17,8 +12,6 @@ jobs:
   prettier:
     name: Prettier
 
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
@@ -28,8 +21,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.github/workflows/release.yaml

@@ -10,6 +10,9 @@ on:
     branches:
       - main
 
+permissions:
+  id-token: write
+
 jobs:
   release:
     name: Release
@@ -35,8 +38,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.github/workflows/markdown.yaml → .github/workflows/remark.yaml

@@ -1,23 +1,20 @@
-name: Markdown
+name: Remark
 
 on:
-  workflow_run:
-    workflows:
-      - CodeQL
-    types:
-      - completed
   pull_request:
     branches:
       - main
+    paths:
+      - '**/*.md'
   push:
     branches:
       - main
+    paths:
+      - '**/*.md'
 
 jobs:
-  markdown:
-    name: Markdown
-
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+  remark:
+    name: Remark
 
     runs-on: ubuntu-latest
     timeout-minutes: 10
@@ -28,8 +25,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.github/workflows/spec.yaml

@@ -3,7 +3,7 @@ name: Spec
 on:
   workflow_run:
     workflows:
-      - CodeQL
+      - ESLint
     types:
       - completed
   pull_request:
@@ -28,8 +28,6 @@ jobs:
 
       - name: Set Up PNPM
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
 
       - name: Set Up NodeJS
         uses: actions/setup-node@v4

.gitignore

@@ -1,2 +1,2 @@
-# directories
+# Directories
 node_modules

.husky/post-merge

@@ -0,0 +1 @@
+pnpm git-pull-run --pattern 'pnpm-lock.yaml' --command 'pnpm i'

.npmrc

@@ -0,0 +1 @@
+provenance=true

.prettierignore

@@ -1,18 +1,20 @@
-# directories
+# Directories
 .husky
 
-# files
+# Files
 *.md
 pnpm-lock.yaml
 
 # *rc
 .czrc
 .ecrc
+.npmrc
 
-# configs
+# Configs
 .editorconfig
 .gitattributes
 
-# ignores
+# Ignores
 .gitignore
 .prettierignore
+.remarkignore

.remarkignore

@@ -0,0 +1,2 @@
+# Files
+CHANGELOG.md

README.md

@@ -2,25 +2,31 @@
 
 ![NPM Version](https://img.shields.io/npm/v/%40archoleat%2Fvalidate-font-file-name)
 ![NPM Downloads](https://img.shields.io/npm/dm/%40archoleat%2Fvalidate-font-file-name)
+![ESM](https://img.shields.io/badge/ESM-fe0)
+![Provenance](https://img.shields.io/badge/Provenance-fo0)
 ![CodeQL](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/codeql.yaml?label=CodeQL)
 ![Specs](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/spec.yaml?label=Specs)
 ![Commitlint](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/commitlint.yaml?label=Commitlint)
 ![Editorconfig](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/editorconfig.yaml?label=Editorconfig)
 ![Prettier](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/prettier.yaml?label=Prettier)
 ![ESLint](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/eslint.yaml?label=ESLint)
-![Markdown](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/markdown.yaml?label=Markdown)
-![ESM Only](https://img.shields.io/badge/ESM-only-gray?labelColor=fe0)
+![Remark](https://img.shields.io/github/actions/workflow/status/archoleat/validate-font-file-name/remark.yaml?label=Remark)
 
 ## Table of Contents
 
--   [Installation](#installation)
--   [Usage](#usage)
--   [Naming Convention](#naming-convention)
--   [Contributing](#contributing)
--   [License](#license)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Naming Convention](#naming-convention)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
+```shell
+# bun
+bun i -D @archoleat/validate-font-file-name
+```
+
 ```shell
 # pnpm
 pnpm i -D @archoleat/validate-font-file-name
@@ -68,22 +74,22 @@ console.log(await validateFontFileName(invalidFontFileName));
 
 ### Your Regex
 
-You can also specify your pattern:
+You can also specify your regex:
 
 ```js
 import { validateFontFileName } from '@archoleat/validate-font-file-name';
 
 // You can also specify `new RegExp()` and a regular `string`
-const yourPattern = /OpenSans-regular/;
+const yourRegex = /OpenSans-regular/;
 
 const validFontFileName = 'OpenSans-regular';
 const invalidFontFileName = 'OpenSans.woff2';
 
 // returns: true
-console.log(await validateFontFileName(validFontFileName, yourPattern));
+console.log(await validateFontFileName(validFontFileName, yourRegex));
 
 // returns: 'OpenSans.woff2' doesn't match with '/OpenSans-regular/'.
-console.log(await validateFontFileName(invalidFontFileName, yourPattern));
+console.log(await validateFontFileName(invalidFontFileName, yourRegex));
 ```
 
 ## Naming Convention
@@ -93,7 +99,7 @@ and separated by a **hyphen**.
 
 Extensions that are allowed: `otf`, `ttf`, `woff`, `woff2`.
 
-> `{FontFamily}-{FontWeight}.{ext}`
+> `{FontFamily}-{FontWeight}.{extension}`
 
 ## Contributing
 

eslint.config.js

@@ -42,6 +42,17 @@ export default defineFlatConfig([
       'import/no-namespace': 'error',
       'import/no-unassigned-import': 'error',
       'import/prefer-default-export': 'off',
+      'unicorn/import-style': [
+        'error',
+        {
+          styles: {
+            'node:path': {
+              default: false,
+              named: true,
+            },
+          },
+        },
+      ],
       'unicorn/no-unused-properties': 'error',
       'unicorn/string-content': 'error',
     },

lint-staged.config.js

@@ -1,4 +1,5 @@
 export default {
+  '**/*.md': 'remark --quiet --frail',
   '**/*': 'prettier --write',
   'src/index.ts': 'eslint --fix',
 };