onlybuild 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [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)
+
+- [feat] Added .env support. [#10](https://github.com/neogeek/onlybuild/pull/10)
+- [hotfix] Added a prepare build target. [#9](https://github.com/neogeek/onlybuild/pull/9)
+- [hotfix] Fix permissions on bin file after build. [#8](https://github.com/neogeek/onlybuild/pull/8)
+- [feat] Converted project to typescript. [#7](https://github.com/neogeek/onlybuild/pull/7)
+- [hotfix] Updated packages. [#6](https://github.com/neogeek/onlybuild/pull/6)
+- [hotfix] Disable gitignore in globby. [#3](https://github.com/neogeek/onlybuild/pull/3)
+
 ## [v1.1.0](https://github.com/neogeek/onlybuild/tree/v1.1.0) - (2024-04-26)
 
 [Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.0.0...v1.1.0)

package/README.md

@@ -331,13 +331,13 @@ Serving the files once the build is complete is easy using the NPM package [http
 ## Benchmark
 
 > [!NOTE]
-> Each run (for onlybuild only) was repeated 5 times and the average time was selected. This result set was generated on a MacBook Air (M1, 2020), macOS Sonoma 14.4.1, 8 GB memory.
+> Each run (for `onlybuild` only) was repeated 5 times and the lowest/fastest time was selected. This result set was generated on a MacBook Air (M1, 2020), macOS Sonoma 14.4.1, 8 GB memory.
 
 Times shown are in seconds. Lower is better.
 
 | Markdown Files                                 |      250 |      500 |     1000 |     2000 |     4000 |
 | ---------------------------------------------- | -------: | -------: | -------: | -------: | -------: |
-| onlybuild                                      |  `0.321` |  `0.390` |  `0.554` |  `0.892` |  `1.717` |
+| onlybuild                                      |  `0.296` |  `0.356` |  `0.512` |  `0.770` |  `1.309` |
 | [Hugo](https://gohugo.io/) v0.101.0            |  `0.071` |  `0.110` |  `0.171` |  `0.352` |  `0.684` |
 | [Eleventy](https://www.11ty.dev/) 1.0.1        |  `0.584` |  `0.683` |  `0.914` |  `1.250` |  `1.938` |
 | [Astro](https://astro.build/) 1.0.1            |  `2.270` |  `3.172` |  `5.098` |  `9.791` | `22.907` |

package/dist/bin/index.d.ts

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

package/dist/bin/index.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+import { readFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import 'dotenv/config';
+import { globby } from 'globby';
+import parseCmdArgs from 'parse-cmd-args';
+import { buildFiles } from '../src/build.js';
+import { copyFiles } from '../src/copy.js';
+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.exit();
+}
+else if (args.flags['--help'] || args.flags['-h']) {
+    process.stdout.write(`Usage: onlybuild <path> [options]
+
+  Options:
+
+   -h, --help            Display this help message.
+   -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
+`);
+    process.exit();
+}
+const [buildDir = 'build/'] = [args.flags['--out'], args.flags['-o']]
+    .filter(flag => typeof flag === 'string')
+    .map(String);
+const [ignoreFile = '.onlyignore'] = [args.flags['--ignore'], args.flags['-i']]
+    .filter(flag => typeof flag === 'string')
+    .map(String);
+await buildFiles(await globby(['**/*.mjs', '!_*/**/*', '!node_modules/', `!${buildDir}`], {
+    gitignore: false,
+    ignoreFiles: [ignoreFile],
+    cwd: args.inputs[0]
+}), buildDir);
+await copyFiles(await globby([
+    '**/*',
+    '!**/*.mjs',
+    '!_*/**/*',
+    '!package.json',
+    '!package-lock.json',
+    '!node_modules/',
+    `!${buildDir}`
+], {
+    gitignore: false,
+    ignoreFiles: [ignoreFile],
+    cwd: args.inputs[0]
+}), buildDir);

package/dist/src/build.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Write the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ *
+ * @param {string} path
+ * @param {string} buildDir
+ * @param {string} contents
+ */
+export declare const writeFileAndMakeDir: (path: string, buildDir: string, contents: string) => Promise<void>;
+/**
+ * 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.
+ *
+ * @param {string} path
+ * @param {string} buildDir
+ */
+export declare const buildFile: (path: string, buildDir: string) => Promise<void>;
+/**
+ * Iterate over all the file paths and write them to the build directory.
+ *
+ * @param {string[]} paths
+ * @param {string} buildDir
+ */
+export declare const buildFiles: (paths: string[], buildDir: string) => Promise<void>;

package/{src → dist/src}/build.js

@@ -1,6 +1,5 @@
 import { writeFile, mkdir } from 'node:fs/promises';
 import { basename, dirname, join, resolve } from 'node:path';
-
 /**
  * Write the file to the build directory while creating the directory, recursively, if it doesn't exist.
  *
@@ -9,18 +8,13 @@ import { basename, dirname, join, resolve } from 'node:path';
  * @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);
+    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);
 };
-
 /**
  * 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.
  *
@@ -28,13 +22,11 @@ export const writeFileAndMakeDir = async (path, buildDir, contents) => {
  * @param {string} buildDir
  */
 export const buildFile = async (path, buildDir) => {
-  const contents = (await import(resolve(path))).default;
-
-  if (typeof contents === 'string') {
-    await writeFileAndMakeDir(path, buildDir, contents);
-  }
+    const contents = (await import(resolve(path))).default;
+    if (typeof contents === 'string') {
+        await writeFileAndMakeDir(path, buildDir, contents);
+    }
 };
-
 /**
  * Iterate over all the file paths and write them to the build directory.
  *
@@ -42,5 +34,5 @@ export const buildFile = async (path, buildDir) => {
  * @param {string} buildDir
  */
 export const buildFiles = async (paths, buildDir) => {
-  await Promise.all(paths.map(async path => await buildFile(path, buildDir)));
+    await Promise.all(paths.map(async (path) => await buildFile(path, buildDir)));
 };

package/dist/src/copy.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copy the file to the build directory while creating the directory, recursively, if it doesn't exist.
+ *
+ * @param {string} path
+ * @param {string} buildDir
+ */
+export declare const copyFileAndMakeDir: (path: string, buildDir: string) => Promise<void>;
+/**
+ * Iterate over all the file paths and copy them to the build directory.
+ *
+ * @param {string[]} paths
+ * @param {string} buildDir
+ */
+export declare const copyFiles: (paths: string[], buildDir: string) => Promise<void>;

package/{src → dist/src}/copy.js

@@ -1,6 +1,5 @@
 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.
  *
@@ -8,11 +7,9 @@ import { dirname, join } from 'node:path';
  * @param {string} buildDir
  */
 export const copyFileAndMakeDir = async (path, buildDir) => {
-  await mkdir(join(buildDir, dirname(path)), { recursive: true });
-
-  await copyFile(path, join(buildDir, path));
+    await mkdir(join(buildDir, dirname(path)), { recursive: true });
+    await copyFile(path, join(buildDir, path));
 };
-
 /**
  * Iterate over all the file paths and copy them to the build directory.
  *
@@ -20,7 +17,5 @@ export const copyFileAndMakeDir = async (path, buildDir) => {
  * @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, buildDir)));
 };

package/dist/src/html.d.ts

@@ -0,0 +1,7 @@
+/**
+ * String template utility that adds syntax highlighting and formatting in text editors.
+ *
+ * @param {TemplateStringsArray} strings
+ * @param {any[]} values
+ */
+export declare const html: (strings: TemplateStringsArray, ...values: any[]) => string;

package/{src → dist/src}/html.js

@@ -5,12 +5,6 @@
  * @param {any[]} values
  */
 export const html = (strings, ...values) => {
-  const processedValues = values.map(value =>
-    Array.isArray(value) ? value.join('') : value
-  );
-
-  return strings.reduce(
-    (prev, curr, i) => `${prev}${curr}${processedValues[i] || ''}`,
-    ''
-  );
+    const processedValues = values.map(value => Array.isArray(value) ? value.join('') : value);
+    return strings.reduce((prev, curr, i) => `${prev}${curr}${processedValues[i] || ''}`, '');
 };

package/dist/src/index.js

@@ -0,0 +1 @@
+export { html } from './html.js';

package/package.json

@@ -1,22 +1,35 @@
 {
   "name": "onlybuild",
   "description": "A zero-config cli for building static websites.",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "engines": {
     "node": ">=20.x"
   },
   "type": "module",
   "bin": {
-    "onlybuild": "./bin/index.js"
+    "onlybuild": "dist/bin/index.js"
   },
-  "main": "./src/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.1"
+    "parse-cmd-args": "5.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "20.12.10",
+    "tsx": "4.9.3",
+    "typescript": "5.4.5"
   },
   "scripts": {
-    "test": "node --test"
+    "test": "node --import tsx --test ./src/*.test.ts",
+    "build": "rm -rf dist/ && tsc && chmod +x ./dist/bin/index.js",
+    "prepare": "npm run build"
   },
   "keywords": [
     "javascript",

package/bin/index.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-
-import { readFile } from 'node:fs/promises';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { globby } from 'globby';
-
-import parseCmdArgs from 'parse-cmd-args';
-
-import { buildFiles } from '../src/build.js';
-import { copyFiles } from '../src/copy.js';
-
-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.exit();
-} else if (args.flags['--help'] || args.flags['-h']) {
-  process.stdout.write(`Usage: onlybuild <path> [options]
-
-  Options:
-
-   -h, --help            Display this help message.
-   -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
-`);
-  process.exit();
-}
-
-const [buildDir = 'build/'] = [args.flags['--out'], args.flags['-o']]
-  .filter(flag => typeof flag === 'string')
-  .map(String);
-
-const [ignoreFile = '.onlyignore'] = [args.flags['--ignore'], args.flags['-i']]
-  .filter(flag => typeof flag === 'string')
-  .map(String);
-
-await buildFiles(
-  await globby(['**/*.mjs', '!_*/**/*', '!node_modules/', `!${buildDir}`], {
-    gitignore: true,
-    ignoreFiles: [ignoreFile],
-    cwd: args.inputs[0]
-  }),
-  buildDir
-);
-
-await copyFiles(
-  await globby(
-    [
-      '**/*',
-      '!**/*.mjs',
-      '!_*/**/*',
-      '!package.json',
-      '!package-lock.json',
-      '!node_modules/',
-      `!${buildDir}`
-    ],
-    {
-      gitignore: true,
-      ignoreFiles: [ignoreFile],
-      cwd: args.inputs[0]
-    }
-  ),
-  buildDir
-);
-
-export {};