@hubol/smooch 1.0.0-beta.2 → 1.0.0-beta.20

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@hubol/smooch",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.20",
   "description": "Generate texture atlases, browser-compatible audio, and source code from directories",
   "bin": {
     "smooch": "index.js"
   },
   "author": "Hubol",
-  "license": "ISC"
-}
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hubol/smooch.git"
+  }
+}

package/schema.json

@@ -12,7 +12,7 @@
     },
     "typeof__tag": {
       "properties": {
-        "__@toStringTag@490": {
+        "__@toStringTag@299": {
           "type": "string"
         },
         "description": {
@@ -23,7 +23,7 @@
     },
     "typeof__tag_1": {
       "properties": {
-        "__@toStringTag@490": {
+        "__@toStringTag@299": {
           "type": "string"
         },
         "description": {
@@ -34,7 +34,7 @@
     },
     "typeof__tag_2": {
       "properties": {
-        "__@toStringTag@490": {
+        "__@toStringTag@299": {
           "type": "string"
         },
         "description": {
@@ -54,6 +54,19 @@
       },
       "type": "object"
     },
+    "{endOfLineSequence:\"crlf\"|\"lf\"|\"os\";}": {
+      "properties": {
+        "endOfLineSequence": {
+          "enum": [
+            "crlf",
+            "lf",
+            "os"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "{format:string;zip?:Path.File.t|undefined;directory?:Path.Directory.t|undefined;}": {
       "properties": {
         "directory": {
@@ -155,6 +168,9 @@
       },
       "type": "array"
     },
+    "global": {
+      "$ref": "#/definitions/{endOfLineSequence:\"crlf\"|\"lf\"|\"os\";}"
+    },
     "jsonFiles": {
       "items": {
         "$ref": "#/definitions/{glob:Path.Glob.t;template:{program:Path.File.t;out:Path.File.t;};}"
@@ -169,4 +185,4 @@
     }
   },
   "type": "object"
-}
+}

package/template-api.d.ts

@@ -1,54 +1,189 @@
-interface Options {
-    splitRegexp?: RegExp | RegExp[];
-    stripRegexp?: RegExp | RegExp[];
-    delimiter?: string;
-    transform?: (part: string, index: number, parts: string[]) => string;
-}
-
-declare function pascalCase(input: string, options?: Options): string;
+import * as fs from 'fs';
+import * as path from 'path';
 
-declare function camelCase(input: string, options?: Options): string;
+type EndOfLineSequence = "crlf" | "lf" | "os";
 
-declare function jsBeautify(source: string, options?: JSBeautifyOptions): string;
-interface CoreBeautifyOptions {
-    disabled?: boolean | undefined;
-    eol?: string | undefined;
-    end_with_newline?: boolean | undefined;
-    indent_size?: number | undefined;
-    indent_char?: string | undefined;
-    indent_level?: number | undefined;
-    preserve_newlines?: boolean | undefined;
-    max_preserve_newlines?: number | undefined;
-    indent_with_tabs?: boolean | undefined;
-    wrap_line_length?: number | undefined;
-    indent_empty_lines?: boolean | undefined;
-    templating?: string[] | undefined;
-}
-interface JSBeautifyOptions extends CoreBeautifyOptions {
-    brace_style?: 'collapse' | 'expand' | 'end-expand' | 'none' | 'preserve-inline' | undefined;
-    unindent_chained_methods?: boolean | undefined;
-    break_chained_methods?: boolean | undefined;
-    space_in_paren?: boolean | undefined;
-    space_in_empty_paren?: boolean | undefined;
-    jslint_happy?: boolean | undefined;
-    space_after_anon_function?: boolean | undefined;
-    space_after_named_function?: boolean | undefined;
-    keep_array_indentation?: boolean | undefined;
-    space_before_conditional?: boolean | undefined;
-    unescape_strings?: boolean | undefined;
-    e4x?: boolean | undefined;
-    comma_first?: boolean | undefined;
-    operator_position?: 'before-newline' | 'after-newline' | 'preserve-newline' | undefined;
-    test_output_raw?: boolean | undefined;
+declare namespace Boundary_Prettier {
+    interface PrinterOptions {
+        /**
+         * Specify the line length that the printer will wrap on.
+         * @default 80
+         */
+        printWidth: number;
+        /**
+         * Specify the number of spaces per indentation-level.
+         * @default 2
+         */
+        tabWidth: number;
+        /**
+         * Indent lines with tabs instead of spaces
+         * @default false
+         */
+        useTabs?: boolean;
+        parentParser?: string | undefined;
+        __embeddedInHtml?: boolean | undefined;
+    }
+    type LiteralUnion<T extends U, U = string> = T | (Pick<U, never> & {
+        _?: never | undefined;
+    });
+    export type BuiltInParserName = "acorn" | "angular" | "babel-flow" | "babel-ts" | "babel" | "css" | "espree" | "flow" | "glimmer" | "graphql" | "html" | "json-stringify" | "json" | "json5" | "less" | "lwc" | "markdown" | "mdx" | "meriyah" | "scss" | "typescript" | "vue" | "yaml";
+    export interface Options extends PrinterOptions {
+        /**
+         * Print semicolons at the ends of statements.
+         * @default true
+         */
+        semi: boolean;
+        /**
+         * Use single quotes instead of double quotes.
+         * @default false
+         */
+        singleQuote: boolean;
+        /**
+         * Use single quotes in JSX.
+         * @default false
+         */
+        jsxSingleQuote: boolean;
+        /**
+         * Print trailing commas wherever possible.
+         * @default "all"
+         */
+        trailingComma: "none" | "es5" | "all";
+        /**
+         * Print spaces between brackets in object literals.
+         * @default true
+         */
+        bracketSpacing: boolean;
+        /**
+         * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
+         * alone on the next line (does not apply to self closing elements).
+         * @default false
+         */
+        bracketSameLine: boolean;
+        /**
+         * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
+         * @default false
+         * @deprecated use bracketSameLine instead
+         */
+        jsxBracketSameLine: boolean;
+        /**
+         * Format only a segment of a file.
+         * @default 0
+         */
+        rangeStart: number;
+        /**
+         * Format only a segment of a file.
+         * @default Number.POSITIVE_INFINITY
+         */
+        rangeEnd: number;
+        /**
+         * Specify which parser to use.
+         */
+        parser: LiteralUnion<BuiltInParserName>;
+        /**
+         * Specify the input filepath. This will be used to do parser inference.
+         */
+        filepath: string;
+        /**
+         * Prettier can restrict itself to only format files that contain a special comment, called a pragma, at the top of the file.
+         * This is very useful when gradually transitioning large, unformatted codebases to prettier.
+         * @default false
+         */
+        requirePragma: boolean;
+        /**
+         * Prettier can insert a special @format marker at the top of files specifying that
+         * the file has been formatted with prettier. This works well when used in tandem with
+         * the --require-pragma option. If there is already a docblock at the top of
+         * the file then this option will add a newline to it with the @format marker.
+         * @default false
+         */
+        insertPragma: boolean;
+        /**
+         * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
+         * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
+         * @default "preserve"
+         */
+        proseWrap: "always" | "never" | "preserve";
+        /**
+         * Include parentheses around a sole arrow function parameter.
+         * @default "always"
+         */
+        arrowParens: "avoid" | "always";
+        /**
+         * Provide ability to support new languages to prettier.
+         */
+        plugins: Array<string | Plugin>;
+        /**
+         * How to handle whitespaces in HTML.
+         * @default "css"
+         */
+        htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
+        /**
+         * Which end of line characters to apply.
+         * @default "lf"
+         */
+        endOfLine: "auto" | "lf" | "crlf" | "cr";
+        /**
+         * Change when properties in objects are quoted.
+         * @default "as-needed"
+         */
+        quoteProps: "as-needed" | "consistent" | "preserve";
+        /**
+         * Whether or not to indent the code inside <script> and <style> tags in Vue files.
+         * @default false
+         */
+        vueIndentScriptAndStyle: boolean;
+        /**
+         * Control whether Prettier formats quoted code embedded in the file.
+         * @default "auto"
+         */
+        embeddedLanguageFormatting: "auto" | "off";
+        /**
+         * Enforce single attribute per line in HTML, Vue and JSX.
+         * @default false
+         */
+        singleAttributePerLine: boolean;
+    }
+    export interface Api {
+        format(source: string, options?: Options): Promise<string>;
+    }
+    export {};
 }
 
 declare const utils: {
-    camel: typeof camelCase;
-    pascal: typeof pascalCase;
+    camel: (string: string) => string;
+    pascal: (string: string) => string;
+    kebab: (string: string) => string;
     noext: (string: string) => string;
     json: (object: any) => string;
     oneline: (string: string) => string;
-    beautify: typeof jsBeautify;
+    format: (source: string, options?: Boundary_Prettier.Options | undefined) => Promise<string>;
+    Fs: {
+        resolve: (...paths: string[]) => string;
+        _setWriteFileLineEnding: (endOfLineSequence: EndOfLineSequence) => void;
+        normalize(path: string): string;
+        join(...paths: string[]): string;
+        isAbsolute(path: string): boolean;
+        relative(from: string, to: string): string;
+        dirname(path: string): string;
+        basename(path: string, suffix?: string | undefined): string;
+        extname(path: string): string;
+        sep: "\\" | "/";
+        delimiter: ";" | ":";
+        parse(path: string): path.ParsedPath;
+        format(pathObject: path.FormatInputPathObject): string;
+        toNamespacedPath(path: string): string;
+        posix: path.PlatformPath;
+        win32: path.PlatformPath;
+        createWriteStream: typeof fs.createWriteStream;
+        readFile: typeof fs.readFile.__promisify__;
+        readFileSync: typeof fs.readFileSync;
+        writeFile: (file: fs.PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView) => Promise<void>;
+        copyFile: typeof fs.copyFile.__promisify__;
+        mkdir: (path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null | undefined) => Promise<void>;
+        rm: typeof fs.rm.__promisify__;
+        exists: typeof fs.exists.__promisify__;
+        rename: typeof fs.rename.__promisify__;
+    };
 };
 type Utils = typeof utils;
 
@@ -330,10 +465,11 @@ type GlobRoot = string & {
     readonly __tag: unique symbol;
 };
 
-declare function createAtlases(imageFilePaths: string[], options: Infer<typeof PackerOptions>): Promise<(Bin<{
-    width: number;
+declare function createAtlases(imageFilePaths: Path.File.t[], options: Infer<typeof PackerOptions>): Promise<(Bin<{
+    buffer: Buffer;
+    filePath: Path.File.t;
     height: number;
-    filePath: string;
+    width: number;
 } & {
     x: number;
     y: number;
@@ -345,9 +481,10 @@ declare function createAtlases(imageFilePaths: string[], options: Infer<typeof P
 type Atlases = AsyncReturnType<typeof createAtlases>;
 declare function createTemplateContext(atlases: Atlases, globRoot: GlobRoot): {
     atlases: (Bin<{
-        width: number;
+        buffer: Buffer;
+        filePath: Path.File.t;
         height: number;
-        filePath: string;
+        width: number;
     } & {
         x: number;
         y: number;

package/templates/audio-convert.js

@@ -1,14 +1,14 @@
-/**
-@param {import("smooch/template-api").TemplateContext.AudioConvert} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ files }, { pascal, noext }) {
-    return `
-// This file is generated
-
-export const Sfx = {
-${files.map(file =>
-`   "${pascal(noext(file.path))}": { ogg: "${file.convertedPaths.ogg}", mp3: "${file.convertedPaths.mp3}", }`).join(`,
-`)}
-}`;
+/**
+@param {import("@hubol/smooch/template-api").TemplateContext.AudioConvert} context;
+@param {import("@hubol/smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ files }, { pascal, noext }) {
+    return `
+// This file is generated
+
+export const Sfx = {
+${files.map(file =>
+`   "${pascal(noext(file.path))}": { ogg: "${file.convertedPaths.ogg}", mp3: "${file.convertedPaths.mp3}", }`).join(`,
+`)}
+}`;
 }

package/templates/json-aggregate.js

@@ -1,12 +1,12 @@
-/**
-@param {import("smooch/template-api").TemplateContext.JsonAggregate} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ files }, { pascal, noext, oneline, json }) {
-    return `// This file is generated.
-
-export const JsonFiles = {
-${ files.map(file => `  "${ pascal(noext(file.fileName)) }": ${ oneline(json(file.json)) }`).join(`,
-`) }
-}`;
+/**
+@param {import("@hubol/smooch/template-api").TemplateContext.JsonAggregate} context;
+@param {import("@hubol/smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ files }, { pascal, noext, oneline, json }) {
+    return `// This file is generated.
+
+export const JsonFiles = {
+${ files.map(file => `  "${ pascal(noext(file.fileName)) }": ${ oneline(json(file.json)) }`).join(`,
+`) }
+}`;
 }

package/templates/texture-pack.js

@@ -1,16 +1,16 @@
-/**
-@param {import("smooch/template-api").TemplateContext.TexturePack} context;
-@param {import("smooch/template-api").Utils} utils;
-*/
-module.exports = function ({ atlases, textures }, { pascal, noext }) {
-    return `
-// This file is generated
-
-export const Atlases = [ ${atlases.map(x => `"${x.fileName}"`).join(', ')} ];
-
-export const Txs = {
-${textures.map(tx =>
-`   "${pascal(noext(tx.fileName))}": { atlas: "${tx.atlasFileName}", x: ${tx.x}, y: ${tx.y}, width: ${tx.width}, height: ${tx.height} }`).join(`,
-`)}
-}`;
+/**
+@param {import("@hubol/smooch/template-api").TemplateContext.TexturePack} context;
+@param {import("@hubol/smooch/template-api").Utils} utils;
+*/
+module.exports = function ({ atlases, textures }, { pascal, noext }) {
+    return `
+// This file is generated
+
+export const Atlases = [ ${atlases.map(x => `"${x.fileName}"`).join(', ')} ];
+
+export const Txs = {
+${textures.map(tx =>
+`   "${pascal(noext(tx.fileName))}": { atlas: "${tx.atlasFileName}", x: ${tx.x}, y: ${tx.y}, width: ${tx.width}, height: ${tx.height} }`).join(`,
+`)}
+}`;
 }