@maizzle/framework 4.8.8 → 5.0.0-beta.0

package/types/inlineCss.d.ts

@@ -1,207 +0,0 @@
-export type AttributeToStyleSupportedAttributes =
-  | 'width'
-  | 'height'
-  | 'bgcolor'
-  | 'background'
-  | 'align'
-  | 'valign';
-
-export default interface InlineCSSConfig {
-  /**
-  Which CSS properties should be duplicated as what HTML attributes.
-
-  @default {}
-
-  @example
-  ```
-  module.exports = {
-    build: {
-      inlineCSS: {
-        styleToAttribute: {
-          'background-color': 'bgcolor',
-        }
-      }
-    }
-  }
-  ```
-  */
-  styleToAttribute?: Record<string, string>;
-
-  /**
-  Duplicate HTML attributes to inline CSS.
-
-  @default false
-
-  @example
-  ```
-  module.exports = {
-    build: {
-      inlineCSS: {
-        attributeToStyle: ['width', 'bgcolor', 'background']
-      }
-    }
-  }
-  ```
-  */
-  attributeToStyle?: boolean | AttributeToStyleSupportedAttributes[];
-
-  /**
-  HTML elements that will receive `width` attributes based on inline CSS width.
-
-  @default []
-
-  @example
-  ```
-  module.exports = {
-    build: {
-      inlineCSS: {
-        applyWidthAttributes: ['td', 'th']
-      }
-    }
-  }
-  ```
-  */
-  applyWidthAttributes?: string[];
-
-  /**
-  HTML elements that will receive `height` attributes based on inline CSS height.
-
-  @default []
-
-  @example
-  ```
-  module.exports = {
-    build: {
-      inlineCSS: {
-        applyHeightAttributes: ['td', 'th']
-      }
-    }
-  }
-  ```
-  */
-  applyHeightAttributes?: string[];
-
-  /**
-  List of elements that should only use `width` and `height`. Their inline CSS `width` and `height` will be removed.
-
-  @example
-  ```
-  module.exports = {
-    inlineCSS: {
-      keepOnlyAttributeSizes: {
-        width: ['img', 'video'],
-        height: ['img', 'video']
-      }
-    }
-  }
-  ```
-  */
-  keepOnlyAttributeSizes?: {
-    /**
-    List of elements that should only use the `width` HTML attribute (inline CSS width will be removed).
-
-    @default []
-
-    @example
-    ```
-    module.exports = {
-      inlineCSS: {
-        keepOnlyAttributeSizes: {
-          width: ['img', 'video'],
-        }
-      }
-    }
-    ```
-    */
-    width?: string[];
-    /**
-    List of elements that should only use the `height` HTML attribute (inline CSS height will be removed).
-
-    @default []
-
-    @example
-    ```
-    module.exports = {
-      inlineCSS: {
-        keepOnlyAttributeSizes: {
-          height: ['img', 'video']
-        }
-      }
-    }
-    ```
-    */
-    height?: string[];
-  };
-
-  /**
-  Remove inlined `background-color` CSS on elements containing a `bgcolor` HTML attribute.
-
-  @default false
-
-  @example
-  ```
-  module.exports = {
-    inlineCSS: {
-      preferBgColorAttribute: ['td'] // default: ['body', 'marquee', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr']
-    }
-  }
-  ```
-  */
-  preferBgColorAttribute?: boolean | string[];
-
-  /**
-  Array of CSS property names that should be excluded from the CSS inlining process. `--tw-shadow` is excluded by default.
-
-  @default []
-
-  @example
-  ```
-  module.exports = {
-    inlineCSS: {
-      excludedProperties: ['padding', 'padding-left']
-    }
-  }
-  ```
-  */
-  excludedProperties?: string[];
-
-  /**
-  An object where each value has a `start` and `end` to specify fenced code blocks that should be ignored during CSS inlining.
-
-  @default {EJS: {}, HBS: {}}
-
-  @example
-  ```
-  module.exports = {
-    EJS: { start: '<%', end: '%>' },
-    HBS: { start: '{{', end: '}}' },
-  }
-  ```
-  */
-  codeBlocks?: {
-    EJS?: Record<string, string>;
-    HBS?: Record<string, string>;
-  };
-
-  /**
-  Provide your own CSS to be inlined. Must be vanilla or pre-compiled CSS.
-
-  Existing `<style>` in your HTML tags will be ignored and their contents won't be inlined.
-
-  @default undefined
-
-  @example
-  ```
-  module.exports = {
-    inlineCSS: {
-      customCSS: `
-        .custom-class {
-          color: red;
-        }
-      `
-    }
-  }
-  ```
-   */
-  customCSS?: string;
-}

