webfont-builder 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jesus Graterol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# WebFont Builder
+
+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.
+
+## Getting Started
+
+1. Install `webfont-builder` in the font package:
+
+```bash
+$ npm install -D webfont-builder
+```
+
+2. Invoke the builder:
+
+```bash
+$ webfont-builder
+```
+
+
+
+
+
+<br/>
+
+## Built With
+
+- JavaScript
+
+
+
+
+
+<br/>
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+
+
+
+
+<br/>
+
+## 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
+```

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "webfont-builder",
+  "version": "1.0.0",
+  "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",
+  "scripts": {
+    "start": "node src/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jesusgraterol/webfont-builder.git"
+  },
+  "author": "Jesus Graterol",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jesusgraterol/webfont-builder/issues"
+  },
+  "homepage": "https://github.com/jesusgraterol/webfont-builder#readme",
+  "dependencies": {
+    "clean-css": "^5.3.3"
+  }
+}

package/src/index.js

@@ -0,0 +1,52 @@
+#! /usr/bin/env node
+import { 
+  rmSync, 
+  mkdirSync, 
+  writeFileSync, 
+  cpSync 
+} from 'node:fs';
+import CleanCSS from 'clean-css';
+
+
+/* ************************************************************************************************
+ *                                            HELPERS                                             *
+ ************************************************************************************************ */
+
+/**
+ * Removes the distribution directory and creates it again in order to guarantee a clean build.
+ */
+const __cleanDist = () => {
+  rmSync('dist', { recursive: true, force: true });
+  mkdirSync('dist');
+};
+
+/**
+ * Minifies and saves the font declaration stylesheet.
+ */
+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();
+
+  // minify the font declaration
+  __minifyFontDeclaration();
+
+  // finally, copy the font assets
+  __copyFontAssets();
+})();