@syncify/cli 0.3.0-beta → 1.0.0-unstable.0

package/types/transforms/script.d.ts

@@ -1,308 +0,0 @@
-/* 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 '../bundle/shared';
-
-type TargetBrowser = (
-  | 'chrome'
-  | 'deno'
-  | 'edge'
-  | 'firefox'
-  | 'hermes'
-  | 'ie'
-  | 'ios'
-  | 'node'
-  | 'opera'
-  | 'rhino'
-  | 'safari'
-);
-
-type TargetBrowserVersion = (
-  | `${TargetBrowser}${number}`
-  | `${TargetBrowser}${number}.${number}`
-  | `${TargetBrowser}${number}.${number}.${number}`
-);
-
-type TargetESVersion = (
-  | 'es3'
-  | 'es5'
-  | 'es6'
-  | 'es2015'
-  | 'es2016'
-  | 'es2017'
-  | 'es2018'
-  | 'es2019'
-  | 'es2020'
-  | 'es2021'
-  | 'es2022'
-  | 'esnext'
-);
-
-type ESBuildAllowedOptions = Pick<ESBuildOptions, (
-  | 'alias'
-  | 'assetNames'
-  | 'banner'
-  | 'bundle'
-  | 'charset'
-  | 'chunkNames'
-  | 'entryNames'
-  | 'conditions'
-  | 'define'
-  | 'external'
-  | 'footer'
-  | 'format'
-  | 'globalName'
-  | 'tsconfigRaw'
-  | 'tsconfig'
-  | 'treeShaking'
-  | 'target'
-  | 'jsx'
-  | 'jsxDev'
-  | 'jsxFactory'
-  | 'jsxFragment'
-  | 'jsxImportSource'
-  | 'jsxSideEffects'
-  | 'inject'
-  | 'ignoreAnnotations'
-  | 'drop'
-  | 'splitting'
-  | 'supported'
-  | 'sourcesContent'
-  | 'sourceRoot'
-  | 'sourcemap'
-  | 'pure'
-  | 'plugins'
-  | 'metafile'
-  | 'loader'
-  | 'publicPath'
-)>
-
-export { ESBuildOptions };
-
-export type Target = (
-  | TargetBrowser
-  | TargetBrowserVersion
-  | TargetESVersion
-);
-
-/**
- * Public exposed configurations
- */
-export type ESBuildConfig = Merge<ESBuildAllowedOptions, {
-    /**
-     * 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                                    */
-/* -------------------------------------------- */
-
-interface ScriptSharedConfig {
-  /**
-   * JS/TS input source paths. Accepts `string` or `string[]` glob patterns.
-   * Resolution is relative to your defined `input` directory.
-   *
-   * ---
-   *
-   * @default undefined
-   */
-  input: string | string[];
-  /**
-   * This sets the target environment for the generated JavaScript. It
-   * tells esbuild to transform JavaScript syntax which is too new for
-   * these environments into older JavaScript syntax that works in this
-   * environment\s.
-   *
-   * ---
-   *
-   * @default 'es2016'
-   */
-  target?: Target | Target[];
-  /**
-   * Instructs ESBuild to treat these modules as external. The import/s
-   * will be preserved and evaluated at run time instead.
-   *
-   * ---
-   *
-   * @see
-   * https://esbuild.github.io/api/#external
-   *
-   * @default
-   * []
-   */
-  external?: string[];
-  /**
-   * Rename the JavaScript 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 as a
-   * `snippet.liquid` file.
-   *
-   * @default false
-   */
-  snippet?: boolean;
-  /**
-   * Entry points (paths/files) to watch that will trigger a rebuilds of
-   * the defined _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;
-}
-
-interface ScriptFormatESM extends ScriptSharedConfig {
-
-  /**
-   * 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';
-}
-
-interface ScriptFormatIIFE extends ScriptSharedConfig {
-  /**
-   * The format to be generated. Because we are targeting
-   * browser environments, Syncify does not allow for CJS (commonjs)
-   * bundles to be produced.
-   *
-   * @see https://esbuild.github.io/api/#format
-   * @default 'esm'
-   */
-  format?: 'iife';
-  /**
-   * Sets the name of the global variable which is used to store the
-   * exports from the entry point.
-   *
-   * @see https://esbuild.github.io/api/#global-name
-   * @default undefined
-   */
-  globalName?: string;
-}
-
-export type ScriptTransform = ScriptFormatESM | ScriptFormatIIFE;
-
-/* -------------------------------------------- */
-/* TRANSFORMER                                  */
-/* -------------------------------------------- */
-
-export type ScriptTransformer = (
-  | string
-  | string[]
-  | ScriptTransform
-  | ScriptTransform[]
-  | { [rename: RenamePaths]: string | string[] | Omit<ScriptTransform, 'rename'> }
-)
-
-/* -------------------------------------------- */
-/* INTERAL USE                                  */
-/* -------------------------------------------- */
-
-/**
- * **INTERNAL USE**
- *
- * Processor Configuration
- */
-export type ESBuildProcesser = Merge<GetProcessorConfigs<ESBuildOptions>, {
-  /**
-   * Despite the name, this getter represents both
-   * `tsconfig.json` or `jsconfig.json` files.
-   */
-  get tsconfig(): Tsconfig,
-}>
-
-/**
- * **INTERNAL USE**
- *
- * Bundling Configuration for scripts
- */
-export interface ScriptBundle {
-  /**
-   * A UUID reference for this $.
-   */
-  uuid: string;
-  /**
-   * Resolved input path. Passed to the ESBuild `entryPoint` option.
-   */
-  input: string;
-  /**
-   * The namespace value, used in CLI logs
-   */
-  namespace: string;
-  /**
-   * Whether or not to export as a snippet
-   */
-  snippet: boolean;
-  /**
-   * Resolved key reference, used in the Shopify sync requests
-   */
-  key: string;
-  /**
-   * Resolved output path where the transformed file should be written.
-   * This value will have a rename applied in the uri.
-   */
-  output: string;
-  /**
-   * Imports contained in the input. This is used to trigger a build.
-   * Matches applied to the anymatch pattern at runtime.
-   */
-  watch: Set<string>;
-  /**
-   * The size in bytes of the generated file. This metric is obtained
-   * on the pre-complile at runtime when importer paths are collected.
-   * The value will be `NaN` unless executing in `--terse` (or `--prod`).
-   */
-  size: number;
-  /**
-   * Watch extendables - This `Set` accounts for watch paths defined
-   * by the user. We keep them isolated to ensure they are not removed
-   * when importers are adjusted during re-builds.
-   */
-  watchCustom: Tester;
-  /**
-   * ESBuild options which will either use the processor defaults or
-   * if defined on script $, will be merged with processor defaults.
-   */
-  esbuild: ESBuildOptions
-}

package/types/transforms/style.d.ts

@@ -1,219 +0,0 @@
-/* eslint-disable no-unused-vars */
-
-import type { LiteralUnion, Merge } from 'type-fest';
-import type { Tester } from 'anymatch';
-import type { Config as TailwindConfig } from 'tailwindcss';
-import type { Plugin as PostCSSPlugin, Transformer, TransformCallback } from 'postcss';
-import type { GetProcessorConfigs, RenamePaths } from '../bundle/shared';
-
-/* -------------------------------------------- */
-/* PROCESSOR CONFIGS                            */
-/* -------------------------------------------- */
-
-export type PostCSSConfig = (
-  | PostCSSPlugin
-  | Transformer
-  | TransformCallback
-);
-
-export interface TailwindCSSConfig {
-  important: TailwindConfig['important'];
-  prefix: TailwindConfig['PrefixConfig'];
-  separator: TailwindConfig['SeparatorConfig'];
-  safelist: TailwindConfig['SafelistConfig'];
-  blocklist: TailwindConfig['BlocklistConfig'];
-  presets: TailwindConfig['presets'];
-  future: TailwindConfig['future'];
-  experimental: TailwindConfig['experimental'];
-  darkMode: TailwindConfig['darkMode'];
-  theme: TailwindConfig['theme'];
-  corePlugins: TailwindConfig['corePlugins'];
-  plugins: TailwindConfig['plugins'];
-}
-
-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;
-  /**
-   * **NOT YET AVAILABLE**
-   *
-   * [TailwindCSS](https://tailwindcss.com/) Override
-   *
-   * Tailwind transforms will use the `tailwind.config.js` configuration
-   * file in your projects root (or defined `config` path). If you have not
-   * provided a tailwind config file, then syncify will use options defined
-   * via `processor.tailwind`. You can optionally override configuration
-   * on a per-transform basis and any options defined here will be merged with
-   * those defined in your `tailwind.config.js` or `processor.tailwind`.
-   *
-   * @default true // if tailwind is not installed this is false
-   */
-  tailwind?: boolean | TailwindCSSConfig;
-  /**
-   * [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 SASS transfroms by passing a _boolean_ `false` which will
-   * inform Syncify to not pass output to SASS, which is the default if SASS is not
-   * installed.
-   *
-   * By default, Syncify will forward all input files using `.scss` or `.sass`
-   * or extension to SASS Dart. If you have PostCSS installed then Syncify will
-   * automatically pass SASS files to PostCSS in the post-process.
-   *
-   * @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**
- *
- * PostCSS Processor Configuration
- */
-export type PostCSSProcesser = GetProcessorConfigs<PostCSSConfig[]>;
-
-/**
- * **INTERNAL USE**
- *
- * Tailwind Processor Configuration
- */
-export type TailwindCSSProcesser = GetProcessorConfigs<TailwindCSSConfig>
-
-/**
- * **INTERNAL USE**
- *
- * SASS Processor Configuration
- */
-export type SASSProcesser = GetProcessorConfigs<SASSConfig>
-
-/**
- * **INTERNAL USE**
- *
- * Bundling Configuration
- */
-export type StyleBundle = Merge<StyleTransform, {
-  /**
-   * A UUID reference for this $.
-   */
-  uuid: string;
-  /**
-   * Resolved input path
-   */
-  input: string;
-  /**
-   * Anymatch function
-   */
-  watch: Tester;
-}>;

package/types/transforms/svg.d.ts

@@ -1,189 +0,0 @@
-/* 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 '../bundle/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 $.
-   */
-  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;
-}>;