onlybuild 1.4.1 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v1.5.0](https://github.com/neogeek/onlybuild/tree/v1.5.0) - (2024-05-13)
+
+[Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.4.1...v1.5.0)
+
+- [feat] Added logging of files build and copied as well as the duration. [#21](https://github.com/neogeek/onlybuild/pull/21)
+- [hotfix] Updated packages. [#20](https://github.com/neogeek/onlybuild/pull/20)
+
 ## [v1.4.1](https://github.com/neogeek/onlybuild/tree/v1.4.1) - (2024-05-09)
 
 [Full Changelog](https://github.com/neogeek/onlybuild/compare/v1.4.0...v1.4.1)

package/README.md

@@ -26,6 +26,7 @@
 
 ## Table of Contents
 
+- [Automatic Installation](#automatic-installation)
 - [Install](#install)
 - [Usage](#usage)
 - [Quick Start Guide](#quick-start-guide)
@@ -44,6 +45,33 @@
 - [Community Roadmap](#community-roadmap)
 - [License](#license)
 
+## Automatic Installation
+
+If this is your first time using `onlybuild`, it is recommended that you use `create-onlybuild-app`, which will walk you through setting up a project and automatically create the files needed to get started.
+
+```bash
+$ npx create-onlybuild-app@latest
+```
+
+After you run the above command, you'll see the following prompts:
+
+```
+What is your project named?
+Would you like to use TypeScript?
+How would you like to create pages?
+Include prettier config?
+Do you want to watch for changes?
+Do you want to serve files locally?
+```
+
+And once you answer these questions, `create-onlybuild-app` will automatically create the files needed to get started based on your answers.
+
+It will also show the commands needed to enter the folder and build, watch (if enabled) or serve (if enabled) your static website.
+
+### Demo
+
+https://github.com/neogeek/onlybuild/assets/6753/e64f0d09-44a9-41b6-9c4d-d004138e9f89
+
 ## Install
 
 ### Globally
@@ -266,7 +294,7 @@ LICENSE
 
 ## React
 
-If you want to use [React.js](https://react.dev/), instead of <code>&#96;html&#96;</code> string templates, you can do that by using `react-dom/server` in a `.jsx` or `.tsx` file.
+If you want to use [React](https://react.dev/), instead of <code>&#96;html&#96;</code> string templates, you can do that by using `react-dom/server` in a `.jsx` or `.tsx` file.
 
 ```javascript
 import React from 'react';
@@ -279,7 +307,7 @@ function Hello() {
 export default renderToString(<Hello />);
 ```
 
-In order for `.jsx` or `.tsx` files to work property you will need to add `"type": "module"` to your `package.json`.
+In order for `.jsx` or `.tsx` files to work properly you will need to add `"type": "module"` to your `package.json`.
 
 ```json
 {
@@ -291,7 +319,7 @@ In order for `.jsx` or `.tsx` files to work property you will need to add `"type
 
 ## TypeScript
 
-In order for TypeScript files to work property you will need to add `"type": "module"` to your `package.json`.
+In order for TypeScript files to work properly you will need to add `"type": "module"` to your `package.json`.
 
 ```json
 {
@@ -366,7 +394,8 @@ Serving the files once the build is complete is easy using the NPM package [http
 1. [External API](./examples/external-api/) - Output data fetched from an external API.
 1. [<code>&#96;html&#96;</code> String Template](./examples/html-string-template/) - Use the <code>&#96;html&#96;</code> string template utility to add syntax highlighting to HTML.
 1. [Includes](./examples/includes/) - An example that uses reusable includes for building multiple pages.
-1. [React.js](./examples/react.js/) - An example using React.js to render HTML.
+1. [React](./examples/react/) - An example using React to render HTML.
+1. [TypeScript](./examples/typescript/) - A simple example using TypeScript.
 
 ## Benchmark
 
@@ -377,7 +406,7 @@ Times shown are in seconds. Lower is better.
 
 | Markdown Files                                 |      250 |      500 |     1000 |     2000 |     4000 |
 | ---------------------------------------------- | -------: | -------: | -------: | -------: | -------: |
-| onlybuild                                      |  `0.296` |  `0.356` |  `0.512` |  `0.770` |  `1.309` |
+| onlybuild                                      |  `0.349` |  `0.455` |  `0.626` |  `0.980` |  `1.661` |
 | [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.js

@@ -2,10 +2,13 @@
 import 'dotenv/config';
 import 'tsx/esm';
 import { globby } from 'globby';
+import chalk from 'chalk';
 import parseCmdArgs from 'parse-cmd-args';
 import { buildFiles, writeFiles } from '../src/build.js';
 import { copyFiles } from '../src/copy.js';
 import pkg from '../package.json' assert { type: 'json' };
+const elapsedTimeLabel = 'Elapsed time:';
+console.time(elapsedTimeLabel);
 const args = parseCmdArgs(null, {
     requireUserInput: false
 });
@@ -60,5 +63,10 @@ const filesToCopy = await globby([
     ignoreFiles: [ignoreFile],
     cwd: args.inputs[0]
 });
-await writeFiles(await buildFiles(filesToBuild), buildDir);
+const filesToWrite = await buildFiles(filesToBuild);
+await writeFiles(filesToWrite, buildDir);
 await copyFiles(filesToCopy, buildDir);
+console.log(`Wrote ${chalk.green(filesToWrite.length)} file(s).`);
+console.log(`Copied ${chalk.green(filesToCopy.length)} file(s).`);
+console.log('');
+console.timeEnd(elapsedTimeLabel);

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "onlybuild",
     "description": "A zero-config cli for building static websites.",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "engines": {
         "node": ">=20.x"
     },
@@ -17,10 +17,11 @@
     "types": "./dist/src/index.d.ts",
     "license": "MIT",
     "dependencies": {
+        "chalk": "5.3.0",
         "dotenv": "16.4.5",
         "globby": "14.0.1",
         "parse-cmd-args": "5.0.2",
-        "tsx": "4.9.3"
+        "tsx": "4.10.2"
     },
     "devDependencies": {
         "@types/node": "20.12.11",

package/dist/src/build.d.ts

@@ -34,7 +34,7 @@ export declare const writeFileAndMakeDir: (path: string, contents: string) => Pr
 /**
  * Write files to the build directory.
  *
- * @param {{ path: string; contents: string }[]} files,
+ * @param {{ path: string; contents: string }[]} files
  * @param {string} buildDir
  */
 export declare const writeFiles: (files: {

package/dist/src/build.js

@@ -42,7 +42,7 @@ export const writeFileAndMakeDir = async (path, contents) => {
 /**
  * Write files to the build directory.
  *
- * @param {{ path: string; contents: string }[]} files,
+ * @param {{ path: string; contents: string }[]} files
  * @param {string} buildDir
  */
 export const writeFiles = async (files, buildDir) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "onlybuild",
   "description": "A zero-config cli for building static websites.",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "engines": {
     "node": ">=20.x"
   },
@@ -17,10 +17,11 @@
   "types": "./dist/src/index.d.ts",
   "license": "MIT",
   "dependencies": {
+    "chalk": "5.3.0",
     "dotenv": "16.4.5",
     "globby": "14.0.1",
     "parse-cmd-args": "5.0.2",
-    "tsx": "4.9.3"
+    "tsx": "4.10.2"
   },
   "devDependencies": {
     "@types/node": "20.12.11",