@syncify/cli 0.1.3-beta → 0.2.1-beta

package/types/api.d.ts

@@ -1,7 +1,7 @@
 import { PartialDeep } from 'type-fest';
 import { Config } from './config';
-import { Asset } from './misc/requests';
-import { File } from './bundle/file';
+import { Asset } from './internal/requests';
+import { File } from './internal/file';
 
 type Download = (
   this: {

package/types/cli.d.ts

@@ -47,6 +47,12 @@ export interface Commands {
    * @default true
    */
   cli?: boolean;
+ /**
+   * Whether or not syncify interactive command prompt
+   *
+   * @default false
+   */
+  interactive?: boolean;
   /**
    * The current working directory, this a reference to `process.cwd()`
    */
@@ -109,22 +115,10 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify --minify
-   * ```
-   */
-  minify?: boolean
-  /**
-   * Show the command prompt interactive shell
-   *
-   * ---
-   *
-   * Example:
-   *
-   * ```bash
-   * $ syncify --prompt
+   * $ syncify --terse
    * ```
    */
-  prompt?: boolean;
+  terse?: boolean
   /**
    * Run in watch mode (chokidar). This requires a store target be passed.
    *
@@ -178,7 +172,21 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify --export
+   * $ syncify --import # import to the defined directory in syncify config
+   * $ syncify --import -o ./some-dir # override and import to a specific directory
+   * ```
+   */
+  import?: boolean;
+  /**
+   * Exports the theme and generates a `.zip` compressed directory.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --import # export to the defined directory in syncify config
+   * $ syncify --import -o ./some-dir # override and export to a specific directory
    * ```
    */
   export?: boolean;
@@ -205,7 +213,6 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify store_1 -m
    * $ syncify store_1 --metafields
    * ```
    */
@@ -219,7 +226,6 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify store_1 -p
    * $ syncify store_1 --pages
    * ```
    */
@@ -233,7 +239,6 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify store_1 -r
    * $ syncify store_1 --redirects
    * ```
    */
@@ -247,26 +252,11 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify store_1 -m --pull
-   * $ syncify store_1 -p --pull
+   * $ syncify store_1 --metafields --pull
+   * $ syncify store_1 --pages --pull
    * ```
    */
   pull?: boolean;
-  /**
-   * Pushes a resource from local to remote shop. This is different from `-u` or `--upload`
-   * flags as it can be used to push targets assets, files or resources and can be used
-   * together with the `-f` filter flag.
-   *
-   * ---
-   *
-   * Example:
-   *
-   * ```bash
-   * $ syncify store_1 -t dev_theme -f assets/file --push
-   * $ syncify store_1 -f metafields/namespace/*.json --push
-   * ```
-   */
-  push?: boolean;
   /**
    * Generator flag for automatically applying JSON schema specifications
    * for VS Code users.
@@ -291,13 +281,13 @@ export interface Commands {
    *
    * ```bash
    * # Uploads only .css assets
-   * $ syncify store_1 -t dev_theme -f assets/*.css --push
+   * $ syncify store_1 -t dev_theme -f assets/*.css -u
    *
    * # Builds locales in production mode
    * $ syncify -f locales/*.json --prod
    *
    * # Uploads specific page
-   * $ syncify store_1 -u -f pages/shipping-info.md --prod --push
+   * $ syncify store_1 -u -f pages/shipping-info.md --prod
    * ```
    */
   filter?: string;
@@ -367,7 +357,7 @@ export interface Commands {
    * Example:
    *
    * ```bash
-   * $ syncify --strap dusk
+   * $ syncify --strap dawn
    * $ syncify --strap silk
    * ```
    */
@@ -401,6 +391,7 @@ export interface Commands {
 
    * $ syncify --spawn spawn-name
    * $ syncify --spawn spawn-name,some-other-spawn
+   *
    * ```
    */
    spawn?: string;
@@ -433,7 +424,7 @@ export interface Commands {
    * $ syncify --clean -b -i some/directory
    * ```
    */
-   input?: string;
+  input?: string;
   /**
    * An optional output path. This will overwrite the configuration predefined
    * in settings.
@@ -447,11 +438,24 @@ export interface Commands {
    * ```
    */
   output?: string;
+  /**
+   * Force overwrite of a theme file
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -t dev_theme -f section/file.liquid -u --force
+   * ```
+   */
+  force?: boolean;
   /**
    * Version control. The bump flag accepts 3 different arguments.
-   * Passing `--bump major` bumps main version, eg: `1.0.0` > `2.0,0`
-   * Passing `--bump minor` bumps minor version, eg: `1.0.0` > `1.1.0`
-   * Passing `--bump patch` bumps patch version, eg: `1.0.0` > `1.0.1`
+   *
+   * 1. Passing `--bump major` bumps main version, eg: `1.0.0` > `2.0,0`
+   * 2. Passing `--bump minor` bumps minor version, eg: `1.0.0` > `1.1.0`
+   * 3. Passing `--bump patch` bumps patch version, eg: `1.0.0` > `1.0.1`
    *
    * ---
    *

package/types/config/index.d.ts

@@ -1,9 +1,9 @@
 /* eslint-disable no-unused-vars */
 
 import type { Pages, Sections, Snippets } from './views';
-import type { HOTConfig } from '../bundle/hot';
-import type { ESBuildMinify, JSONMinify, ViewMinify } from './minify';
-import type { PluginHooks } from '../bundle/plugin';
+import type { HOTConfig } from '../internal/hot';
+import type { ScriptTerse, JSONTerse, ViewTerse } from './terser';
+import type { PluginHooks } from '../internal/plugin';
 import type { JSONConfig } from '../transforms/json';
 import type { SharpConfig } from '../transforms/image';
 import type { ScriptTransformer, ESBuildConfig } from '../transforms/script';
@@ -218,7 +218,7 @@ export interface Transforms {
    *   ]
    * }
    */
-  script?: ScriptTransformer
+  script?: false | ScriptTransformer
   /**
    * SVG File transforms
    */
@@ -229,13 +229,13 @@ export interface Transforms {
 /* MINIFY                                       */
 /* -------------------------------------------- */
 
-export interface MinifyConfig {
+export interface Terser {
   /**
    * JSON minification options. You can disable all JSON files from
    * being minified by passing a boolean `false`. Optionally, you can
    * exclude certain types of JSON from being minified.
    */
-  json?: boolean | JSONMinify;
+  json?: boolean | JSONTerse;
   /**
    * View minification options. You can disable all views from
    * being minified by passing a boolean `false`.
@@ -245,13 +245,13 @@ export interface MinifyConfig {
    * of options are exposed in order to prevent invalid or broken
    * output from being generated.
    */
-  views?: boolean | ViewMinify;
+  views?: boolean | ViewTerse;
   /**
    * JavaScript minification options. Script minification is only
    * available for projects with `esbuild` installed and configured
    * as a processor.
    */
-  script?: boolean | ESBuildMinify;
+  script?: boolean | ScriptTerse;
 }
 
 /* -------------------------------------------- */
@@ -516,9 +516,15 @@ export interface Config extends Directories {
    */
   transforms?: Transforms;
   /**
-   * Minify options - Invoked when in **production** `--prod` mode or
-   * if the `--minify` flag was passed. Options will default to `false`
-   * when either of these conditionals are not met.
+   * Terse options (minification)
+   *
+   * Invoked when in **production** (`--prod`) mode or when the `--terse` flag is passed.
+   * Options will default to `false`when either of these conditionals are not met.
+   */
+  terser?: boolean | Terser;
+  /**
+   * @deprecated
+   *  Use `terser` option instead
    */
-  minify?: boolean | MinifyConfig
+  minify?: undefined;
 }

package/types/config/terser.d.ts

@@ -0,0 +1,267 @@
+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

@@ -58,7 +58,9 @@ export interface Snippets {
    *
    * @example
    *
-   * // Take the following structure
+   * // Assuming the separator is '_'
+   * // Take the following structure:
+   *
    * snippets
    * │
    * ├─ head
@@ -67,7 +69,8 @@ export interface Snippets {
    *    ├─ bar.liquid
    *    └─ baz.liquid
    *
-   * // The output result will be
+   * // The output result will be:
+   *
    * theme
    * └─ snippets
    *   ├─ head_foo.liquid
@@ -124,7 +127,9 @@ export interface Sections {
    *
    * @example
    *
-   * // Take the following structure
+  * // Assuming the separator is '_'
+  * // Take the following structure:
+  *
    * sections
    * │
    * ├─ index
@@ -134,7 +139,8 @@ export interface Sections {
    *    ├─ header.liquid
    *    └─ footer.liquid
    *
-   * // The output result will be
+   * // The output result will be:
+   *
    * theme
    * └─ sections
    *   ├─ index_slideshow.liquid
@@ -167,7 +173,9 @@ export interface Sections {
    * A list section sub-directories or relative files that should
    * pass through or snip prefixing
    *
-   * _cannot contain glob (`*`) stars_
+   * **NOTE:**
+   *
+   * **Cannot contain glob (`*`) stars**
    *
    * @default []
    *

package/types/index.d.ts

@@ -2,20 +2,24 @@ import { Config } from './config';
 import { Syncify as syncify } from './api';
 
 export type { Tsconfig } from 'tsconfig-type';
-export type { FileKeys } from './bundle/file';
+export type { FileKeys } from './internal/file';
 
 export * from './api';
 export * from './cli';
-export * from './bundle';
-export * from './bundle/plugin';
-export * from './bundle/hot';
 export * from './config';
 export * from './config/views';
-export * from './misc/markdown';
-export * from './misc/requests';
-export * from './misc/shared';
-export * from './misc/errors';
-export * from './misc/modes';
+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';