@syncify/cli 0.2.4-beta → 0.3.0-beta

package/types/config/terser.d.ts

@@ -39,37 +39,43 @@ export interface JSONTerse {
    *
    * @default true
    */
-  assets: boolean;
+  assets?: boolean;
   /**
    * Minify `settings_schema.json` and `settings_data.json` config files.
    *
    * @default true
    */
-  config: boolean;
+  config?: boolean;
   /**
    * Minify `locale` and `.json` files.
    *
    * @default true
    */
-  locales: boolean;
+  locales?: boolean;
   /**
    * Minify `metafield` and `.json` files.
    *
    * @default true
    */
-  metafields: boolean;
+  metafields?: boolean;
+  /**
+   * Minify `metaobject` and `.json` files.
+   *
+   * @default true
+   */
+  metaobject?: boolean;
   /**
    * Minify section group `.json` files
    *
    * @default true
    */
-  sectionGroups: boolean;
+  groups?: boolean;
   /**
    * Minify `template` and `.json` files.
    *
    * @default true
    */
-  templates: boolean;
+  templates?: boolean;
   /**
    * An optional list of paths/files to exclude from minification.
    *
@@ -81,17 +87,23 @@ export interface JSONTerse {
 /**
  * Liquid Minification
  */
-export interface ViewTerse {
+export interface LiquidTerse {
   /**
-   * Minifies inner contents of `<script>` tags
+   * Minifies inner contents of `{% javascript %}` tags
    *
-   * @default true
+   * @default false
    */
-  minifyScript?: boolean;
+  minifyJavascript?: boolean;
   /**
-   * Minifies inner contents of `<style>` tags
+   * Minifies inner contents of `{% stylesheet %}`` tags
    *
-   * @default true
+   * @default false
+   */
+  minifyStylesheet?: boolean;
+  /**
+   * Minifies inner contents of `{% style %}` tags
+   *
+   * @default false
    */
   minifyStyle?: boolean;
   /**
@@ -101,11 +113,11 @@ export interface ViewTerse {
    * >
    * > Minifying schema tag contents has no effect on store performance.
    *
-   * @default true
+   * @default false
    */
   minifySchema?: boolean;
   /**
-   * Remove all occurances of Liquid/HTML comments
+   * Remove all occurances of Liquid comments
    *
    * @default true
    */
@@ -158,6 +170,42 @@ export interface ViewTerse {
   exclude?: string[]
 }
 
+/**
+ * Liquid Minification
+ */
+export interface MarkupTerse {
+  /**
+   * Minifies inner contents of `<script>` tags
+   *
+   * @default true
+   */
+  minifyJS?: boolean;
+  /**
+   * Minifies inner contents of `<style>` tags
+   *
+   * @default true
+   */
+  minifyCSS?: boolean;
+  /**
+   * Remove all occurances of HTML comments
+   *
+   * @default true
+   */
+  removeComments?: boolean;
+  /**
+   * Collapse all whitespace and newlines
+   *
+   * @default true
+   */
+  collapseWhitespace?: boolean;
+  /**
+   * Excluded files from minification
+   *
+   * @default []
+   */
+  exclude?: string[]
+}
+
 /**
  * Style Minification
  */
@@ -173,12 +221,12 @@ export interface StyleTerse extends CleanCSSOptions {
    *
    * @default false
    */
-  ofuscateClassNames?: boolean;
+  obfuscateClassNames?: boolean;
   /**
    * List of class names that should be excluded from
    * obfuscation and shortnaming.
    */
-  ofuscateWhitelist?: string[];
+  obfuscateWhitelist?: string[];
   /**
    * The alphabet used to generate the new class names.
    *
@@ -188,7 +236,7 @@ export interface StyleTerse extends CleanCSSOptions {
    *
    * @default 'abcefghijklmnopqrstuvwxyz0123456789'
    */
-  ofuscateAlphabet?: string;
+  obfuscateAlphabet?: string;
   /**
    * Excluded files from terser minification
    *
@@ -214,13 +262,13 @@ export interface TerserConfig {
   /**
    * Terse View (Liquid) Minification
    */
-  liquid?: Omit<ViewTerse, 'collapseWhitespace'>;
+  liquid?: LiquidTerse;
   /**
-   * Terse View (HTML) Minification
+   * Terse Markup (HTML) Minification
    *
    * > Uses [html-minifier-terser](https://github.com/terser/html-minifier-terser)
    */
-  html?: HTMLMinifierTerserOptions;
+  markup?: HTMLMinifierTerserOptions;
   /**
    * **NOTE YET AVAILABLE**
    *
@@ -251,9 +299,13 @@ export interface TerserBundle {
    */
   json: boolean;
   /**
-   * View minification
+   * HTML (Markup) Minification
+   */
+  markup: boolean;
+  /**
+   * Liquid Minification
    */
-  views: boolean;
+  liquid: boolean;
   /**
    * **NOTE YET AVAILABLE**
    *

package/types/config/views.d.ts

@@ -189,46 +189,3 @@ export interface Sections {
    */
   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

@@ -2,24 +2,24 @@ import { Config } from './config';
 import { Syncify as syncify } from './api';
 
 export type { Tsconfig } from 'tsconfig-type';
-export type { FileKeys } from './internal/file';
+export type { FileKeys } from './bundle/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 './bundle/cache';
+export * from './bundle/filters';
+export * from './bundle/requests';
+export * from './bundle/shared';
+export * from './bundle/errors';
+export * from './bundle/reports';
+export * from './bundle/file';
+export * from './bundle';
+export * from './bundle/plugin';
+export * from './bundle/hot';
+export * from './transforms/pages';
 export * from './transforms/image';
 export * from './transforms/json';
 export * from './transforms/script';
@@ -27,13 +27,13 @@ export * from './transforms/style';
 export * from './transforms/svg';
 
 /**
- * ***Define Config:***
+ * **Define Config:**
  *
  * Provide to the default export in your `syncify.config.js` file.
  *
  * ---
  *
- * ***Supported Files:***
+ * **Supported Files:**
  *
  * - syncify.config.ts
  * - syncify.config.js
@@ -51,5 +51,5 @@ export * from './transforms/svg';
  * });
  *
  */
-export declare function defineConfig(config: Config): void
+export declare function defineConfig<T>(config: Config<T>): void;
 export default syncify;

package/types/modules/html-minifier-terser.d.ts

@@ -108,6 +108,7 @@ export interface HTMLMinifierTerserOptions {
   minifyURLs?: boolean | string | object | ((text: string) => string) | undefined;
   /**
    * Never add a newline before a tag that closes an element
+   *
    * @default false
    */
   noNewlinesBeforeTagClose?: boolean | undefined;
@@ -154,26 +155,31 @@ export interface HTMLMinifierTerserOptions {
   removeEmptyAttributes?: boolean | ((attrName: string, tag: string) => boolean) | undefined;
   /**
    * Remove all elements with empty contents
+   *
    * @default false
    */
   removeEmptyElements?: boolean | undefined;
   /**
    * Remove optional tags
+   *
    * @default false
    */
   removeOptionalTags?: boolean | undefined;
   /**
    * Remove attributes when value matches default
+   *
    * @default false
    */
   removeRedundantAttributes?: boolean | undefined;
   /**
    * Remove `type="text/javascript"` from `script` tags. Other `type` attribute values are left intact
+   *
    * @default false
    */
   removeScriptTypeAttributes?: boolean | undefined;
   /**
    * Remove `type="text/css"` from `style` and `link` tags. Other `type` attribute values are left intact
+   *
    * @default false
    */
   removeStyleLinkTypeAttributes?: boolean | undefined;
@@ -206,6 +212,7 @@ export interface HTMLMinifierTerserOptions {
 
 /**
  * HTMLMinifier is a highly configurable, well-tested, JavaScript-based HTML minifier.
+ *
  * @async
  */
 export function minify(value: string, options?: HTMLMinifierTerserOptions): Promise<string>;

package/types/stores.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Dev Theme ID for syncify.myshopify.com
+ */
+declare type DevThemeID = 12345679
+
+/**
+ * Prod Theme ID for syncify.myshopify.com
+ */
+declare type ProdThemeID = 12345679888
+
+export type IDS = DevThemeID | ProdThemeID

package/types/transforms/image.d.ts

@@ -1,5 +1,5 @@
 import type { SharpOptions as SharpConfig } from 'sharp';
-import type { GetProcessorConfigs } from '../internal/shared';
+import type { GetProcessorConfigs } from '../bundle/shared';
 
 export type { SharpConfig };
 

package/types/transforms/json.d.ts

@@ -39,4 +39,13 @@ export interface JSONConfig {
  *
  * Bundling Configuration
  */
-export type JSONBundle = Merge<JSONConfig, { exclude: Tester }>;
+export type JSONBundle = Merge<JSONConfig, {
+  /**
+   * Paths to exclude from JSON processing
+   */
+  exclude: Tester;
+  /**
+   * The resolved cache path.
+   */
+  cache: string;
+}>;

package/types/{internal/markdown.d.ts → transforms/pages.d.ts}

@@ -1,3 +1,7 @@
+import { Tester } from 'anymatch';
+import { Merge } from 'type-fest';
+import { PageMetafield } from '../bundle/requests';
+
 /**
  * **Markdown > HTML**
  *
@@ -102,3 +106,149 @@ export namespace Markdown {
     linkReferenceStyle?: 'full' | 'collapsed' | 'shortcut' | undefined;
   }
 }
+
+/**
+ * Static Page publishing
+ */
+export interface PagesConfig {
+  /**
+   * Whether the pulled page content should be written
+   * as HTML or have the HTML converted to Markdown.
+   *
+   * @default 'html'
+   */
+  importLanguage?: 'markdown' | 'html',
+  /**
+   * Whether or not to use safe sync. When enabled, Syncify
+   * will check remote sources before publishing. If local
+   * sources have had edits applied, you will be prompted
+   * before an overwrite takes place.
+   *
+   * @default true
+   */
+  safeSync?: boolean;
+  /**
+   * Fallback author name
+   *
+   * @default ''
+   */
+  author?: string;
+  /**
+   * Whether pages contained in sub-directories should
+   * use their directory name as the `template_suffix`
+   * when publishing to stores
+   *
+   * @default false
+   */
+  suffixDir?: boolean;
+  /**
+   * If `suffixDir` is `true` you can provide alist of page sub-directories
+   * or relative files that should pass through without applying the directory
+   * name as a `template_suffix` on the page.
+   *
+   * _cannot contain glob (`*`) stars_
+   *
+   * @default []
+   *
+   * @example
+   *
+   * // ✓ This is correct
+   * { global: ['some-dir/filename.md' ] }
+   *
+   * // ✗ This is incorrect
+   * { global: ['some-dir/*.md' ] }
+   */
+  global?: string[];
+}
+
+/* -------------------------------------------- */
+/* INTERNAL USE                                 */
+/* -------------------------------------------- */
+
+/**
+ * **Internal Use**
+ *
+ * Describes the frontmatter of a page file
+ */
+export interface PageFrontmatter {
+  /**
+   * Page title
+   */
+  title?: string;
+  /**
+   * Page id reference
+   */
+  id?: number;
+  /**
+   * Page handle
+   */
+  handle?: string;
+  /**
+   * The template suffix
+   */
+  template?: string;
+    /**
+   * The template suffix (fallback if user passed explicit ref)
+   */
+  template_suffix?: string;
+  /**
+   * The author of the page
+   */
+  author?: string;
+  /**
+   * `markdown-it` option
+   *
+   * Whether or not HTML tags in source are enabled
+   */
+  html?: boolean;
+  /**
+   * Whether or not the page should be published
+   */
+  published?: boolean;
+  /**
+   * Write the following metafields to the page
+   */
+  metafields?: PageMetafield[]
+  /**
+   * Catches invalid reference
+   */
+  metafield?: PageMetafield[]
+  /**
+   * `markdown-it` option
+   *
+   * Applies `linkify` overwrite (Autoconvert URL-like text to links)
+   */
+  links?: boolean;
+  /**
+   * `markdown-it` option
+   *
+   * Applies `breaks` overwrite (Convert '\n' in paragraphs into `<br>`)
+   */
+  breaks?: boolean;
+}
+
+/**
+ * **Internal Use**
+ */
+export type PageBundle = Merge<PagesConfig, {
+  /**
+   * Import configuration for Turndown
+   */
+  import: Markdown.Import;
+  /**
+   * Export configuration for Markdown-it
+   */
+  export: Markdown.Export;
+  /**
+   * Whether or not `safe` is enabled
+   */
+  safeSync: boolean;
+  /**
+   * Global passthrough;
+   */
+  global: RegExp;
+  /**
+   * Anymatch pattern
+   */
+  paths?: Tester;
+}>

package/types/transforms/script.d.ts

@@ -3,7 +3,7 @@ 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 '../internal/shared';
+import type { GetProcessorConfigs, RenamePaths } from '../bundle/shared';
 
 type TargetBrowser = (
   | 'chrome'
@@ -259,7 +259,7 @@ export type ESBuildProcesser = Merge<GetProcessorConfigs<ESBuildOptions>, {
  */
 export interface ScriptBundle {
   /**
-   * A UUID reference for this bundle.
+   * A UUID reference for this $.
    */
   uuid: string;
   /**
@@ -302,7 +302,7 @@ export interface ScriptBundle {
   watchCustom: Tester;
   /**
    * ESBuild options which will either use the processor defaults or
-   * if defined on script bundle, will be merged with processor defaults.
+   * if defined on script $, will be merged with processor defaults.
    */
   esbuild: ESBuildOptions
 }

package/types/transforms/style.d.ts

@@ -4,7 +4,7 @@ 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 '../internal/shared';
+import type { GetProcessorConfigs, RenamePaths } from '../bundle/shared';
 
 /* -------------------------------------------- */
 /* PROCESSOR CONFIGS                            */
@@ -205,7 +205,7 @@ export type SASSProcesser = GetProcessorConfigs<SASSConfig>
  */
 export type StyleBundle = Merge<StyleTransform, {
   /**
-   * A UUID reference for this bundle.
+   * A UUID reference for this $.
    */
   uuid: string;
   /**

package/types/transforms/svg.d.ts

@@ -4,7 +4,7 @@ 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 '../internal/shared';
+import type { GetProcessorConfigs, RenamePaths } from '../bundle/shared';
 
 /* -------------------------------------------- */
 /* PROCESSOR CONFIGS                            */
@@ -166,7 +166,7 @@ export type SVGSpriteProcesser = GetProcessorConfigs<SVGSpriteConfig>
  */
 export type SVGBundle = Merge<SVGTransform, {
   /**
-   * A UUID reference for this bundle.
+   * A UUID reference for this $.
    */
   uuid: string;
   /**

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; }
-   }
-}