handoff-app 1.0.4 → 1.0.5

package/templates/default/handoff.config.with-examples.js.tpl

@@ -0,0 +1,182 @@
+
+
+
+/** @type {import('handoff-app').Config} */
+module.exports = {
+  app: {
+    theme: "default",
+    title: "{{projectName}} Design System",
+    client: "{{projectName}}",
+    google_tag_manager: null,
+    attribution: true,
+    type_copy: "Almost before we knew it, we had left the ground.",
+    type_sort: [
+      "Heading 1",
+      "Heading 2",
+      "Heading 3",
+      "Heading 4",
+      "Heading 5",
+      "Heading 6",
+      "Paragraph",
+      "Subheading",
+      "Blockquote",
+      "Input Labels",
+      "Link"
+    ],
+    color_sort: [
+      "primary",
+      "secondary",
+      "extra",
+      "system"
+    ],
+    component_sort: [
+      "primary",
+      "secondary",
+      "transparent"
+    ],
+    base_path: "",
+    breakpoints: {
+      sm: { size: 576, name: "Small" },
+      md: { size: 768, name: "Medium" },
+      lg: { size: 992, name: "Large" },
+      xl: { size: 1200, name: "Extra Large" }
+    }
+  },
+
+  entries: {
+    /**
+     * Array of component paths to be included in the build
+     * Add your component directories here
+     */
+    components: ["components/button"]
+  },
+
+  hooks: {
+    /**
+     * Optional validation callback for components
+     * @param component - The component instance to validate
+     * @returns A record of validation results where keys are validation types and values are detailed validation results
+     *
+     * @example
+     * validateComponent: async (component) => ({
+     *   a11y: {
+     *     description: 'Accessibility validation check',
+     *     passed: true,
+     *     messages: ['No accessibility issues found']
+     *   },
+     *   responsive: {
+     *     description: 'Responsive design validation',
+     *     passed: false,
+     *     messages: ['Component breaks at mobile breakpoint']
+     *   }
+     * })
+     */
+    // validateComponent: async (component) => {
+    //   // Add your custom validation logic here
+    //   return {};
+    // },
+
+    /**
+     * Optional hook to override the SSR build configuration used in the ssrRenderPlugin
+     * @param config - The default esbuild configuration
+     * @returns Modified esbuild configuration
+     *
+     * @example
+     * ssrBuildConfig: (config) => {
+     *   // Modify the esbuild config as needed
+     *   return config;
+     * }
+     */
+    // ssrBuildConfig: (config) => {
+    //   // Add your custom SSR build configuration here
+    //   return config;
+    // },
+
+    /**
+     * Optional hook to override the client-side build configuration used in the ssrRenderPlugin
+     * @param config - The default esbuild configuration
+     * @returns Modified esbuild configuration
+     *
+     * @example
+     * clientBuildConfig: (config) => {
+     *   // Modify the esbuild config as needed
+     *   return config;
+     * }
+     */
+    // clientBuildConfig: (config) => {
+    //   // Add your custom client build configuration here
+    //   return config;
+    // },
+
+    /**
+     * Optional hook to specify which export property contains the schema
+     * @param exports - The module exports object containing the schema
+     * @returns The schema object from the exports
+     *
+     * @example
+     * getSchemaFromExports: (exports) => exports.customSchema || exports.default
+     */
+    // getSchemaFromExports: (exports) => {
+    //   // Add your custom schema extraction logic here
+    //   return exports.default;
+    // },
+
+    /**
+     * Optional hook to transform the schema into properties
+     * @param schema - The schema object to transform
+     * @returns The transformed properties object
+     */
+    // schemaToProperties: (schema) => {
+    //   // Add your custom schema to properties transformation here
+    //   return {};
+    // },
+
+    /**
+     * Optional hook to override the JavaScript Vite configuration
+     * @param config - The default Vite configuration
+     * @returns Modified Vite configuration
+     *
+     * @example
+     * jsBuildConfig: (config) => {
+     *   // Modify the Vite config as needed
+     *   return config;
+     * }
+     */
+    // jsBuildConfig: (config) => {
+    //   // Add your custom JavaScript build configuration here
+    //   return config;
+    // },
+
+    /**
+     * Optional hook to override the CSS Vite configuration
+     * @param config - The default Vite configuration
+     * @returns Modified Vite configuration
+     *
+     * @example
+     * cssBuildConfig: (config) => {
+     *   // Modify the Vite config as needed
+     *   return config;
+     * }
+     */
+    // cssBuildConfig: (config) => {
+    //   // Add your custom CSS build configuration here
+    //   return config;
+    // },
+
+    /**
+     * Optional hook to override the HTML Vite configuration
+     * @param config - The default Vite configuration
+     * @returns Modified Vite configuration
+     *
+     * @example
+     * htmlBuildConfig: (config) => {
+     *   // Modify the Vite config as needed
+     *   return config;
+     * }
+     */
+    // htmlBuildConfig: (config) => {
+    //   // Add your custom HTML build configuration here
+    //   return config;
+    // },
+  },
+};

package/templates/default/package.json.tpl

@@ -0,0 +1,20 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.1.0",
+  "description": "A handoff app project",
+  "private": true,
+  "scripts": {
+    "start": "handoff-app start",
+    "dev": "handoff-app dev",
+    "build": "handoff-app build:app",
+    "fetch": "handoff-app fetch"
+  },
+  "dependencies": {
+    "handoff-app": "^1.0.1"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=8.0.0"
+  }
+}

package/templates/default/tsconfig.json.tpl

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowSyntheticDefaultImports": true,
+    "isolatedModules": true,
+    "noEmit": true
+  },
+  "include": [
+    "components/**/*"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}