package/types/layouts.d.ts

@@ -1,39 +0,0 @@
-export default interface LayoutsConfig {
-  /**
-  Encoding to be used when reading a layout file from disk.
-
-  @default 'utf8'
-  */
-  encoding?: string;
-
-  /**
-  Name of the slot tag, where the content will be injected.
-  This is typically used in a Layout file, to define the place where to inject a Template.
-
-  @default 'block'
-  */
-  slotTagName?: string;
-
-  /**
-  Name of the fill tag, inside of which content that will be injected is defined.
-  This is typically used in a Template file, to extend a Layout.
-
-  @default 'block'
-  */
-  fillTagName?: string;
-
-  /**
-  Path to the layouts folder, relative to the project root.
-
-  @default 'src/layouts'
-  */
-  root?: string;
-
-  /**
-  Tag name to be used in HTML when extending a layout.
-
-  @default 'extends'
-  */
-  tagName?: string;
-
-}

package/types/removeUnusedCss.d.ts

@@ -1,115 +0,0 @@
-export default interface RemoveUnusedCSSConfig {
-  /**
-  Classes or IDs that you don't want removed.
-
-  @default []
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      whitelist: ['.some-class', '.Mso*', '#*'],
-    }
-  }
-  ```
-  */
-  whitelist?: string[];
-
-  /**
-  Start and end delimiters for computed classes that you don't want removed.
-
-  @default [{heads: '{{', tails: '}}'}, {heads: '{%', tails: '%}'}]
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      backend: [
-        { heads: '[[', tails: ']]' },
-      ]
-    }
-  }
-  ```
-  */
-  backend?: Array<Record<string, string>>;
-
-  /**
-  Whether to remove `<!-- HTML comments -->`.
-
-  @default true
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      removeHTMLComments: false
-    }
-  }
-  ```
-  */
-  removeHTMLComments?: boolean;
-
-  /**
-  Whether to remove `/* CSS comments *\/`.
-
-  @default true
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      removeCSSComments: false
-    }
-  }
-  ```
-  */
-  removeCSSComments?: boolean;
-
-  /**
-  Whether to remove classes that have been inlined.
-
-  @default undefined
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      removeInlinedSelectors: false,
-    }
-  }
-  ```
-  */
-  removeInlinedSelectors?: boolean;
-
-  /**
-  List of strings representing start of a conditional comment that should not be removed.
-
-  @default ['[if', '[endif']
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      doNotRemoveHTMLCommentsWhoseOpeningTagContains: ['[if', '[endif']
-    }
-  }
-  ```
-  */
-  doNotRemoveHTMLCommentsWhoseOpeningTagContains: string[];
-
-  /**
-  Rename all classes and IDs in both your `<style>` tags and your body HTML elements, to be as few characters as possible.
-
-  @default false
-
-  @example
-  ```
-  module.exports = {
-    removeUnusedCSS: {
-      uglify: true
-    }
-  }
-  ```
-  */
-  uglify?: boolean;
-}

package/types/tailwind.d.ts

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

@@ -1,181 +0,0 @@
-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;
-  } | {
-    /**
-     * An array of objects specifying source and destination directories for asset files.
-     */
-    assets: Array<{
-      /**
-       * Directory where Maizzle should look for asset files.
-       */
-      source: string;
-      /**
-       * Directory where asset files should be copied to.
-       */
-      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[];
-}