@syncify/cli 0.1.0-beta

package/types/transforms/json.d.ts

@@ -0,0 +1,42 @@
+import type { Tester } from 'anymatch';
+import type { Merge } from 'type-fest';
+
+export interface JSONConfig {
+  /**
+   * The indentation level
+   *
+   * @default 2
+   */
+  indent?: number;
+  /**
+   * Whether to use `\t` identation characters.
+   *
+   * @default false
+   */
+  useTab?: boolean;
+  /**
+   * If line termination should be Windows (CRLF) format.
+   * Unix (LF) format is the default.
+   *
+   * @default false
+   */
+  crlf?: boolean;
+  /**
+   * An optional string list of paths/filenames to exclude
+   * from processing, ie: pass through
+   *
+   * @default false
+   */
+  exclude?: string[]
+}
+
+/* -------------------------------------------- */
+/* INTERAL USE                                  */
+/* -------------------------------------------- */
+
+/**
+ * **INTERNAL USE**
+ *
+ * Bundling Configuration
+ */
+export type JSONBundle = Merge<JSONConfig, { exclude: Tester }>;

package/types/transforms/script.d.ts

@@ -0,0 +1,174 @@
+/* eslint-disable no-unused-vars */
+import type { Merge } from 'type-fest';
+import type { Tester } from 'anymatch';
+import type { Tsconfig } from 'tsconfig-type';
+import type { BuildOptions as ESBuildOptions } from 'esbuild';
+import type { GetProcessorConfigs, RenamePaths } from '../misc/shared';
+
+export type ESBuildConfig = Merge<Pick<ESBuildOptions,
+  | 'bundle'
+  | 'treeShaking'
+  | 'tsconfig'
+  | 'target'
+  | 'splitting'
+  | 'pure'
+  | 'define'
+  | 'format'
+  | 'banner'
+  | 'footer'
+  | 'charset'
+  | 'chunkNames'
+  | 'drop'
+  | 'ignoreAnnotations'
+  | 'jsx'
+  | 'jsxDev'
+  | 'jsxFactory'
+  | 'jsxFragment'
+  | 'jsxImportSource'
+  | 'mainFields'
+  | 'metafile'
+  | 'resolveExtensions'
+  | 'supported'
+  | 'plugins'
+  >, {
+    /**
+     * The format to be generated. Because we are targeting
+     * browser environments, Syncify does not allow for CJS (commonjs)
+     * bundles to be produced.
+     *
+     * @default 'esm'
+     */
+    format?: 'esm' | 'iife';
+    /**
+     * Whether or not sourcemaps should be generated.
+     * Syncify will process sourcemap generation internally,
+     * so this option only accepts a boolean value.
+     *
+     * @default true
+     */
+    sourcemap?: boolean;
+  }
+>;
+
+/* -------------------------------------------- */
+/* TRANSFORM                                    */
+/* -------------------------------------------- */
+
+export interface ScriptTransform {
+  /**
+   * JS/TS input source paths. Accepts `string` or `string[]` glob patterns.
+   * Resolution is relative to your defined `input` directory.
+   *
+   * @default undefined
+   */
+  input: string | string[];
+   /**
+     * The format to be generated. Because we are targeting
+     * browser environments, Syncify does not allow for CJS (commonjs)
+     * bundles to be produced.
+     *
+     * @default 'esm'
+     */
+  format?: 'esm' | 'iife';
+  /**
+   * Rename the stylesheet file/s. The same name as source file will be used
+   * when undefined. Accepts namespaces, `[file]`, `[dir]` and `[ext]`.
+   *
+   * ---
+   *
+   * @default undefined
+   */
+  rename?: string;
+  /**
+   * Optionally write the javascript file inline as a snippet. This will transform
+   * the JS and contained code will be output within `<script></script>` tags output as a
+   * `snippet.liquid` file.
+   *
+   * @default false
+   */
+  snippet?: boolean;
+  /**
+   * Entry points (paths/files) to watch that will trigger a rebuilds of
+   * the define _input_ file. By default, Syncify will watch all import entries
+   * imported by the _input_.
+   *
+   * @default []
+   */
+  watch?: string[];
+  /**
+   * [ESBuild](https://esbuild.github.io/) Override
+   *
+   * ESBuild file transforms will use the options provided to `processor.esbuild`
+   * but you can optionally override those defaults on a per-transform
+   * basis. Any configuration options defined here will be merged with
+   * the options defined in `processor.esbuild`.
+   *
+   * You can also skip pre-processing with esbuild by passing a _boolean_
+   * `false` which will inform Syncify to process scripts with ESBuild.
+   *
+   * @default true // if esbuild is not installed this is false
+   */
+  esbuild?: boolean | ESBuildConfig;
+}
+
+/* -------------------------------------------- */
+/* TRANSFORMER                                  */
+/* -------------------------------------------- */
+
+export type ScriptTransformer = (
+  | string
+  | string[]
+  | ScriptTransform
+  | ScriptTransform[]
+  | {
+    [K in RenamePaths]: (
+      | string
+      | string[]
+      | Pick<ScriptTransform,
+        | 'input'
+        | 'format'
+        | 'snippet'
+        | 'watch'
+        | 'esbuild'
+      >
+    )
+  }
+)
+
+/* -------------------------------------------- */
+/* INTERAL USE                                  */
+/* -------------------------------------------- */
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type ESBuildProcesser = Merge<
+  GetProcessorConfigs<ESBuildOptions>,
+  {
+    get tsconfig(): Tsconfig,
+  }
+>
+
+/**
+ * **INTERNAL USE**
+ *
+ * Bundling Configuration
+ */
+export type ScriptBundle = Merge<ScriptTransform, {
+  /**
+   * A UUID reference for this bundle.
+   */
+  uuid: string;
+  /**
+   * Resolved input path
+   */
+  input: string;
+  /**
+   * All entry points (imports) contained in the input.
+   * Matches applied to the anymatch pattern and applied
+   * at runtime.
+   */
+  watch: Tester;
+}>;

