@syncify/cli 0.2.4-beta → 1.0.0-alpha.1

package/types/config/terser.d.ts

@@ -1,267 +0,0 @@
-import type { BuildOptions } from 'esbuild';
-import type { LiteralUnion, Merge } from 'type-fest';
-import type { OptionsOutput as CleanCSSOptions } from 'clean-css';
-import type { HTMLMinifierTerserOptions } from '../modules/html-minifier-terser';
-
-/**
- * ESBuild minification options
- */
-export type ScriptTerse = Merge<Pick<BuildOptions,
-  | 'keepNames'
-  | 'mangleProps'
-  | 'minifyIdentifiers'
-  | 'minifySyntax'
-  | 'minifyWhitespace'
-  | 'mangleQuoted'
-  >,
-  {
-    /**
-     * List of input file names to exclude from minification
-     *
-     * @default 'none'
-     */
-    legalComments?: LiteralUnion<BuildOptions['legalComments'], string>
-    /**
-     * List of input file names to exclude from minification
-     *
-     * @default []
-     */
-    exclude?: string[];
-  }
->
-
-/**
- * JSON File Minification
- */
-export interface JSONTerse {
-  /**
-   * Minify `.json` files writing to `theme/assets`
-   *
-   * @default true
-   */
-  assets: boolean;
-  /**
-   * Minify `settings_schema.json` and `settings_data.json` config files.
-   *
-   * @default true
-   */
-  config: boolean;
-  /**
-   * Minify `locale` and `.json` files.
-   *
-   * @default true
-   */
-  locales: boolean;
-  /**
-   * Minify `metafield` and `.json` files.
-   *
-   * @default true
-   */
-  metafields: boolean;
-  /**
-   * Minify section group `.json` files
-   *
-   * @default true
-   */
-  sectionGroups: boolean;
-  /**
-   * Minify `template` and `.json` files.
-   *
-   * @default true
-   */
-  templates: boolean;
-  /**
-   * An optional list of paths/files to exclude from minification.
-   *
-   * @default []
-   */
-  exclude?: string[]
-}
-
-/**
- * Liquid Minification
- */
-export interface ViewTerse {
-  /**
-   * Minifies inner contents of `<script>` tags
-   *
-   * @default true
-   */
-  minifyScript?: boolean;
-  /**
-   * Minifies inner contents of `<style>` tags
-   *
-   * @default true
-   */
-  minifyStyle?: boolean;
-  /**
-   * Minifies JSON contained within Liquid `{% schema %}` tags.
-   *
-   * > **NOTE**
-   * >
-   * > Minifying schema tag contents has no effect on store performance.
-   *
-   * @default true
-   */
-  minifySchema?: boolean;
-  /**
-   * Remove all occurances of Liquid/HTML comments
-   *
-   * @default true
-   */
-  removeComments?: boolean;
-  /**
-   * Collapse all whitespace and newlines
-   *
-   * @default true
-   */
-  collapseWhitespace?: boolean;
-  /**
-   * Removes redundant whitespace Liquid dash trims from Liquid tags and objects.
-   *
-   * @default true
-   */
-  stripDashes?: boolean;
-  /**
-   * **NOT YET AVAILABLE**
-   *
-   * Removes all whitespace and newline occurances within Liquid syntax.
-   *
-   * > **NOTE**
-   * >
-   * > Liquid token minification has no effect on store performance.
-   *
-   * @default
-   * true
-   *
-   * @example
-   *
-   * // Assuming that collapseWhitespace is set to true.
-   * // Using this option would result in the following
-   *
-   * // BEFORE
-   *
-   * {% unless foo == bar %}
-   *  {{ some.object | filter: 'foo' }}
-   * {% endunless %}
-   *
-   * // AFTER
-   *
-   * {%unless foo==bar%}{{some.object|filter:'foo'}}{%endunless%}
-   */
-  collapseInner?: boolean;
-  /**
-   * Excluded files from minification
-   *
-   * @default []
-   */
-  exclude?: string[]
-}
-
-/**
- * Style Minification
- */
-export interface StyleTerse extends CleanCSSOptions {
- /**
-   * Whether or not to purge unused CSS class names
-   *
-   * @default false
-   */
-  purgeUnusedCSS?: boolean;
-  /**
-   * Whether or not to obfuscate CSS class names
-   *
-   * @default false
-   */
-  ofuscateClassNames?: boolean;
-  /**
-   * List of class names that should be excluded from
-   * obfuscation and shortnaming.
-   */
-  ofuscateWhitelist?: string[];
-  /**
-   * The alphabet used to generate the new class names.
-   *
-   * > **NOTE**
-   * >
-   * > There is no `d` in the default alphabet to avoid adblock issues.
-   *
-   * @default 'abcefghijklmnopqrstuvwxyz0123456789'
-   */
-  ofuscateAlphabet?: string;
-  /**
-   * Excluded files from terser minification
-   *
-   * @default []
-   */
-  exclude?: string[]
-}
-
-/* -------------------------------------------- */
-/* INTERNAL USE                                 */
-/* -------------------------------------------- */
-
-/**
- * **INTERNAL USE**
- *
- * Terser minification configuration
- */
-export interface TerserConfig {
-  /**
-   * Terse JSON Minification
-   */
-  json?: JSONTerse;
-  /**
-   * Terse View (Liquid) Minification
-   */
-  liquid?: Omit<ViewTerse, 'collapseWhitespace'>;
-  /**
-   * Terse View (HTML) Minification
-   *
-   * > Uses [html-minifier-terser](https://github.com/terser/html-minifier-terser)
-   */
-  html?: HTMLMinifierTerserOptions;
-  /**
-   * **NOTE YET AVAILABLE**
-   *
-   * Terse Style (CSS) Minification
-   *
-   * > Uses [clean-css](https://github.com/clean-css/clean-css) minification
-   * > Uses [purge-css](https://github.com/FullHuman/purgecss)
-   */
-  style?: StyleTerse;
-  /**
-   * Terse Script (JS/TS) Minification
-   *
-   * > Uses [esbuild](https://esbuild.github.io/api/#minify) minificiation
-   */
-  script?: ScriptTerse;
-}
-
-/**
- * **INTERNAL USE**
- *
- * Terser minification configuration
- */
-export interface TerserBundle {
-  /**
-   * Terse JSON Minification
-   *
-   * @default false
-   */
-  json: boolean;
-  /**
-   * View minification
-   */
-  views: boolean;
-  /**
-   * **NOTE YET AVAILABLE**
-   *
-   * Terse Style (CSS) Minification
-   */
-  style: boolean;
-  /**
-   * Terse Script (JS/TS) Minification
-   */
-  script: boolean;
-}

