webfont-builder 1.0.2 → 1.0.4

package/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Build and Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📥 Checkout repository
+        uses: actions/checkout@v4
+
+      - name: 🔧 Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: 📦 Install dependencies
+        run: npm ci
+
+      - name: 🚀 Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: 🏷️ Extract version from package.json
+        id: extract_version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: 🏷️ Create and push Git tag
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          git tag -a "v${{ steps.extract_version.outputs.version }}" -m "Release v${{ steps.extract_version.outputs.version }}"
+          git push origin "v${{ steps.extract_version.outputs.version }}"

package/.prettierignore

@@ -0,0 +1,35 @@
+# defaults
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+
+# build and dist Output
+dist
+build
+.out
+.next
+
+# logs
+npm-debug.log
+yarn-debug.log
+yarn-error.log
+pnpm-debug.log
+
+# environment files
+.env
+.env.local
+.env.*.local
+
+# lockfiles (if using a monorepo or specific package manager setup)
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# miscellaneous
+coverage/
+.DS_Store
+*.min.js
+public/
+tmp/
+*.md

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "singleAttributePerLine": true
+}

package/README.md

@@ -4,22 +4,33 @@ The `webfont-builder` package is a simple script which purpose is to help build
 
 ## Getting Started
 
-1. Install `webfont-builder` in the font package:
+Install the package:
 
 ```bash
-$ npm install -D webfont-builder
+npm i -D webfont-builder
 ```
 
-2. Invoke the builder:
+Include the binary in your `build` script:
+
+```json
+{
+  ...
+  "scripts": {
+    "build": "webfont-builder",
+    ...
+  },
+  ...
+}
+```
 
+Build the font:
 ```bash
-$ webfont-builder
+npm run build
 ```
 
 
 
 
-
 <br/>
 
 ## Built With
@@ -44,22 +55,4 @@ $ webfont-builder
 
 ## Acknowledgments
 
-- [clean-css](https://github.com/clean-css/clean-css)
-
-
-
-
-
-<br/>
-
-## Deployment
-
-1. Install dependencies:
-```bash
-$ npm install
-```
-
-3. Publish to `npm`:
-```bash
-$ npm publish
-```
+- [clean-css](https://github.com/clean-css/clean-css)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webfont-builder",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "The webfont-builder package is a simple script which purpose is to help build Web Fonts so they can be easily self-hosted in production-grade applications.",
   "main": "src/index.js",
   "type": "module",
@@ -8,6 +8,9 @@
     "start": "node src/index.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "bin": {
+    "webfont-builder": "./src/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jesusgraterol/webfont-builder.git"
@@ -19,6 +22,10 @@
   },
   "homepage": "https://github.com/jesusgraterol/webfont-builder#readme",
   "dependencies": {
-    "clean-css": "^5.3.3"
+    "clean-css": "5.3.3"
+  },
+  "devDependencies": {
+    "eslint-config-prettier": "10.1.5",
+    "prettier": "3.6.2"
   }
 }

package/src/index.js

@@ -1,13 +1,7 @@
 #! /usr/bin/env node
-import { 
-  rmSync, 
-  mkdirSync, 
-  writeFileSync, 
-  cpSync 
-} from 'node:fs';
+import { rmSync, mkdirSync, writeFileSync, cpSync } from 'node:fs';
 import CleanCSS from 'clean-css';
 
-
 /* ************************************************************************************************
  *                                            HELPERS                                             *
  ************************************************************************************************ */
@@ -26,27 +20,24 @@ const __cleanDist = () => {
 const __minifyFontDeclaration = () => {
   const file = new CleanCSS().minify(['src/index.css']);
   writeFileSync('dist/index.css', file.styles, { encoding: 'utf-8' });
-}
+};
 
 /**
  * Copies the raw font assets from the source into the distribution directory.
  */
 const __copyFontAssets = () => cpSync('src/woff2', 'dist/woff2', { recursive: true });
 
-
-
-
 /* ************************************************************************************************
  *                                           EXECUTION                                            *
  ************************************************************************************************ */
 
 (() => {
- // clean the distribution directory
- __cleanDist();
+  // clean the distribution directory
+  __cleanDist();
 
   // minify the font declaration
   __minifyFontDeclaration();
 
   // finally, copy the font assets
   __copyFontAssets();
-})();
+})();