package/types/transforms/style.d.ts

@@ -0,0 +1,178 @@
+/* eslint-disable no-unused-vars */
+
+import type { Merge } from 'type-fest';
+import type { Tester } from 'anymatch';
+import type { Plugin as PostCSSPlugin, Transformer, TransformCallback } from 'postcss';
+import type { GetProcessorConfigs, RenamePaths } from '../misc/shared';
+
+/* -------------------------------------------- */
+/* PROCESSOR CONFIGS                            */
+/* -------------------------------------------- */
+
+export type PostCSSConfig = (
+  | PostCSSPlugin
+  | Transformer
+  | TransformCallback
+);
+
+export interface SASSConfig {
+  /**
+   * Whether or not to generate sourcemaps
+   *
+   * @default true
+   */
+  sourcemap?: boolean;
+  /**
+   * The style compiled CSS should be output.
+   *
+   * @default 'compressed'
+   */
+  style?: 'expanded' | 'compressed';
+  /**
+   * Whether or not to print warnings to CLI - Warnings will require
+   * an `stdin` invocation to view. Setting this to `false` will hide
+   * warnings all together.
+   *
+   * @default true
+   */
+  warnings?: boolean;
+  /**
+   * A list of paths to include, ie: node_modules.
+   *
+   * @default ['node_modules']
+   */
+  include?: string[];
+}
+
+/* -------------------------------------------- */
+/* TRANSFORM                                    */
+/* -------------------------------------------- */
+
+export interface StyleTransform {
+  /**
+   * SVG input source paths. Accepts `string` or `string[]` glob patterns.
+   * Resolution is relative to your defined `input` directory.
+   *
+   * @default undefined
+   */
+  input: string | string[];
+  /**
+   * Glob stylesheet paths/files to watch. When changes
+   * are applied to matched files, then the defined `input`
+   * will be compiled.
+   *
+   * @default []
+   */
+  watch?: string[];
+  /**
+   * Rename the stylesheet file/s. The same name as source file will be used
+   * when undefined. Accepts namespaces, `[file]`, `[dir]` and `[ext]`.
+   *
+   * ---
+   *
+   * @default undefined
+   */
+  rename?: string;
+  /**
+   * Optionally output the CSS as a snippet. This will transform
+   * the stylesheet inline, wrap output within `<style></style>`
+   * tags and write it to `snippets`.
+   *
+   * @default false
+   */
+  snippet?: boolean;
+  /**
+   * [PostCSS](https://postcss.org/) Override
+   *
+   * CSS File transforms will use the options provided to `processor.postcss`
+   * but you can optionally override those defaults on a per-transform
+   * basis. Any configuration options defined here will be merged with
+   * the options defined in `processor.postcss`.
+   *
+   * You can also skip pre-processing with postcss by passing a _boolean_
+   * `false` which will inform Syncify to not pass output to PostCSS. By
+   * default, Syncify will pass all compiled SASS and files with `.css`
+   * extensions to PostCSS.
+   *
+   * @default true // if postcss is not installed this is false
+   */
+  postcss?: boolean | PostCSSConfig[]
+  /**
+   * [SASS Dart](https://sass-lang.com/documentation/js-api/) Override
+   *
+   * SASS File transforms will use the options provided to `processor.sass`
+   * but you can optionally override those defaults on a per-transform
+   * basis. Any configuration options defined here will be merged with
+   * the options defined in `processor.sass`.
+   *
+   * You can also skip pre-processing with postcss by passing a _boolean_
+   * `false` which will inform Syncify to not pass output to PostCSS. By
+   * default, Syncify will forward all input files using `.scss` or `.sass`
+   * or extension to SASS Dart.
+   *
+   * @default true // if sass is not installed this is false
+   */
+  sass?: boolean | SASSConfig;
+}
+
+/* -------------------------------------------- */
+/* TRANSFORMER                                  */
+/* -------------------------------------------- */
+
+export type StyleTransformer = (
+  | string
+  | string[]
+  | StyleTransform
+  | StyleTransform[]
+  | {
+    [K in RenamePaths]: (
+      | string
+      | string[]
+      | Pick<StyleTransform,
+        | 'postcss'
+        | 'sass'
+        | 'snippet'
+        | 'watch'
+        | 'input'
+      >
+    )
+  }
+)
+
+/* -------------------------------------------- */
+/* INTERNAL USE                                 */
+/* -------------------------------------------- */
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type PostCSSProcesser = GetProcessorConfigs<PostCSSConfig[]>
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type SASSProcesser = GetProcessorConfigs<SASSConfig>
+
+/**
+ * **INTERNAL USE**
+ *
+ * Bundling Configuration
+ */
+export type StyleBundle = Merge<StyleTransform, {
+  /**
+   * A UUID reference for this bundle.
+   */
+  uuid: string;
+  /**
+   * Resolved input path
+   */
+  input: string;
+  /**
+   * Anymatch function
+   */
+  watch: Tester;
+}>;