package/types/config/views.d.ts

@@ -1,234 +0,0 @@
-import { LiteralUnion } from 'type-fest';
-
-export interface Icons {
-  /**
-   * Whether or not to support icon custom tags. When `true` you can
-   * reference SVG icons using a HTML tag with a `name=""` property and
-   * Syncify will replace all occurances with the embedded SVG.
-   *
-   * For example:
-   *
-   * ```html
-   * <!-- In your HTML you can reference the SVG -->
-   * <i name="name-of-icon" from="sprite-id"></i>
-   *
-   * <!-- Syncify will replace this with the raw data -->
-   * <svg id="name-of-icon"><path>...</path></svg>
-   * ```
-   *
-   * This approach will likely improve render times of your webshop.
-   * Using Snippets to render inline SVGs is costly and a performance
-   * bottleneck. Just because Shopify does this in Dawn, does not mean
-   * it is a good idea.
-   *
-   * @default false
-   */
-  useCustomTag: boolean;
-  /**
-   * Replacer HTML tag to look for occurances within
-   *
-   * @default 'i' // eg: <i name="svg"></i>
-   */
-  tagName?: string;
-  /**
-   * Whether or not to treat the custom tag as a void (self-closing)
-   *
-   * @default false
-   */
-  tagVoid?: boolean
-  /**
-   * A vscode user specific option which will auto-generate
-   * icon name completions for you and link them to your workspace settings.
-   *
-   * > Option is only available to vscode users.
-   *
-   * @default false
-   */
-  vscodeCustomData?: boolean;
-}
-
-/**
- * Snippet sub-directory grouping options
- */
-export interface Snippets {
-  /**
-   * Whether snippets allow sub-directory name prefixing
-   *
-   * @default false
-   *
-   * @example
-   *
-   * // Assuming the separator is '_'
-   * // Take the following structure:
-   *
-   * snippets
-   * │
-   * ├─ head
-   * │  └─ foo.liquid
-   * └─ body
-   *    ├─ bar.liquid
-   *    └─ baz.liquid
-   *
-   * // The output result will be:
-   *
-   * theme
-   * └─ snippets
-   *   ├─ head_foo.liquid
-   *   ├─ body_bar.liquid
-   *   └─  body_baz.liquid
-   */
-  prefixDir?: boolean;
-  /**
-   * Prefix separator character
-   *
-   * @default '-'
-   *
-   * @example
-   *
-   * // Filename will be prefix
-   * 'dir/file.liquid' => 'dir-file.liquid'
-   */
-  separator?: LiteralUnion<
-    | '-'
-    | '_'
-    | '.'
-    | '@'
-    | ':'
-    ,
-    string
-  >;
-  /**
-   * A list snippet sub-directories or relative files that should
-   * pass through or snip prefixing
-   *
-   * _cannot contain glob (`*`) stars_
-   *
-   * @default []
-   *
-   * @example
-   *
-   * // ✓ This is correct
-   * { global: ['some-dir/filename.liquid' ] }
-   *
-   * // ✗ This is incorrect
-   * { global: ['some-dir/*.liquid' ] }
-   */
-  global?: string[];
-}
-
-/**
- * Sections sub-directory grouping options
- */
-export interface Sections {
-  /**
-   * Whether sections allow directory name prefixing
-   *
-   * @default false
-   *
-   * @example
-   *
-  * // Assuming the separator is '_'
-  * // Take the following structure:
-  *
-   * sections
-   * │
-   * ├─ index
-   * │  ├─ slideshow.liquid
-   * │  └─ banner.liquid
-   * └─ layouts
-   *    ├─ header.liquid
-   *    └─ footer.liquid
-   *
-   * // The output result will be:
-   *
-   * theme
-   * └─ sections
-   *   ├─ index_slideshow.liquid
-   *   ├─ index_banner.liquid
-   *   ├─ layout_header.liquid
-   *   └─ layout_footer.liquid
-   *
-   */
-  prefixDir?: boolean;
-  /**
-   * Prefix separator character
-   *
-   * @default '-'
-   *
-   * @example
-   *
-   * // Filename will be prefix
-   * 'dir/file.liquid' => 'dir-file.liquid'
-   */
-  separator?: LiteralUnion<
-    | '-'
-    | '_'
-    | '.'
-    | '@'
-    | ':'
-    ,
-    string
-  >;
-  /**
-   * A list section sub-directories or relative files that should
-   * pass through or snip prefixing
-   *
-   * **NOTE:**
-   *
-   * **Cannot contain glob (`*`) stars**
-   *
-   * @default []
-   *
-   * @example
-   *
-   * // ✓ This is correct
-   * { global: ['some-dir/filename.liquid' ] }
-   *
-   * // ✗ This is incorrect
-   * { global: ['some-dir/*.liquid' ] }
-   */
-  global?: string[];
-}
-
-/**
- * Static Page publishing
- */
-export interface Pages {
-  /**
-   * Whether the pulled page content should be written
-   * as HTML or have the HTML converted to Markdown.
-   *
-   * @default 'html'
-   */
-  language?: 'markdown' | 'html',
-  /**
-   * Fallback author name
-   *
-   * @default null
-   */
-  author?: string;
-  /**
-   * Whether pages contained in sub-directories should
-   * use the directory name as the `template_suffix`
-   *
-   * @default false
-   */
-  suffixDir?: boolean;
-  /**
-   * A list of page sub-directories or relative files that should
-   * pass through and not apply the directory name as a `template_suffix`
-   *
-   * _cannot contain glob (`*`) stars_
-   *
-   * @default []
-   *
-   * @example
-   *
-   * // ✓ This is correct
-   * { global: ['some-dir/filename.liquid' ] }
-   *
-   * // ✗ This is incorrect
-   * { global: ['some-dir/*.liquid' ] }
-   */
-  global?: string[];
-}

