@tamagui/helpers-node 1.0.1-beta.193 → 1.0.1-beta.195

package/dist/types.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/types.ts"],
-  "sourcesContent": ["export interface TamaguiOptions {\n  // module paths you want to compile with tamagui (for example ['tamagui'])\n  components: string[]\n  // your tamagui.config.ts\n  config?: string\n  importsWhitelist?: string[]\n  disable?: boolean\n  disableExtraction?: boolean\n  disableFlattening?: boolean\n  disableDebugAttr?: boolean\n  disableExtractInlineMedia?: boolean\n  disableExtractVariables?: boolean | 'theme'\n  excludeReactNativeWebExports?: string[]\n  logTimings?: boolean\n  prefixLogs?: string\n\n  // probably non user options\n  disableExtractFoundComponents?: boolean\n  evaluateVars?: boolean\n  cssPath?: string\n  cssData?: any\n  deoptProps?: Set<string>\n  excludeProps?: Set<string>\n  inlineProps?: Set<string>\n  forceExtractStyleDefinitions?: boolean\n}\n"],
+  "sourcesContent": ["export interface TamaguiOptions {\n  /**\n   * module paths you want to compile with tamagui (for example ['tamagui'])\n   * */\n  components: string[]\n  /**\n   * your tamagui.config.ts\n   */\n  config?: string\n  /**\n   * Tamagui can follow imports and evaluate them when parsing styles, leading to\n   * higher percent of flattened / optimized views. We normalize this to be the\n   * full path of the file, always ending in \".js\".\n   *\n   * So to have Tamagui partially evaluate \"app/src/constants.tsx\" you can put\n   * [\"app/src/constants.js\"].\n   */\n  importsWhitelist?: string[]\n  /**\n   * Whitelist file extensions to evaluate\n   *\n   * @default ['.tsx', '.jsx']\n   */\n  includeExtensions?: string[]\n  /**\n   * Web-only. Allows you to trim the bundle size of react-native-web.\n   * Pass in values like ['Switch', 'Modal'].\n   */\n  excludeReactNativeWebExports?: string[]\n  /**\n   * Enable logging the time it takes to extract.\n   *\n   * @default true\n   */\n  logTimings?: boolean\n  /**\n   * Custom prefix for the timing logs\n   */\n  prefixLogs?: string\n  /**\n   * Completely disable tamagui for these files\n   */\n  disable?: boolean | string[]\n  /**\n   * Disable just optimization for these files, but enable helpful debug attributes.\n   */\n  disableExtraction?: boolean | string[]\n  /**\n   * Disable just the addition of data- attributes that are added in dev mode to help\n   * tie DOM to your filename/component-name.\n   */\n  disableDebugAttr?: boolean\n  /**\n   * (Advanced) Disable evaluation of useMedia() hook\n   */\n  disableExtractInlineMedia?: boolean\n  /**\n   * (Advanced) Disable just view flattening.\n   */\n  disableFlattening?: boolean\n  /**\n   * (Advanced) Disable extracting to theme variables.\n   */\n  disableExtractVariables?: boolean | 'theme'\n\n  // probably non user options\n  disableExtractFoundComponents?: boolean | string[]\n  evaluateVars?: boolean\n  cssPath?: string\n  cssData?: any\n  deoptProps?: Set<string>\n  excludeProps?: Set<string>\n  inlineProps?: Set<string>\n  forceExtractStyleDefinitions?: boolean\n}\n"],
   "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamagui/helpers-node",
-  "version": "1.0.1-beta.193",
+  "version": "1.0.1-beta.195",
   "source": "src/index.ts",
   "types": "./types/index.d.ts",
   "main": "./dist",
