Merge pull request #651 from kalamuna/kstat_test

Update to kstat_test minimalist framework

Author: RobLoach

.nvmrc

@@ -1 +1 @@
-11
+18

.travis.yml

@@ -1,5 +1,9 @@
 # Changelog
 
+## 6.0.0-alpha1: xxxx-xx-xx
+
+- Complete rewrite without metalsmith, focusing on minimalism
+
 ## 5.0.0-alpha1: 2022-06-12
 
 - Move from node-sass to normal sass

CHANGELOG.md

@@ -12,117 +12,13 @@ Static site application framework for prototyping and styleguiding.
 
 ## Install
 
-    $ npm install kalastatic --save
+    npm install kalastatic --save
 
 ## Usage
 
-### Convention
-
-Construct your source files, using the template engine name in the file extension. The following example uses the [Pug](https://pugjs.org/) template engine, but others are available ([Twig](https://github.com/twigjs/twig.js), [Mustache](https://github.com/janl/mustache.js/), etc).
-
-#### src/index.html.pug
-``` pug
----
-pretty: true
-title: Hello World!
----
-doctype html
-html(lang="en")
-  head
-    title= title
-  body
-    h1= title
-```
-
-### Configuration
-
-KalaStatic can be configured through a `kalastatic.yaml` file. The default options are as follows:
-
-``` yml
-# The base directory of where the base KalaStatic lives.
-base: .
-
-# What BrowserSync should consider the index page.
-bsIndex: 'index.html'
-
-# What BrowserSync should consider the webroot when running KalaStatic.
-# Defaults to the KalaStatic destination directory.
-bsWebroot: ''
-
-# Whether or not to open the browser when initially running Kalastatic.
-bsBrowser: false
-
-# The directory (from base), where the source content files live.
-source: src
-
-# Where the files will be built out to.
-destination: build
-
-# Whether or not the build directory should be cleaned before building.
-cleanBuild: false
-
-# The options to pass off to the Metalsmith plugins when building, keyed by plugin name.
-pluginOpts: {}
-
-# KSS Styleguide Configuration
-kss:
-  # Set the path to a custom KSS Builder
-  builder: null
-  title: "Styleguide"
-  homepage: styles/homepage.md
-  css: ../styles/main.css
-  source:
-    - src/components/
-    - src/styles/
-```
-
-### CLI
-
-KalaStatic can be used as a command line interface. The following are some of its commands:
-
-#### Build
-
-Runs through the KalaStatic build tasks and outputs to the destination folder.
-
-```
-node_modules/.bin/kalastatic build
-```
-
-#### Start
-
-Starts up a development server through [BrowserSync](https://www.browsersync.io/) in order to watch and serve KalaStatic. Changes you make to the source will automatically reflect in the browser.
-
-```
-node_modules/.bin/kalastatic start
-```
-
-#### Scripts
-
-While you can run `kalastatic` as a CLI application, it is recommended to run the above commands through the use of [npm scripts](https://docs.npmjs.com/misc/scripts) in `package.json`:
-
-```
-"scripts": {
-  "test": "kalastatic build",
-  "start": "kalastatic start"
-}
-```
-
-Then you can simply run the following commands to interact with your project:
-
-```
-npm test
-npm start
-```
-
-### API
-
-KalaStatic can be used a JavaScript API. Calling `KalaStatic()` will build, and return a Promise.
-
-``` javascript
-var KalaStatic = require('kalastatic')
-KalaStatic('path/to/site').then(function() {
-  // Site built
-})
+``` bash
+npm i kalastatic --global
+kalastatic path/to/prototype
 ```
 
 For more in depth documentation, visit https://kalamuna.github.io/kalastatic/

README.md

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+/**
+ * @file bin/kalastatic
+ *
+ * This file will load up the kalastatic API, and run it against the current working directory.
+ */
+
+import meow from 'meow';
+import { readFileSync } from 'fs';
+import { kstat } from "../src/kalastatic.js";
+
+const cli = meow(`
+	Usage
+	  $ kalastatic <directory>
+
+	Examples
+	  $ kalastatic path/to/prototype
+`, {
+	importMeta: import.meta
+});
+
+const directory = cli.input[0] ?? '.';
+
+if (directory != '.') {
+  process.chdir(directory);
+}
+
+const pkg = readFileSync('package.json', 'utf8');
+const config = JSON.parse(pkg);
+kstat(config.kalastatic);