Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions .env.local
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .env.local.example
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ vitest.config.*.timestamp*
.cursor/rules/nx-rules.mdc
.github/instructions/nx.instructions.md

code-pushup.config.bundled_*.mjs
code-pushup.config.bundled_*.mjs
2 changes: 2 additions & 0 deletions tools/zod2md-jsdocs/src/lib/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const ZOD2MD_CONFIG_FILE = 'zod2md.config.ts';
export const GENERATE_DOCS_TARGET_NAME = 'generate-docs';
7 changes: 4 additions & 3 deletions tools/zod2md-jsdocs/src/nx-plugin.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import type { CreateNodesV2, NxPlugin, TargetConfiguration } from '@nx/devkit';
import * as path from 'node:path';

const ZOD2MD_CONFIG_FILE = 'zod2md.config.ts';
const GENERATE_DOCS_TARGET_NAME = 'generate-docs';
import {
GENERATE_DOCS_TARGET_NAME,
ZOD2MD_CONFIG_FILE,
} from './lib/constants.js';

type DocsTargetConfigParams = {
config: string;
Expand Down