@@ -16,7 +16,7 @@
     "clean:build": "tamagui-build clean:build"
   },
   "devDependencies": {
-    "@tamagui/build": "^1.0.1-beta.193",
+    "@tamagui/build": "^1.0.1-beta.195",
     "fs-extra": "^10.1.0"
   },
   "publishConfig": {

package/src/types.ts

@@ -1,21 +1,70 @@
 export interface TamaguiOptions {
-  // module paths you want to compile with tamagui (for example ['tamagui'])
+  /**
+   * module paths you want to compile with tamagui (for example ['tamagui'])
+   * */
   components: string[]
-  // your tamagui.config.ts
+  /**
+   * your tamagui.config.ts
+   */
   config?: string
+  /**
+   * Tamagui can follow imports and evaluate them when parsing styles, leading to
+   * higher percent of flattened / optimized views. We normalize this to be the
+   * full path of the file, always ending in ".js".
+   *
+   * So to have Tamagui partially evaluate "app/src/constants.tsx" you can put
+   * ["app/src/constants.js"].
+   */
   importsWhitelist?: string[]
-  disable?: boolean
-  disableExtraction?: boolean
-  disableFlattening?: boolean
-  disableDebugAttr?: boolean
-  disableExtractInlineMedia?: boolean
-  disableExtractVariables?: boolean | 'theme'
+  /**
+   * Whitelist file extensions to evaluate
+   *
+   * @default ['.tsx', '.jsx']
+   */
+  includeExtensions?: string[]
+  /**
+   * Web-only. Allows you to trim the bundle size of react-native-web.
+   * Pass in values like ['Switch', 'Modal'].
+   */
   excludeReactNativeWebExports?: string[]
+  /**
+   * Enable logging the time it takes to extract.
+   *
+   * @default true
+   */
   logTimings?: boolean
+  /**
+   * Custom prefix for the timing logs
+   */
   prefixLogs?: string
+  /**
+   * Completely disable tamagui for these files
+   */
+  disable?: boolean | string[]
+  /**
+   * Disable just optimization for these files, but enable helpful debug attributes.
+   */
+  disableExtraction?: boolean | string[]
+  /**
+   * Disable just the addition of data- attributes that are added in dev mode to help
+   * tie DOM to your filename/component-name.
+   */
+  disableDebugAttr?: boolean
+  /**
+   * (Advanced) Disable evaluation of useMedia() hook
+   */
+  disableExtractInlineMedia?: boolean
+  /**
+   * (Advanced) Disable just view flattening.
+   */
+  disableFlattening?: boolean
+  /**
+   * (Advanced) Disable extracting to theme variables.
+   */
+  disableExtractVariables?: boolean | 'theme'
 
   // probably non user options
-  disableExtractFoundComponents?: boolean
+  disableExtractFoundComponents?: boolean | string[]
   evaluateVars?: boolean
   cssPath?: string
   cssData?: any

package/types/types.d.ts

@@ -1,17 +1,68 @@
 export interface TamaguiOptions {
+    /**
+     * module paths you want to compile with tamagui (for example ['tamagui'])
+     * */
     components: string[];
+    /**
+     * your tamagui.config.ts
+     */
     config?: string;
+    /**
+     * Tamagui can follow imports and evaluate them when parsing styles, leading to
+     * higher percent of flattened / optimized views. We normalize this to be the
+     * full path of the file, always ending in ".js".
+     *
+     * So to have Tamagui partially evaluate "app/src/constants.tsx" you can put
+     * ["app/src/constants.js"].
+     */
     importsWhitelist?: string[];
-    disable?: boolean;
-    disableExtraction?: boolean;
-    disableFlattening?: boolean;
-    disableDebugAttr?: boolean;
-    disableExtractInlineMedia?: boolean;
-    disableExtractVariables?: boolean | 'theme';
+    /**
+     * Whitelist file extensions to evaluate
+     *
+     * @default ['.tsx', '.jsx']
+     */
+    includeExtensions?: string[];
+    /**
+     * Web-only. Allows you to trim the bundle size of react-native-web.
+     * Pass in values like ['Switch', 'Modal'].
+     */
     excludeReactNativeWebExports?: string[];
+    /**
+     * Enable logging the time it takes to extract.
+     *
+     * @default true
+     */
     logTimings?: boolean;
+    /**
+     * Custom prefix for the timing logs
+     */
     prefixLogs?: string;
-    disableExtractFoundComponents?: boolean;
+    /**
+     * Completely disable tamagui for these files
+     */
+    disable?: boolean | string[];
+    /**
+     * Disable just optimization for these files, but enable helpful debug attributes.
+     */
+    disableExtraction?: boolean | string[];
+    /**
+     * Disable just the addition of data- attributes that are added in dev mode to help
+     * tie DOM to your filename/component-name.
+     */
+    disableDebugAttr?: boolean;
+    /**
+     * (Advanced) Disable evaluation of useMedia() hook
+     */
+    disableExtractInlineMedia?: boolean;
+    /**
+     * (Advanced) Disable just view flattening.
+     */
+    disableFlattening?: boolean;
+    /**
+     * (Advanced) Disable extracting to theme variables.
+     */
+    disableExtractVariables?: boolean | 'theme';
+    disableExtractFoundComponents?: boolean | string[];
     evaluateVars?: boolean;
     cssPath?: string;
     cssData?: any;