package/types/index.d.ts

@@ -1,55 +0,0 @@
-import { Config } from './config';
-import { Syncify as syncify } from './api';
-
-export type { Tsconfig } from 'tsconfig-type';
-export type { FileKeys } from './internal/file';
-
-export * from './api';
-export * from './cli';
-export * from './config';
-export * from './config/views';
-export * from './config/terser';
-export * from './internal/cache';
-export * from './internal/filters';
-export * from './internal/markdown';
-export * from './internal/requests';
-export * from './internal/shared';
-export * from './internal/errors';
-export * from './internal/reports';
-export * from './internal/file';
-export * from './internal';
-export * from './internal/plugin';
-export * from './internal/hot';
-export * from './transforms/image';
-export * from './transforms/json';
-export * from './transforms/script';
-export * from './transforms/style';
-export * from './transforms/svg';
-
-/**
- * ***Define Config:***
- *
- * Provide to the default export in your `syncify.config.js` file.
- *
- * ---
- *
- * ***Supported Files:***
- *
- * - syncify.config.ts
- * - syncify.config.js
- * - syncify.config.mjs
- * - syncify.config.cjs
- *
- * ---
- *
- * @example
- *
- * import { defineConfig } from '@syncify/cli';
- *
- * export default defineConfig({
- *   //...
- * });
- *
- */
-export declare function defineConfig(config: Config): void
-export default syncify;

