@maizzle/framework 4.7.5 → 4.7.6

package/types/tailwind.d.ts

@@ -0,0 +1,22 @@
+export default interface TailwindConfig {
+  /**
+  Path to the Tailwind config file.
+
+  @default 'tailwind.config.js'
+  */
+  config?: string;
+
+  /**
+  Path to your main CSS file, that will be compiled with Tailwind CSS.
+
+  @default 'src/css/tailwind.css'
+  */
+  css?: string;
+
+  /**
+  Pre-compiled CSS. Skip Tailwind CSS processing by providing your own CSS string.
+
+  @default ''
+  */
+  compiled?: string;
+}

package/types/templates.d.ts

@@ -0,0 +1,167 @@
+import type Config from './config';
+import type PlaintextConfig from './plaintext';
+
+export default interface TemplatesConfig {
+  /**
+  Directory where Maizzle should look for Templates to compile.
+
+  @default 'src/templates'
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        source: 'src/templates'
+      }
+    }
+  }
+  ```
+  */
+  source?:
+  | string
+  | Array<string | TemplatesConfig>
+  | ((config: Config) => string | string[]);
+
+  /**
+  Define what file extensions your Templates use.
+  Maizzle will only compile files from your `source` directory that have these extensions.
+
+  @default 'html'
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        filetypes: ['html', 'blade.php']
+      }
+    }
+  }
+  ```
+  */
+  filetypes?: string | string[];
+
+  /**
+  Define the output path for compiled Templates, and what file extension they should use.
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        destination: {
+          path: 'build_production',
+          extension: 'html'
+        }
+      }
+    }
+  }
+  ```
+  */
+  destination?: {
+    /**
+    Directory where Maizzle should output compiled Templates.
+
+    @default 'build_{env}'
+    */
+    path?: string;
+    /**
+    File extension to be used for compiled Templates.
+
+    @default 'html'
+    */
+    extension: string;
+  };
+
+  /**
+  Source and destination directories for your asset files.
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        assets: {
+          source: 'src/images',
+          destination: 'images'
+        }
+      }
+    }
+  }
+  ```
+  */
+  assets?: {
+    /**
+    Directory where Maizzle should look for asset files.
+
+    @default ''
+    */
+    source?: string;
+    /**
+    Directory where asset files should be copied to.
+
+    @default 'assets'
+    */
+    destination?: string;
+  };
+
+  /**
+  Configure plaintext generation.
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      plaintext: {
+        skipHtmlDecoding: true,
+        destination: {
+          path: 'dist/brand/plaintext',
+          extension: 'rtxt'
+        }
+      }
+    }
+  }
+  ```
+  */
+  plaintext?: boolean | PlaintextConfig;
+
+  /**
+  Paths to files or directories from your `source` that should _not_ be copied over to the build destination.
+
+  @default ['']
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        source: 'src/templates',
+        omit: ['1.html', 'archive/4.html'],
+      }
+    }
+  }
+  ```
+  */
+  omit?: string[];
+
+  /**
+  Paths to files relative to your `source` directory that should not be parsed.
+  They will be copied over to the build destination as-is.
+
+  @default ['']
+
+  @example
+  ```
+  module.exports = {
+    build: {
+      templates: {
+        source: 'src/templates',
+        skip: ['1.html', 'archive/3.html'],
+      }
+    }
+  }
+  ```
+  */
+  skip?: string | string[];
+}

package/types/urlParameters.d.ts

@@ -0,0 +1,39 @@
+import type {StringifyOptions} from 'query-string';
+
+export default interface URLParametersConfig {
+  [key: string]: any;
+
+  _options?: {
+    /**
+    Array of tag names to process. Only URLs inside `href` attributes of tags in this array will be processed.
+
+    @default ['a']
+
+    @example
+    ```
+    module.exports = {
+      urlParameters: {
+        _options: {
+          tags: ['a[href*="example.com"]'],
+        },
+        utm_source: 'maizzle',
+      }
+    }
+    ```
+    */
+    tags?: string[];
+
+    /**
+    By default, query parameters are appended only to valid URLs.
+    Disable strict mode to append parameters to any string.
+
+    @default true
+    */
+    strict?: boolean;
+
+    /**
+    Options to pass to the `query-string` library.
+    */
+    qs?: StringifyOptions;
+  };
+}

package/types/widowWords.d.ts

@@ -0,0 +1,56 @@
+export default interface WidowWordsConfig {
+  /**
+  The attribute name to use.
+
+  @default 'prevent-widows'
+  */
+  attrName?: string;
+
+  /**
+  Replace all widow word `nbsp;` instances with a single space.
+  This is basically the opposite of preventing widow words.
+
+  @default false
+  */
+  removeWindowPreventionMeasures?: boolean;
+
+  /**
+  Convert the space entity to the `targetLanguage`.
+
+  @default true
+  */
+  convertEntities?: boolean;
+
+  /**
+  Language to encode non-breaking spaces in.
+
+  @default 'html'
+  */
+  targetLanguage?: 'html' | 'css' | 'js';
+
+  /**
+  Should whitespace in front of dashes (-), n-dashes (–) or m-dashes (—) be replaced with a ` `.
+
+  @default true
+  */
+  hyphens?: boolean;
+
+  /**
+  The minimum amount of words in a target string, in order to trigger the transformer.
+
+  @default 3
+  */
+  minWordCount?: number;
+
+  /**
+  The minimum amount non-whitespace characters in a target string, in order to trigger the transformer.
+
+  @default 20
+  */
+  minCharCount?: number;
+
+  /**
+  Start/end pairs of strings that will prevent the transformer from removing widow words inside them.
+  */
+  ignore?: string | string[];
+}