@posthog/wizard 0.4.1 → 0.6.0

package/dist/src/utils/rules/universal.md

@@ -0,0 +1,20 @@
+Never hallucinate an API key. Instead, always use the API key populated in the .env file.
+
+# Feature flags
+
+A given feature flag should be used in as few places as possible. Do not increase the risk of undefined behavior by scattering the same feature flag across multiple areas of code. If the same feature flag needs to be introduced at multiple callsites, flag this for the developer to inspect carefully.
+
+If a job requires creating new feature flag names, make them as clear and descriptive as possible.
+
+If using TypeScript, use an enum to store flag names. If using JavaScript, store flag names as strings to an object declared as a constant, to simulate an enum. Use a consistent naming convention for this storage. enum/const object members should be written UPPERCASE_WITH_UNDERSCORE.
+
+Gate flag-dependent code on a check that verifies the flag's values are valid and expected.
+
+# Custom properties
+
+If a custom property for a person or event is at any point referenced in two or more files or two or more callsites in the same file, use an enum or const object, as above in feature flags.
+
+# Naming
+
+Before creating any new event or property names, consult with the developer for any existing naming convention. Consistency in naming is essential, and additional context may exist outside this project. Similarly, be careful about any changes to existing event and property names, as this may break reporting and distort data for the project.
+

package/dist/src/utils/types.d.ts

@@ -29,6 +29,10 @@ export type WizardOptions = {
      * Whether to select the default option for all questions automatically.
      */
     default: boolean;
+    /**
+     * Whether to create a new PostHog account during setup.
+     */
+    signup: boolean;
 };
 export interface Feature {
     id: string;

package/dist/src/utils/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":"","sourcesContent":["export type PostHogProjectData = Record<string, unknown>;\n\nexport type PreselectedProject = {\n  project: PostHogProjectData;\n  authToken: string;\n};\n\nexport type WizardOptions = {\n  /**\n   * Whether to enable debug mode.\n   */\n  debug: boolean;\n\n  /**\n   * Whether to force install the SDK package to continue with the installation in case\n   * any package manager checks are failing (e.g. peer dependency versions).\n   *\n   * Use with caution and only if you know what you're doing.\n   *\n   * Does not apply to all wizard flows (currently NPM only)\n   */\n  forceInstall: boolean;\n\n  /**\n   * The directory to run the wizard in.\n   */\n  installDir: string;\n\n  /**\n   * The cloud region to use.\n   */\n  cloudRegion?: CloudRegion;\n\n  /**\n   * Whether to select the default option for all questions automatically.\n   */\n  default: boolean;\n};\n\nexport interface Feature {\n  id: string;\n  prompt: string;\n  enabledHint?: string;\n  disabledHint?: string;\n}\n\nexport type FileChange = {\n  filePath: string;\n  oldContent?: string;\n  newContent: string;\n};\n\nexport type CloudRegion = 'us' | 'eu';\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":"","sourcesContent":["export type PostHogProjectData = Record<string, unknown>;\n\nexport type PreselectedProject = {\n  project: PostHogProjectData;\n  authToken: string;\n};\n\nexport type WizardOptions = {\n  /**\n   * Whether to enable debug mode.\n   */\n  debug: boolean;\n\n  /**\n   * Whether to force install the SDK package to continue with the installation in case\n   * any package manager checks are failing (e.g. peer dependency versions).\n   *\n   * Use with caution and only if you know what you're doing.\n   *\n   * Does not apply to all wizard flows (currently NPM only)\n   */\n  forceInstall: boolean;\n\n  /**\n   * The directory to run the wizard in.\n   */\n  installDir: string;\n\n  /**\n   * The cloud region to use.\n   */\n  cloudRegion?: CloudRegion;\n\n  /**\n   * Whether to select the default option for all questions automatically.\n   */\n  default: boolean;\n\n  /**\n   * Whether to create a new PostHog account during setup.\n   */\n  signup: boolean;\n};\n\nexport interface Feature {\n  id: string;\n  prompt: string;\n  enabledHint?: string;\n  disabledHint?: string;\n}\n\nexport type FileChange = {\n  filePath: string;\n  oldContent?: string;\n  newContent: string;\n};\n\nexport type CloudRegion = 'us' | 'eu';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@posthog/wizard",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "homepage": "https://github.com/posthog/wizard",
   "repository": "https://github.com/posthog/wizard",
   "description": "The PostHog wizard helps you to configure your project",
@@ -123,7 +123,7 @@
     "prebuild": "pnpm clean",
     "build:watch": "pnpm tsc -w",
     "build": "pnpm tsc",
-    "postbuild": "chmod +x ./dist/bin.js && cp -r scripts/** dist",
+    "postbuild": "chmod +x ./dist/bin.js && cp -r scripts/** dist && cp -r src/utils/rules dist/src/utils",
     "lint": "pnpm lint:prettier && pnpm lint:eslint",
     "lint:prettier": "prettier --check \"{lib,src,test}/**/*.ts\"",
     "lint:eslint": "eslint . --cache --format stylish",