package/types/internal/cache.d.ts

@@ -1,97 +0,0 @@
-export interface Cache {
-  /**
-   * The last time cache was updated at (timestamp)
-   */
-  updated: number;
-  /**
-   * When the cache was created (timestamp)
-   */
-  created: number;
-  /**
-   * Page related cache records, this reference typically
-   * holds `path > id` object references. Page ids are
-   * cached for lookup when changes occur. The `map` object
-   * holds the references and applied to model on initialization.
-   */
-  pages: {
-    /**
-     * The URI cache map location
-     *
-     * @default 'node_modules/.syncify/pages'
-     */
-    uri: string;
-    /**
-     * Page output name and Buffer
-     */
-    data: { [outputName: string]: Buffer }
-  },
-   /**
-    * Section related cache records, this reference typically
-    * holds output filename reference and used to prevent
-    * duplicated sections from being written.
-    */
-  sections: string[];
-  /**
-   * JavaScript related cache records, typically source maps
-   */
-  script: {
-    /**
-     * The URI cache map location
-     *
-     * @default 'node_modules/.syncify/script'
-     */
-    uri: string;
-    /**
-     * Metafield pathname > id cache references.
-     */
-    data: { [outputName: string]: Buffer }
-  },
-  /**
-   * Stylesheet related cache records, typically source maps
-   */
-  style: {
-    /**
-     * The URI cache map location
-     *
-     * @default 'node_modules/.syncify/styles'
-     */
-    uri: string;
-    /**
-     * Stylesheet output name and Buffer
-     */
-    data: { [outputName: string]: Buffer }
-  },
-  /**
-   * Metafields related cache records. Metafield source maps
-   * are `path > id` object references. Metafield ids are
-   * cached for lookup when changes occur. The `map` object
-   * holds the references and applied to model on initialization.
-   */
-  metafields: {
-   /**
-     * The URI cache reference location
-     *
-     * @default 'node_modules/.syncify/metafields'
-     */
-    uri: string,
-    /**
-     * Metafield pathname > id cache references.
-     */
-    data: { [path: string]: number }
-  },
-  /**
-   * Specification JSON for vscode
-   */
-  vscode: {
-    /**
-     * The URI vscode reference location
-     *
-     * @default 'node_modules/.syncify/vscode'
-     */
-     uri: string;
-     /**
-      * vscode file maps
-      */
-     data: { icons?: string; }
-   }
-}