Sorted Files

examples/externalSpinners.ts → Examples/externalSpinners.ts

@@ -1,18 +1,18 @@
-import Kia from "../mod.ts";
+import Kia from '../mod.ts';
 // Import some spinners from cli-spinners by ameerthehacker
-import { SPINNERS } from "https://raw.githubusercontent.com/ameerthehacker/cli-spinners/master/spinners.ts";
+import { SPINNERS } from 'https://raw.githubusercontent.com/ameerthehacker/cli-spinners/master/spinners.ts';
 
 // Just a function to async sleep
 function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
 // Use the spinner "flip"
-const kia = new Kia({ text: "A spinner", spinner: SPINNERS.flip });
+const kia = new Kia({ text: 'A spinner', spinner: SPINNERS.flip });
 kia.start();
 await sleep(2000);
 
 // Switch the spinner to "dots8"
-kia.set({ text: "Another spinner!", spinner: SPINNERS.dots8 });
+kia.set({ text: 'Another spinner!', spinner: SPINNERS.dots8 });
 await sleep(2000);
 kia.stop();

examples/promise.ts → Examples/promise.ts

@@ -1,11 +1,11 @@
-import { forPromise } from "../mod.ts";
+import { forPromise } from '../mod.ts';
 
 // Just a function to async sleep
 function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
