refactor: wip

Author: BioPhoton

.env.example

@@ -1,2 +1,8 @@
-# for uploading to portal
+# Example environment variables
+# These are for reference only - use .env.local for local development
+
+# For uploading to Code PushUp portal
 CP_API_KEY=
+
+# Note: For local development with tsx/TypeScript execution,
+# copy .env.local.example to .env.local and configure NODE_OPTIONS there

.env.local

@@ -0,0 +1,9 @@
+# Local development environment variables
+# Copy this to .env.local (gitignored) and customize for your setup
+
+# Enable tsx for TypeScript execution in Nx
+# This allows running local generator/executor directly as .ts files without pre-compilation
+# This allowes the local plugins to import files with .js extensions (same as the packages in the repository)
+NODE_OPTIONS=--import tsx
+# This is used to resolve the paths in the local generator/executor so local packages can be imported as path aliases
+TSX_TSCONFIG_PATH=tsconfig.base.json

.env.local.example

@@ -0,0 +1,12 @@
+# Local development environment variables
+# Copy this to .env.local (gitignored) and customize for your setup
+
+# Enable tsx for TypeScript execution in Nx
+# This allows running local generator/executor directly as .ts files without pre-compilation
+# This allowes the local plugins to import files with .js extensions (same as the packages in the repository)
+NODE_OPTIONS=--import tsx
+# This is used to resolve the paths in the local generator/executor so local packages can be imported as path aliases
+TSX_TSCONFIG_PATH=tsconfig.base.json
+
+# Local API keys (optional - only if testing upload features)
+# CP_API_KEY=your_api_key_here

tools/zod2md-jsdocs/eslint.config.js

@@ -44,13 +44,6 @@ module.exports = tseslint.config(
       '@nx/dependency-checks': 'error',
     },
   },
-  // Nx compiles the sync generators on the fly with SWC and there the .js ending is not working
-  {
-    files: ['**/sync-*.ts'],
-    rules: {
-      'n/file-extension-in-import': 'off',
-    },
-  },
   {
     files: ['**/package.json', '**/generators.json'],
     rules: {

tools/zod2md-jsdocs/src/lib/generators/sync-zod2md-setup/sync-zod2md-setup.ts

@@ -11,13 +11,13 @@ import * as path from 'node:path';
 import {
   GENERATE_DOCS_TARGET_NAME,
   PATCH_TS_TARGET_NAME,
-} from '../../plugin/constants';
-import { DEFAULT_ZOD2MD_CONFIG_FILE_NAME } from '../configuration/constants';
+} from '../../plugin/constants.js';
+import { DEFAULT_ZOD2MD_CONFIG_FILE_NAME } from '../configuration/constants.js';
 import {
   type PluginDefinition,
   addZod2MdTransformToTsConfig,
   getFirstExistingTsConfig,
-} from '../configuration/tsconfig';
+} from '../configuration/tsconfig.js';
 
 const missingTsconfig = 'missing-tsconfig' as const;
 const missingTarget = 'missing-target' as const;