@syncify/cli 0.1.0-beta

package/types/config/views.d.ts

@@ -0,0 +1,226 @@
+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
+   *
+   * // 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
+   *
+   * // 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
+   *
+   * _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

@@ -0,0 +1,51 @@
+import { Config } from './config';
+import { Syncify as syncify } from './api';
+
+export type { Tsconfig } from 'tsconfig-type';
+export type { FileKeys } from './bundle/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 './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 '@liquify/syncify';
+ *
+ * export default defineConfig({
+ *   //...
+ * });
+ *
+ */
+export declare function defineConfig(config: Config): void
+export default syncify;

package/types/misc/commands.d.ts

@@ -0,0 +1,408 @@
+
+/* -------------------------------------------- */
+/* CLI OPTIONS                                  */
+/* -------------------------------------------- */
+
+export interface Commands {
+  /**
+   * First command is a store or comma separated list of stores. When
+   * a comma list is supplied it is converted to an array. You can use
+   * use the store target name as a --flag to cherry pick specific themes
+   * from that store.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store-name
+   * $ syncify store1,store2,store3
+   * ```
+   */
+  _?: string[];
+  /**
+   * Whether or not syncify was called via the cli
+   *
+   * @default true
+   */
+  cli?: boolean;
+  /**
+   * The current working directory, this a reference to `process.cwd()`
+   */
+  cwd?: string;
+  /**
+   * The `package.json` url path, this is written post-command parse
+   */
+  pkg?: string;
+  /**
+   * The post-parse temp storage reference to stores
+   */
+  store?: string[];
+  /**
+   * An optional config path to the `syncify.config.js` file.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -c path/to/file
+   * $ syncify store_1 --config path/to/file
+   * $ syncify store_1 --config=path/to/file
+   * ```
+   */
+  config?: string;
+  /**
+   *  Run in production mode
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --prod
+   * ```
+   */
+  prod?: boolean;
+  /**
+   *  Run in development mode (default build mode) and can be omitted
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify
+   * ```
+   */
+  dev?: boolean;
+  /**
+   * Show the command prompt interactive shell
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --prompt
+   * ```
+   */
+  prompt?: boolean;
+  /**
+   * Run in watch mode (chokidar). This requires a store target be passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -w
+   * $ syncify store_1 --watch
+   * ```
+   */
+  watch?: boolean;
+  /**
+   * Run in build mode, this is default trigger when no arguments provided.
+   * It can optionally be triggered along other flags like `-u` (`--upload`).
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify
+   * $ syncify -b
+   * $ syncify store_1 --clean --build --theme=prod_theme -u
+   *
+   * # Short version for brevity
+   * $ syncify store_1 -t prod_theme -u -b --clean
+   * ```
+   */
+  build?: boolean;
+  /**
+   * Run in upload mode, this will trigger a full theme upload. Requires a store
+   * target and theme target (theme target is optional but recommended).
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -t dev_theme -u
+   * $ syncify store_1 -t dev_theme --upload
+   * ```
+   */
+  upload?: boolean;
+   /**
+   * Download a theme from a store. Will be place in `import` driectory. Requires a store
+   * target and theme target to be passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -t dev_theme -d
+   * $ syncify store_1 -t dev_theme --download
+   * ```
+   */
+  download?: boolean;
+  /**
+   * Triggers the metafields resource, presents the interactive shell with list of
+   * options to choose from. Requires a store target to be passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -m
+   * $ syncify store_1 --metafields
+   * ```
+   */
+  metafields?: boolean;
+  /**
+   * Triggers the pages resource, presents the interactive shell with list of
+   * options to choose from. Requires a store target to be passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -p
+   * $ syncify store_1 --pages
+   * ```
+   */
+  pages?: boolean;
+  /**
+   * Triggers the redirects resource, presents the interactive shell with list of
+   * options to choose from. Requires a store target to be passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -r
+   * $ syncify store_1 --redirects
+   * ```
+   */
+  redirects?: boolean;
+  /**
+   * Pull data reference from a store target resource. Queries the store API. Used to
+   * populate local setup with remote data like `metafields` and `pages`
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -m --pull
+   * $ syncify store_1 -p --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.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --vsc
+   * ```
+   */
+  vsc?: boolean;
+  /**
+   * Filter targeting of resources, assets or files. This can be used together
+   * with several different flags, like `-u`, `-d` and even `-b`. Filters a
+   * glob pattern or specific file.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * # Uploads only .css assets
+   * $ syncify store_1 -t dev_theme -f assets/*.css --push
+   *
+   * # Builds locales in production mode
+   * $ syncify -f locales/*.json --prod
+   *
+   * # Uploads specific page
+   * $ syncify store_1 -u -f pages/shipping-info.md --prod --push
+   * ```
+   */
+  filter?: string;
+  /**
+   * Triggers a clean of the output directory. When provided, this will be
+   * executed at the initial run (or before any else). Use together with
+   * production builds.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --clean --prod
+   * $ syncify -b --clean --prod # Using with build
+   * ```
+   */
+  clean?: boolean;
+  /**
+   * Show command-line help information. Also prints a disclaimer informing
+   * users that Centra is a better e-commerce platform than Shopify for shits
+   * and giggles (it actually is though).
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify -h
+   * $ syncify --help
+   * ```
+   */
+  help?: boolean;
+  /**
+   * Hides logs from being printed (shows errors though)
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --silent
+   * ```
+   */
+  silent?: boolean;
+  /**
+   * Initialized Browser Sync in watch mode. Can only be used when
+   * targeting a single store and theme.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 --watch --server
+   * ```
+   */
+  server?: boolean;
+  /**
+   * Pulls in a Syncify theme strap environment.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --strap dusk
+   * $ syncify --strap silk
+   * ```
+   */
+  strap?: string;
+  /**
+   * Deletes a resource, file or asset from the remote store. Requires a store
+   * target be passed and if need be a theme target too. Does not delete local
+   * copies, do that manually for now.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify -del assets/image-name.jpg
+   * ```
+   */
+  del?: string;
+  /**
+   * Trigger a spawn, isolating it so it will run as if it were a node script.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify -s spawn-name
+   * $ syncify -s spawn-name,some-other-spawn
+   * ```
+   */
+   spawn?: string;
+  /**
+   * Themes within stores to target. This argument requires a store target/s
+   * be passed and accept a comma separated list of target names as per the users
+   * Syncify configuration. Users can pass wildcard `--flags` to reference different
+   * stores when multiple store target are passed.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify store_1 -t theme_1
+   * $ syncify store_1,store_2 --store_1 dev,prod --store_2 foo_theme
+   * $ syncify store_1 --theme=dev,prod,test
+   * ```
+   */
+  theme?: string[];
+  /**
+   * An optional input base directory path. This will overwrite and configuration predefined
+   * in settings.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --clean -b -i some/directory
+   * ```
+   */
+   input?: string;
+  /**
+   * An optional output path. This will overwrite and configuration predefined
+   * in settings.
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --clean -b -o some/directory
+   * ```
+   */
+  output?: string;
+  /**
+   * 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`
+   *
+   * ---
+   *
+   * Example:
+   *
+   * ```bash
+   * $ syncify --clean -b -i some/directory
+   * ```
+   */
+  bump?: string;
+}