-const text = "test";
+const text = 'test';
 
 forPromise(
 	async () => {

examples/weather.ts → Examples/weather.ts

@@ -1,4 +1,4 @@
-import Kia, { Spinners } from "../mod.ts";
+import Kia, { Spinners } from '../mod.ts';
 
 // Just a function to async sleep
 function sleep(ms: number) {
@@ -7,8 +7,8 @@ function sleep(ms: number) {
 
 // Create a spinner instance
 const kia = new Kia({
-	text: "Loading sun",
-	color: "cyan",
+	text: 'Loading sun',
+	color: 'cyan',
 	indent: 2,
 	spinner: Spinners.dots,
 });
@@ -18,25 +18,25 @@ kia.start();
 await sleep(2000);
 
 // Change the spinner options
-kia.set({ text: "Loading some more" });
+kia.set({ text: 'Loading some more' });
 await sleep(1000);
 // Finish spinning successfully
-kia.succeed("Loaded sun");
+kia.succeed('Loaded sun');
 
-kia.start("Loading clouds");
+kia.start('Loading clouds');
 await sleep(2000);
 // Finish spinning with a warning
-kia.warn("Some clouds loaded");
+kia.warn('Some clouds loaded');
 
-kia.start("Getting the temperature");
+kia.start('Getting the temperature');
 await sleep(2000);
 // Finish spinning with an info message
-kia.info("Nice and warm!");
+kia.info('Nice and warm!');
 
-kia.start("Loading rain");
+kia.start('Loading rain');
 await sleep(2000);
 // Finish spinning with a failure message
-kia.fail("Rain could not be loaded!");
+kia.fail('Rain could not be loaded!');
 // Since success, fail, warn, and info are all wrappers around stopWithFlair: you could also do this manually like so:
 // import {bold, red} from "https://deno.land/std/fmt/colors.ts";
 // await kia.stopWithFlair(bold(red("X")), "Rain could not be loaded");

README.md

@@ -16,21 +16,20 @@
 ## Usage
 
 ```typescript
-import Kia from "https://deno.land/x/[email protected]/mod.ts";
+import Kia from 'https://deno.land/x/[email protected]/mod.ts';
 
 // Just a function to async sleep
 function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
-const kia: any = new Kia("I will be back in about 3 seconds");
+const kia: any = new Kia('I will be back in about 3 seconds');
 kia.start();
 await sleep(3000); // or any other async action that'll take some time
-kia.succeed("Action completed");
+kia.succeed('Action completed');
 ```
 
-More thorough examples are available in the
-[examples folder](https://github.com/HarryPeach/kia/tree/master/examples)
+More thorough examples are available in the [examples folder](Examples)
 
 ## API
 
@@ -44,11 +43,11 @@ Kia can be created with a string or the Options interface. A string is simply
 mapped to `Options.text`
 
 ```typescript
-const kia = new Kia("Hello");
+const kia = new Kia('Hello');
 // or
 const kia = new Kia({
-	text: "Hello",
-	color: "Red",
+	text: 'Hello',
+	color: 'Red',
 });
 ```
 
@@ -66,8 +65,7 @@ The text to display after the spinner
 
 ##### color
 
-Type:
-[Color](https://github.com/HarryPeach/kia/blob/8fb27cbd0bb4ef08ad26124d4a6e4f2ba2dc0c5c/util.ts#L6)
+Type: [Color](Source/util.ts)
 
 Default: "white"
 
@@ -76,8 +74,7 @@ the Deno standard colors.
 
 ##### spinner
 
-Type:
-[Spinner](https://github.com/HarryPeach/kia/blob/8fb27cbd0bb4ef08ad26124d4a6e4f2ba2dc0c5c/spinners.ts#L1)
+Type: [Spinner](Source/spinners.ts)
 
 Default: Dependent on OS (See below)
 
@@ -140,8 +137,8 @@ Stops the spinner and clears the line. Returns Kia instance.
 Allows you to change the spinners options. Returns Kia instance.
 
 ```typescript
-const kia = new Kia("Hello");
-kia.set({ text: "Goodbye", color: "Red" });
+const kia = new Kia('Hello');
+kia.set({ text: 'Goodbye', color: 'Red' });
 ```
 
 #### .succeed(text?)
@@ -183,7 +180,7 @@ Returns the current spinner frame
 ### forPromise(action, options)
 
 ```typescript
-import { forPromise } from "https://deno.land/x/[email protected]/mod.ts";
+import { forPromise } from 'https://deno.land/x/[email protected]/mod.ts';
 
 forPromise(
 	async () => {

Source/deps.ts

@@ -0,0 +1,4 @@
+export * as Colors from 'https://deno.land/[email protected]/fmt/colors.ts';
+export * from 'https://deno.land/[email protected]/testing/asserts.ts';
+export * from 'https://deno.land/x/[email protected]/mod.ts';
+export * from 'https://deno.land/[email protected]/streams/conversion.ts';

kia.ts → Source/kia.ts

@@ -1,13 +1,13 @@
-import { Spinner, Spinners } from "./spinners.ts";
+import { Spinner, Spinners } from './spinners.ts';
 import {
 	clearLine,
 	Color,
 	colorise,
 	hideCursor,
 	showCursor,
 	writeLine,
-} from "./util.ts";
-import { Colors } from "./deps.ts";
+} from './util.ts';
+import { Colors } from './deps.ts';
 
 export interface Options {
 	text: string;
@@ -22,10 +22,10 @@ type InputOptions = Partial<Options>;
 
 export default class Kia {
 	private options: Options = {
-		text: "",
-		color: "white",
-		spinner: Deno.build.os === "windows" ? Spinners.windows : Spinners.dots,
-		prefixText: "",
+		text: '',
+		color: 'white',
+		spinner: Deno.build.os === 'windows' ? Spinners.windows : Spinners.dots,
+		prefixText: '',
 		indent: 0,
 		cursor: false,
 		writer: Deno.stdout,
@@ -39,7 +39,7 @@ export default class Kia {
 
 	constructor(options?: InputOptions | string) {
 		if (!options) return;
-		if (typeof options === "string") {
+		if (typeof options === 'string') {
 			options = {
 				text: options,
 			};
@@ -49,7 +49,7 @@ export default class Kia {
 	}
 
 	public set(options: InputOptions | string) {
-		if (typeof options === "string") {
+		if (typeof options === 'string') {
 			options = {
 				text: options,
 			};
@@ -101,7 +101,7 @@ export default class Kia {
 	renderNextFrame() {
 		if (this.spinning) {
 			throw new Error(
-				"You cannot manually render frames when the spinner is running, run stopAndPersist() first.",
+				'You cannot manually render frames when the spinner is running, run stopAndPersist() first.',
 			);
 		}
 		this.currentFrame = (this.currentFrame + 1) %
@@ -150,7 +150,7 @@ export default class Kia {
 			text,
 			Colors.bold(
 				Colors.green(
-					Deno.build.os === "windows" ? String.fromCharCode(30) : "√",
+					Deno.build.os === 'windows' ? String.fromCharCode(30) : '√',
 				),
 			),
 		);
@@ -163,7 +163,7 @@ export default class Kia {
 	 * @param text The message to be shown when stopped
 	 */
 	fail(text: string = this.options.text) {
-		return this.stopWithFlair(text, Colors.bold(Colors.red("X")));
+		return this.stopWithFlair(text, Colors.bold(Colors.red('X')));
 	}
 
 	/**
@@ -173,7 +173,7 @@ export default class Kia {
 	 * @param text The message to be shown when stopped
 	 */
 	warn(text: string = this.options.text) {
-		return this.stopWithFlair(text, Colors.bold(Colors.yellow("!")));
+		return this.stopWithFlair(text, Colors.bold(Colors.yellow('!')));
 	}
 
 	/**
@@ -183,7 +183,7 @@ export default class Kia {
 	 * @param text The message to be shown when stopped
 	 */
 	info(text: string = this.options.text) {
-		return this.stopWithFlair(text, Colors.bold(Colors.blue("i")));
+		return this.stopWithFlair(text, Colors.bold(Colors.blue('i')));
 	}
 
 	/**

spinners.ts → Source/spinners.ts

@@ -6,14 +6,14 @@ export interface Spinner {
 export const Spinners = {
 	windows: {
 		interval: 80,
-		frames: ["/", "-", "\\", "|"],
+		frames: ['/', '-', '\\', '|'],
 	},
 	dots: {
 		interval: 80,
-		frames: ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
+		frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
 	},
 	arc: {
 		interval: 100,
-		frames: ["◜", "◠", "◝", "◞", "◡", "◟"],
+		frames: ['◜', '◠', '◝', '◞', '◡', '◟'],
 	},
 };

util.ts → Source/util.ts

@@ -1,21 +1,21 @@
-import { Colors, writeAllSync } from "./deps.ts";
+import { Colors, writeAllSync } from './deps.ts';
 
 // Terminal escape sequences
-const ESC = "\x1b[";
+const ESC = '\x1b[';
 
 /**
  * The colors to be used with the Kia spinner
  */
 export type Color =
-	| "black"
-	| "red"
-	| "green"
-	| "yellow"
-	| "blue"
-	| "magenta"
-	| "cyan"
-	| "white"
-	| "gray";
+	| 'black'
+	| 'red'
+	| 'green'
+	| 'yellow'
+	| 'blue'
+	| 'magenta'
+	| 'cyan'
+	| 'white'
+	| 'gray';
 
 /**
  * Converts the Kia color type to the Deno color functions
@@ -38,27 +38,27 @@ export function writeLine(
 ) {
 	writeAllSync(
 		writer,
-		encoder.encode(`\r${indent ? ESC + indent + "C" : ""}${text}`),
+		encoder.encode(`\r${indent ? ESC + indent + 'C' : ''}${text}`),
 	);
 }
 
 /**
  * Clears the line and performs a carriage return
  */
 export function clearLine(writer: Deno.WriterSync, encoder: TextEncoder) {
-	writeAllSync(writer, encoder.encode(ESC + "2K\r"));
+	writeAllSync(writer, encoder.encode(ESC + '2K\r'));
 }
 
 /**
  * Hides the terminal cursor
  */
 export function hideCursor(writer: Deno.WriterSync, encoder: TextEncoder) {
-	writeAllSync(writer, encoder.encode(ESC + "?25l"));
+	writeAllSync(writer, encoder.encode(ESC + '?25l'));
 }
 
 /**
  * Shows the terminal cursor
  */
 export function showCursor(writer: Deno.WriterSync, encoder: TextEncoder) {
-	writeAllSync(writer, encoder.encode(ESC + "?25h"));
+	writeAllSync(writer, encoder.encode(ESC + '?25h'));
 }