onlybuild 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v1.3.0](https://github.com/neogeek/onlybuild/tree/v1.3.0) - (2024-05-08)
+
+[Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.2.1...v1.3.0)
+
+- [hotfix] Updated packages. [#15](https://github.com/neogeek/onlybuild/pull/15)
+- [feat] Added TypeScript support. (experimental) [#14](https://github.com/neogeek/onlybuild/pull/14)
+- [hotfix] Added experimental code coverage flag to test command. [#13](https://github.com/neogeek/onlybuild/pull/13)
+- [feat] Split build and copy logic into separate methods. [#12](https://github.com/neogeek/onlybuild/pull/12)
+
+## [v1.2.1](https://github.com/neogeek/onlybuild/tree/v1.2.1) - (2024-05-07)
+
+[Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.2.0...v1.2.1)
+
+- [hotfix] Fixed issue with getting version from package.json [#11](https://github.com/neogeek/onlybuild/pull/11)
+
 ## [v1.2.0](https://github.com/neogeek/onlybuild/tree/v1.2.0) - (2024-05-07)
 
 [Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.1.0...v1.2.0)

package/README.md

@@ -32,6 +32,7 @@
 - [Getting Started](#getting-started)
 - [File Structure](#file-structure)
 - [Ignore Files](#ignore-files)
+- [TypeScript](#typescript)
 - [Formatting Files](#formatting-files)
 - [Watching For Changes](#watching-for-changes)
 - [Local Server](#local-server)
@@ -91,6 +92,7 @@ Usage: onlybuild <path> [options]
    -v, --version         Display the current installed version.
    -o, --out             Sets build directory. Default path is build/
    -i, --ignore          Sets ignore file path. Default path is .onlyignore
+   -t, --typescript      Parse TypeScript files. (experimental)
 ```
 
 ## Quick Start Guide
@@ -262,6 +264,27 @@ screenshot.png
 LICENSE
 ```
 
+## TypeScript
+
+> [!WARNING]
+> This feature is experimental.
+
+By default `onlybuild` looks for `.mjs` files, but if you add the `--typescript` flag to the build command, it will instead look for `.ts` files.
+
+```bash
+$ npx onlybuild --typescript
+```
+
+You will also need to add `"type": "module"` to your `package.json` file for imports to work correctly.
+
+```json
+{
+  ...
+  "type": "module",
+  ...
+}
+```
+
 ## Formatting Files
 
 If you want to reformat the HTML files in the build directory, you can use [Prettier](https://prettier.io/) after the build completes.

package/dist/bin/index.d.ts

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env node --no-warnings
 import 'dotenv/config';
 export {};

package/dist/bin/index.js

@@ -1,17 +1,16 @@
-#!/usr/bin/env node
-import { readFile } from 'node:fs/promises';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+#!/usr/bin/env node --no-warnings
 import 'dotenv/config';
+import { register } from 'tsx/esm/api';
 import { globby } from 'globby';
 import parseCmdArgs from 'parse-cmd-args';
-import { buildFiles } from '../src/build.js';
+import { buildFiles, writeFiles } from '../src/build.js';
 import { copyFiles } from '../src/copy.js';
+import pkg from '../package.json' assert { type: 'json' };
 const args = parseCmdArgs(null, {
     requireUserInput: false
 });
 if (args.flags['--version'] || args.flags['-v']) {
-    process.stdout.write(`${JSON.parse(await readFile(join(dirname(fileURLToPath(import.meta.url)), '../package.json'), 'utf8')).version}\n`);
+    process.stdout.write(`${pkg.version}\n`);
     process.exit();
 }
 else if (args.flags['--help'] || args.flags['-h']) {
@@ -23,6 +22,7 @@ else if (args.flags['--help'] || args.flags['-h']) {
    -v, --version         Display the current installed version.
    -o, --out             Sets build directory. Default path is build/
    -i, --ignore          Sets ignore file path. Default path is .onlyignore
+   -t, --typescript      Parse TypeScript files. (experimental)
 `);
     process.exit();
 }
@@ -32,14 +32,25 @@ const [buildDir = 'build/'] = [args.flags['--out'], args.flags['-o']]
 const [ignoreFile = '.onlyignore'] = [args.flags['--ignore'], args.flags['-i']]
     .filter(flag => typeof flag === 'string')
     .map(String);
-await buildFiles(await globby(['**/*.mjs', '!_*/**/*', '!node_modules/', `!${buildDir}`], {
+const [typescript = false] = [args.flags['--typescript'], args.flags['-t']]
+    .filter(flag => typeof flag === 'boolean')
+    .map(Boolean);
+if (typescript) {
+    register();
+}
+const filesToBuild = await globby([
+    typescript ? '**/*.ts' : '**/*.mjs',
+    '!_*/**/*',
+    '!node_modules/',
+    `!${buildDir}`
+], {
     gitignore: false,
     ignoreFiles: [ignoreFile],
     cwd: args.inputs[0]
-}), buildDir);
-await copyFiles(await globby([
+});
+const filesToCopy = await globby([
     '**/*',
-    '!**/*.mjs',
+    typescript ? '!**/*.ts' : '!**/*.mjs',
     '!_*/**/*',
     '!package.json',
     '!package-lock.json',
@@ -49,4 +60,6 @@ await copyFiles(await globby([
     gitignore: false,
     ignoreFiles: [ignoreFile],
     cwd: args.inputs[0]
-}), buildDir);
+});
+await writeFiles(await buildFiles(filesToBuild), buildDir);
+await copyFiles(filesToCopy, buildDir);

package/dist/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "onlybuild",
+    "description": "A zero-config cli for building static websites.",
+    "version": "1.3.0",
+    "engines": {
+        "node": ">=20.x"
+    },
+    "type": "module",
+    "bin": {
+        "onlybuild": "dist/bin/index.js"
+    },
+    "exports": {
+        ".": "./dist/src/index.js",
+        "./build": "./dist/src/build.js",
+        "./copy": "./dist/src/copy.js"
+    },
+    "types": "./dist/src/index.d.ts",
+    "license": "MIT",
+    "dependencies": {
+        "dotenv": "16.4.5",
+        "globby": "14.0.1",
+        "parse-cmd-args": "5.0.2",
+        "tsx": "4.9.3"
+    },
+    "devDependencies": {
+        "@types/node": "20.12.11",
+        "typescript": "5.4.5"
+    },
+    "scripts": {
+        "test": "node --import tsx --test --experimental-test-coverage ./src/*.test.ts",
+        "build": "rm -rf dist/ && tsc && chmod +x ./dist/bin/index.js",
+        "prepare": "npm run build"
+    },
+    "keywords": [
+        "javascript",
+        "build",
+        "static"
+    ],
+    "authors": [
+        {
+            "name": "Scott Doxey",
+            "email": "hello@scottdoxey.com",
+            "homepage": "http://scottdoxey.com/"
+        }
+    ],
+    "homepage": "https://github.com/neogeek/onlybuild",
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/neogeek/onlybuild.git"
+    }
+}

package/dist/src/build.d.ts

@@ -1,22 +1,43 @@
 /**
- * Write the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ * Calculates the output path of the file based on the original input path.
  *
  * @param {string} path
- * @param {string} buildDir
- * @param {string} contents
  */
-export declare const writeFileAndMakeDir: (path: string, buildDir: string, contents: string) => Promise<void>;
+export declare const calculateOutputPathFromInputPath: (path: string) => string;
 /**
- * Import the default export of a JavaScript file and check that the default export is a string before writing the contents to a build file.
+ * Returns the default export if it is a string.
  *
  * @param {string} path
- * @param {string} buildDir
+ * @returns {Promise<{ path: string; contents: string }>}
  */
-export declare const buildFile: (path: string, buildDir: string) => Promise<void>;
+export declare const buildFile: (path: string) => Promise<{
+    path: string;
+    contents: string;
+}>;
 /**
- * Iterate over all the file paths and write them to the build directory.
+ * Iterate over all file paths and returns the default export for each file if it is a string.
  *
  * @param {string[]} paths
+ * @returns {Promise<{ path: string; contents: string }[]>}
+ */
+export declare const buildFiles: (paths: string[]) => Promise<{
+    path: string;
+    contents: string;
+}[]>;
+/**
+ * Writes the contents of a file to a path, creating parent directories as needed.
+ *
+ * @param {string} path
+ * @param {string} contents
+ */
+export declare const writeFileAndMakeDir: (path: string, contents: string) => Promise<void>;
+/**
+ * Write files to the build directory.
+ *
+ * @param {{ path: string; contents: string }[]} files,
  * @param {string} buildDir
  */
-export declare const buildFiles: (paths: string[], buildDir: string) => Promise<void>;
+export declare const writeFiles: (files: {
+    path: string;
+    contents: string;
+}[], buildDir: string) => Promise<void>;

package/dist/src/build.js

@@ -1,38 +1,52 @@
 import { writeFile, mkdir } from 'node:fs/promises';
-import { basename, dirname, join, resolve } from 'node:path';
+import { dirname, join, parse, resolve } from 'node:path';
 /**
- * Write the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ * Calculates the output path of the file based on the original input path.
  *
  * @param {string} path
- * @param {string} buildDir
- * @param {string} contents
  */
-export const writeFileAndMakeDir = async (path, buildDir, contents) => {
-    const filename = basename(path, '.mjs');
-    const directory = filename === 'index'
-        ? join(buildDir, dirname(path))
-        : join(buildDir, dirname(path), filename);
-    await mkdir(directory, { recursive: true });
-    await writeFile(join(directory, 'index.html'), contents);
+export const calculateOutputPathFromInputPath = (path) => {
+    const filename = parse(path).name;
+    const directory = filename === 'index' ? dirname(path) : join(dirname(path), filename);
+    return join(directory, 'index.html');
 };
 /**
- * Import the default export of a JavaScript file and check that the default export is a string before writing the contents to a build file.
+ * Returns the default export if it is a string.
  *
  * @param {string} path
- * @param {string} buildDir
+ * @returns {Promise<{ path: string; contents: string }>}
  */
-export const buildFile = async (path, buildDir) => {
+export const buildFile = async (path) => {
     const contents = (await import(resolve(path))).default;
-    if (typeof contents === 'string') {
-        await writeFileAndMakeDir(path, buildDir, contents);
-    }
+    return { path, contents: typeof contents === 'string' ? contents : '' };
 };
 /**
- * Iterate over all the file paths and write them to the build directory.
+ * Iterate over all file paths and returns the default export for each file if it is a string.
  *
  * @param {string[]} paths
+ * @returns {Promise<{ path: string; contents: string }[]>}
+ */
+export const buildFiles = async (paths) => {
+    return (await Promise.all(paths.map(async (path) => await buildFile(path)))).filter(({ contents }) => contents !== '');
+};
+/**
+ * Writes the contents of a file to a path, creating parent directories as needed.
+ *
+ * @param {string} path
+ * @param {string} contents
+ */
+export const writeFileAndMakeDir = async (path, contents) => {
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, contents);
+};
+/**
+ * Write files to the build directory.
+ *
+ * @param {{ path: string; contents: string }[]} files,
  * @param {string} buildDir
  */
-export const buildFiles = async (paths, buildDir) => {
-    await Promise.all(paths.map(async (path) => await buildFile(path, buildDir)));
+export const writeFiles = async (files, buildDir) => {
+    await Promise.all(files.map(async (file) => {
+        await writeFileAndMakeDir(join(buildDir, calculateOutputPathFromInputPath(file.path)), file.contents);
+    }));
 };

package/dist/src/copy.d.ts

@@ -1,12 +1,12 @@
 /**
- * Copy the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ * Copies a file from one path to another, creating parent directories as needed.
  *
- * @param {string} path
- * @param {string} buildDir
+ * @param {string} src
+ * @param {string} dest
  */
-export declare const copyFileAndMakeDir: (path: string, buildDir: string) => Promise<void>;
+export declare const copyFileAndMakeDir: (src: string, dest: string) => Promise<void>;
 /**
- * Iterate over all the file paths and copy them to the build directory.
+ * Iterate over all file paths and copy them to the build directory.
  *
  * @param {string[]} paths
  * @param {string} buildDir

package/dist/src/copy.js

@@ -1,21 +1,21 @@
 import { copyFile, mkdir } from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 /**
- * Copy the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ * Copies a file from one path to another, creating parent directories as needed.
  *
- * @param {string} path
- * @param {string} buildDir
+ * @param {string} src
+ * @param {string} dest
  */
-export const copyFileAndMakeDir = async (path, buildDir) => {
-    await mkdir(join(buildDir, dirname(path)), { recursive: true });
-    await copyFile(path, join(buildDir, path));
+export const copyFileAndMakeDir = async (src, dest) => {
+    await mkdir(dirname(dest), { recursive: true });
+    await copyFile(src, dest);
 };
 /**
- * Iterate over all the file paths and copy them to the build directory.
+ * Iterate over all file paths and copy them to the build directory.
  *
  * @param {string[]} paths
  * @param {string} buildDir
  */
 export const copyFiles = async (paths, buildDir) => {
-    await Promise.all(paths.map(async (path) => await copyFileAndMakeDir(path, buildDir)));
+    await Promise.all(paths.map(async (path) => await copyFileAndMakeDir(path, join(buildDir, path))));
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "onlybuild",
   "description": "A zero-config cli for building static websites.",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "engines": {
     "node": ">=20.x"
   },
@@ -19,15 +19,15 @@
   "dependencies": {
     "dotenv": "16.4.5",
     "globby": "14.0.1",
-    "parse-cmd-args": "5.0.2"
+    "parse-cmd-args": "5.0.2",
+    "tsx": "4.9.3"
   },
   "devDependencies": {
-    "@types/node": "20.12.10",
-    "tsx": "4.9.3",
+    "@types/node": "20.12.11",
     "typescript": "5.4.5"
   },
   "scripts": {
-    "test": "node --import tsx --test ./src/*.test.ts",
+    "test": "node --import tsx --test --experimental-test-coverage ./src/*.test.ts",
     "build": "rm -rf dist/ && tsc && chmod +x ./dist/bin/index.js",
     "prepare": "npm run build"
   },