package/types/transforms/svg.d.ts

@@ -0,0 +1,189 @@
+/* eslint-disable no-unused-vars */
+
+import type { LiteralUnion, Merge } from 'type-fest';
+import type { Tester } from 'anymatch';
+import type { Config as SVGOConfig } from 'svgo';
+import type { Config as SVGSpriteConfig } from 'svg-sprite';
+import type { GetProcessorConfigs, RenamePaths } from '../misc/shared';
+
+/* -------------------------------------------- */
+/* PROCESSOR CONFIGS                            */
+/* -------------------------------------------- */
+
+export { SVGOConfig, SVGSpriteConfig };
+
+/* -------------------------------------------- */
+/* SHARED                                       */
+/* -------------------------------------------- */
+
+interface SVGShared<T extends 'file' | 'sprite'> {
+  /**
+   * SVG input source paths. Accepts `string` or `string[]` glob patterns.
+   * Resolution is relative to your defined `input` directory.
+   *
+   * @default ''
+   */
+  input: string | string[];
+  /**
+   * Rename the svg file/s. The same name as source file will be used
+   * when undefined. Accepts namespaces, `[file]`, `[dir]` and `[ext]`.
+   * ---
+   *
+   * @default undefined
+   *
+   * @example
+   * 'source/svgs/arrow.svg' > 'arrow.svg' // if snippet is false
+   * 'source/svgs/checkmark.svg' > 'checkmark.liquid' // if snippet is true
+   */
+  rename?: string;
+  /**
+   * Whether to generate svg as snippet or asset. When `true` the
+   * svg source will be written as a snippet
+   *
+   * @default false
+   */
+  snippet?: boolean;
+  /**
+   * The SVG export format. Syncify can produce 2 different SVG formats:
+   *
+   * You can omit this option when you have only 1 pre-processor installed or
+   * if you are applying a per-transfrom configuration override as it will default
+   * to the format which the inferred pre-processor produces. If you are using
+   * both the supported processors ([SVGO](https://github.com/svg/svgo) &
+   * [SVG Sprite](https://github.com/svg-sprite)) then you will need
+   * to inform Syncify on which format it should produce.
+   *
+   * ---
+   *
+   * **File Format**
+   *
+   * _SVG transforms using a `file` format require SVGO to be installed. File
+   * formats will produce individual `.svg` files from that can be output as
+   * an`asset` or inlined into a `snippet`_
+   *
+   * ---
+   *
+   * **Sprite Format**
+   *
+   * _SVG transforms using a `sprite` format require SVG Sprite to be installed.
+   * Sprite formats will produce an SVG Sprite that can be output as an `asset`
+   * or inlined into a `snippet`_
+   *
+   * ---
+   *
+   * @default
+   * undefined   // When no SVG pre-processor is installed
+   * null        // When both SVGO and SVG Sprite are installed (required)
+   * 'file'      // When SVGO is the only processor installed
+   * 'sprite'    // When SVG Sprite is the only processor installed
+   */
+  format?: LiteralUnion<T, string>;
+}
+
+export interface SVGFile extends SVGShared<'file'> {
+  /**
+   * [SVGO](https://github.com/svg/svgo) Override
+   *
+   * SVG File transforms will use the options provided to `processor.svgo`
+   * but you can optionally override those defaults on a per-transform
+   * basis. Any configuration options defined here will be merged with
+   * the options defined in `processor.svgo`.
+   *
+   * @default
+   * processor.svgo // When processor configuration is defined
+   */
+  svgo?: SVGOConfig
+}
+
+export interface SVGSprite extends SVGShared<'sprite'> {
+  /**
+   * [SVG Sprite](https://github.com/svg-sprite) Override
+   *
+   * SVG Sprite transforms will use the options provided to `processor.sprite`
+   * but you can optionally override those defaults on a per-transform
+   * basis. Any configuration options defined here will be merged with
+   * the options defined in `processor.sprite`.
+   *
+   * @default
+   * processor.sprite // When processor configuration is defined
+   */
+  sprite?: SVGSpriteConfig
+}
+
+/* -------------------------------------------- */
+/* TRANSFORM                                    */
+/* -------------------------------------------- */
+
+/**
+ * SVG processing transforms
+ */
+export type SVGTransform = (
+  | SVGFile
+  | SVGSprite
+)
+
+/* -------------------------------------------- */
+/* TRANSFORMER                                  */
+/* -------------------------------------------- */
+
+export type SVGTransformer = (
+  | string
+  | string[]
+  | SVGTransform
+  | SVGTransform[]
+  | {
+    [K in RenamePaths]: (
+      | string
+      | string[]
+      | Pick<SVGFile, 'format' | 'input' | 'snippet' | 'svgo'>
+      | Pick<SVGSprite, 'format'| 'input'| 'snippet' | 'sprite'>
+    )
+  }
+)
+
+/* -------------------------------------------- */
+/* INTERAL USE                                  */
+/* -------------------------------------------- */
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type SVGOProcesser = GetProcessorConfigs<SVGOConfig>
+
+/**
+ * **INTERNAL USE**
+ *
+ * Processor Configuration
+ */
+export type SVGSpriteProcesser = GetProcessorConfigs<SVGSpriteConfig>
+
+/**
+ * **INTERNAL USE**
+ *
+ * Bundling Configuration
+ */
+export type SVGBundle = Merge<SVGTransform, {
+  /**
+   * A UUID reference for this bundle.
+   */
+  uuid: string;
+  /**
+   * Resolved input paths (paths are expanded)
+   */
+  input: Set<string>;
+  /**
+   * File matching, used to determine when new files are
+   * added to an `input` defined path/directory.
+   */
+  match: Tester;
+  /**
+   * SVGO Override
+   */
+  svgo?: true | SVGOConfig;
+  /**
+   * SVG Sprite Override
+   */
+  sprite?: true | SVGSpriteConfig;
+}>;